spinnman.messages.scp package¶
Subpackages¶
- spinnman.messages.scp.abstract_messages package
- spinnman.messages.scp.enums package
- Submodules
- spinnman.messages.scp.enums.alloc_free module
- spinnman.messages.scp.enums.bmp_info module
- spinnman.messages.scp.enums.iptag_command module
- spinnman.messages.scp.enums.led_action module
- spinnman.messages.scp.enums.power_command module
- spinnman.messages.scp.enums.scp_command module
- spinnman.messages.scp.enums.scp_result module
- spinnman.messages.scp.enums.signal module
- Module contents
- spinnman.messages.scp.impl package
- Submodules
- spinnman.messages.scp.impl.app_stop module
- spinnman.messages.scp.impl.application_run module
- spinnman.messages.scp.impl.bmp_get_version module
- spinnman.messages.scp.impl.bmp_set_led module
- spinnman.messages.scp.impl.check_ok_response module
- spinnman.messages.scp.impl.count_state module
- spinnman.messages.scp.impl.count_state_response module
- spinnman.messages.scp.impl.fill_request module
- spinnman.messages.scp.impl.fixed_route_init module
- spinnman.messages.scp.impl.fixed_route_read module
- spinnman.messages.scp.impl.flood_fill_data module
- spinnman.messages.scp.impl.flood_fill_end module
- spinnman.messages.scp.impl.flood_fill_start module
- spinnman.messages.scp.impl.get_chip_info module
- spinnman.messages.scp.impl.get_chip_info_response module
- spinnman.messages.scp.impl.get_version module
- spinnman.messages.scp.impl.get_version_response module
- spinnman.messages.scp.impl.iptag_clear module
- spinnman.messages.scp.impl.iptag_get module
- spinnman.messages.scp.impl.iptag_get_info module
- spinnman.messages.scp.impl.iptag_get_info_response module
- spinnman.messages.scp.impl.iptag_set module
- spinnman.messages.scp.impl.iptag_set_tto module
- spinnman.messages.scp.impl.read_adc module
- spinnman.messages.scp.impl.read_fpga_register module
- spinnman.messages.scp.impl.read_link module
- spinnman.messages.scp.impl.read_memory module
- spinnman.messages.scp.impl.reverse_iptag_set module
- spinnman.messages.scp.impl.router_alloc module
- spinnman.messages.scp.impl.router_clear module
- spinnman.messages.scp.impl.router_init module
- spinnman.messages.scp.impl.sdram_alloc module
- spinnman.messages.scp.impl.sdram_de_alloc module
- spinnman.messages.scp.impl.send_signal module
- spinnman.messages.scp.impl.set_led module
- spinnman.messages.scp.impl.set_power module
- spinnman.messages.scp.impl.write_fpga_register module
- spinnman.messages.scp.impl.write_link module
- spinnman.messages.scp.impl.write_memory module
- Module contents
Submodules¶
spinnman.messages.scp.scp_request_header module¶
-
class
spinnman.messages.scp.scp_request_header.
SCPRequestHeader
(command, sequence=0)[source]¶ Bases:
object
Represents the header of an SCP Request Each optional parameter in the constructor can be set to a value other than None once, after which it is immutable. It is an error to set a parameter that is not currently None.
Parameters: - command (
spinnman.messages.scp.scp_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
Raises: spinnman.exceptions.SpinnmanInvalidParameterException – If one of the parameters is incorrect
-
bytestring
¶ The header as a bytestring
Returns: The header as a bytestring Return type: str
-
command
¶ The command of the SCP packet
Returns: The command Return type: spinnman.messages.scp.scp_command.SCPCommand
-
sequence
¶ The sequence number of the SCP packet
Returns: The sequence number of the packet, between 0 and 65535 Return type: int
- command (
spinnman.messages.scp.scp_response_header module¶
-
class
spinnman.messages.scp.scp_response_header.
SCPResponseHeader
(result=None, sequence=None)[source]¶ Bases:
object
Represents the header of an SCP Response
-
static
from_bytestring
(data, offset)[source]¶ Read a header from a bytestring
Parameters: - data (str) – The bytestring to read from
- offset –
-
result
¶ The result of the SCP response
Returns: The result Return type: spinnman.messages.scp.scp_result.SCPResult
-
sequence
¶ The sequence number of the SCP response
Returns: The sequence number of the packet, between 0 and 65535 Return type: int
-
static
Module contents¶
-
class
spinnman.messages.scp.
SCPRequestHeader
(command, sequence=0)[source]¶ Bases:
object
Represents the header of an SCP Request Each optional parameter in the constructor can be set to a value other than None once, after which it is immutable. It is an error to set a parameter that is not currently None.
Parameters: - command (
spinnman.messages.scp.scp_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
Raises: spinnman.exceptions.SpinnmanInvalidParameterException – If one of the parameters is incorrect
-
bytestring
¶ The header as a bytestring
Returns: The header as a bytestring Return type: str
-
command
¶ The command of the SCP packet
Returns: The command Return type: spinnman.messages.scp.scp_command.SCPCommand
-
sequence
¶ The sequence number of the SCP packet
Returns: The sequence number of the packet, between 0 and 65535 Return type: int
- command (
-
class
spinnman.messages.scp.
SCPResponseHeader
(result=None, sequence=None)[source]¶ Bases:
object
Represents the header of an SCP Response
-
static
from_bytestring
(data, offset)[source]¶ Read a header from a bytestring
Parameters: - data (str) – The bytestring to read from
- offset –
-
result
¶ The result of the SCP response
Returns: The result Return type: spinnman.messages.scp.scp_result.SCPResult
-
sequence
¶ The sequence number of the SCP response
Returns: The sequence number of the packet, between 0 and 65535 Return type: int
-
static