spinnman.messages.scp package

Subpackages

• spinnman.messages.scp.abstract_messages package
  • Module contents
    • AbstractSCPRequest
      • AbstractSCPRequest.DEFAULT_DEST_X_COORD
      • AbstractSCPRequest.DEFAULT_DEST_Y_COORD
      • AbstractSCPRequest.argument_1
      • AbstractSCPRequest.argument_2
      • AbstractSCPRequest.argument_3
      • AbstractSCPRequest.bytestring
      • AbstractSCPRequest.data
      • AbstractSCPRequest.get_scp_response()
      • AbstractSCPRequest.scp_request_header
      • AbstractSCPRequest.sdp_header
    • AbstractSCPResponse
      • AbstractSCPResponse.read_bytestring()
      • AbstractSCPResponse.read_data_bytestring()
      • AbstractSCPResponse.scp_response_header
      • AbstractSCPResponse.sdp_header
    • BMPOKResponse
    • BMPRequest
      • BMPRequest.get_board_mask()
      • BMPRequest.get_first_board()
    • BMPResponse
      • BMPResponse.read_data_bytestring()
• spinnman.messages.scp.enums package
  • Module contents
    • AllocFree
      • AllocFree.ALLOC_ROUTING
      • AllocFree.ALLOC_SDRAM
      • AllocFree.FREE_ROUTING_BY_APP_ID
      • AllocFree.FREE_ROUTING_BY_POINTER
      • AllocFree.FREE_SDRAM_BY_APP_ID
      • AllocFree.FREE_SDRAM_BY_POINTER
    • BMPInfo
      • BMPInfo.ADC
      • BMPInfo.CAN_STATUS
      • BMPInfo.IP_ADDR
      • BMPInfo.SERIAL
    • IPTagCommand
      • IPTagCommand.CLR
      • IPTagCommand.GET
      • IPTagCommand.NEW
      • IPTagCommand.SET
      • IPTagCommand.TTO
    • LEDAction
      • LEDAction.OFF
      • LEDAction.ON
      • LEDAction.TOGGLE
    • PowerCommand
      • PowerCommand.POWER_OFF
      • PowerCommand.POWER_ON
    • SCPCommand
      • SCPCommand.CMD_ALLOC
      • SCPCommand.CMD_APLX
      • SCPCommand.CMD_APP_COPY_RUN
      • SCPCommand.CMD_AR
      • SCPCommand.CMD_AS
      • SCPCommand.CMD_BMP_INFO
      • SCPCommand.CMD_BMP_POWER
      • SCPCommand.CMD_COUNT
      • SCPCommand.CMD_DPRI
      • SCPCommand.CMD_FFD
      • SCPCommand.CMD_FILL
      • SCPCommand.CMD_FLASH_COPY
      • SCPCommand.CMD_FLASH_ERASE
      • SCPCommand.CMD_FLASH_WRITE
      • SCPCommand.CMD_INFO
      • SCPCommand.CMD_IPTAG
      • SCPCommand.CMD_LED
      • SCPCommand.CMD_LINK_READ
      • SCPCommand.CMD_LINK_WRITE
      • SCPCommand.CMD_NNP
      • SCPCommand.CMD_READ
      • SCPCommand.CMD_REMAP
      • SCPCommand.CMD_RESET
      • SCPCommand.CMD_RTR
      • SCPCommand.CMD_RUN
      • SCPCommand.CMD_SIG
      • SCPCommand.CMD_SROM
      • SCPCommand.CMD_SYNC
      • SCPCommand.CMD_TUBE
      • SCPCommand.CMD_VER
      • SCPCommand.CMD_WRITE
    • SCPResult
      • SCPResult.RC_ARG
      • SCPResult.RC_BUF
      • SCPResult.RC_CMD
      • SCPResult.RC_CPU
      • SCPResult.RC_DEAD
      • SCPResult.RC_LEN
      • SCPResult.RC_OK
      • SCPResult.RC_P2P_BUSY
      • SCPResult.RC_P2P_NOREPLY
      • SCPResult.RC_P2P_REJECT
      • SCPResult.RC_P2P_TIMEOUT
      • SCPResult.RC_PKT_TX
      • SCPResult.RC_PORT
      • SCPResult.RC_ROUTE
      • SCPResult.RC_SUM
      • SCPResult.RC_TIMEOUT
    • Signal
      • Signal.CONTINUE
      • Signal.EXIT
      • Signal.INITIALISE
      • Signal.PAUSE
      • Signal.POWER_DOWN
      • Signal.START
      • Signal.STOP
      • Signal.SYNC0
      • Signal.SYNC1
      • Signal.TIMER
      • Signal.USER_0
      • Signal.USER_1
      • Signal.USER_2
      • Signal.USER_3
      • Signal.signal_type
    • SignalType
      • SignalType.MULTICAST
      • SignalType.NEAREST_NEIGHBOUR
      • SignalType.POINT_TO_POINT
• spinnman.messages.scp.impl package
  • Submodules
  • spinnman.messages.scp.impl.count_state_response module
    • CountStateResponse
      • CountStateResponse.count
      • CountStateResponse.read_data_bytestring()
  • spinnman.messages.scp.impl.get_chip_info_response module
    • GetChipInfoResponse
      • GetChipInfoResponse.chip_info
      • GetChipInfoResponse.read_data_bytestring()
  • spinnman.messages.scp.impl.get_version_response module
    • GetVersionResponse
      • GetVersionResponse.read_data_bytestring()
      • GetVersionResponse.version_info
  • spinnman.messages.scp.impl.iptag_get_info_response module
    • IPTagGetInfoResponse
      • IPTagGetInfoResponse.fixed_size
      • IPTagGetInfoResponse.pool_size
      • IPTagGetInfoResponse.read_data_bytestring()
      • IPTagGetInfoResponse.transient_timeout
  • Module contents
    • AppCopyRun
      • AppCopyRun.get_scp_response()
    • AppStop
      • AppStop.get_scp_response()
    • ApplicationRun
      • ApplicationRun.get_scp_response()
    • BMPGetVersion
      • BMPGetVersion.get_scp_response()
    • CheckOKResponse
      • CheckOKResponse.read_data_bytestring()
    • CountState
      • CountState.get_scp_response()
    • DoSync
      • DoSync.get_scp_response()
    • FillRequest
      • FillRequest.get_scp_response()
    • FixedRouteInit
      • FixedRouteInit.get_scp_response()
    • FixedRouteRead
      • FixedRouteRead.get_scp_response()
    • FloodFillData
      • FloodFillData.bytestring
      • FloodFillData.get_scp_response()
    • FloodFillEnd
      • FloodFillEnd.get_scp_response()
    • FloodFillStart
      • FloodFillStart.get_scp_response()
    • GetChipInfo
      • GetChipInfo.get_scp_response()
    • GetVersion
      • GetVersion.get_scp_response()
    • IPTagClear
      • IPTagClear.get_scp_response()
    • IPTagGet
      • IPTagGet.get_scp_response()
    • IPTagGetInfo
      • IPTagGetInfo.get_scp_response()
    • IPTagSet
      • IPTagSet.get_scp_response()
    • IPTagSetTTO
      • IPTagSetTTO.get_scp_response()
    • ReadFPGARegister
      • ReadFPGARegister.get_scp_response()
    • ReadLink
      • ReadLink.get_scp_response()
    • ReadMemory
      • ReadMemory.get_scp_response()
    • ReverseIPTagSet
      • ReverseIPTagSet.get_scp_response()
    • RouterAlloc
      • RouterAlloc.get_scp_response()
    • RouterClear
      • RouterClear.get_scp_response()
    • RouterInit
      • RouterInit.get_scp_response()
    • SDRAMAlloc
      • SDRAMAlloc.get_scp_response()
    • SDRAMDeAlloc
      • SDRAMDeAlloc.get_scp_response()
    • SendSignal
      • SendSignal.get_scp_response()
    • SetPower
      • SetPower.get_scp_response()
    • WriteFPGARegister
      • WriteFPGARegister.get_scp_response()
    • WriteLink
      • WriteLink.bytestring
      • WriteLink.get_scp_response()
    • WriteMemory
      • WriteMemory.bytestring
      • WriteMemory.get_scp_response()

Module contents

class spinnman.messages.scp.SCPRequestHeader(command: SCPCommand | Enum, sequence: int = 0)

Bases: object

Represents the header of an SCP Request.

Parameters:

• command (SCPCommand) – The SCP command

• sequence (int) – The number of the SCP packet in order of all packets sent or received, between 0 and 65535

property bytestring: bytes

The header as a byte-string.

Return type:

bytes

property command: SCPCommand | Enum

The command of the SCP packet.

Return type:

SCPCommand

property sequence: int

The sequence number of the SCP packet, between 0 and 65535.

Return type:

int

class spinnman.messages.scp.SCPResponseHeader(result, sequence)

Bases: object

Represents the header of an SCP Response.

Parameters:

• result (SCPResult)

• sequence (int)

static from_bytestring(data: bytes, offset: int) → SCPResponseHeader

Read a header from a byte-string.

Parameters:

• data (bytes) – The byte-string to read from

• offset (int)

property result: SCPResult

The result of the SCP response.

Return type:

SCPResult

property sequence: int

The sequence number of the SCP response, between 0 and 65535.

Return type:

int