spinnman.messages.eieio package¶
Subpackages¶
- spinnman.messages.eieio.command_messages package
- Submodules
- spinnman.messages.eieio.command_messages.database_confirmation module
- spinnman.messages.eieio.command_messages.eieio_command_header module
- spinnman.messages.eieio.command_messages.eieio_command_message module
- spinnman.messages.eieio.command_messages.event_stop_request module
- spinnman.messages.eieio.command_messages.host_data_read module
- spinnman.messages.eieio.command_messages.host_data_read_ack module
- spinnman.messages.eieio.command_messages.host_send_sequenced_data module
- spinnman.messages.eieio.command_messages.notification_protocol_pause_stop module
- spinnman.messages.eieio.command_messages.notification_protocol_start_resume module
- spinnman.messages.eieio.command_messages.padding_request module
- spinnman.messages.eieio.command_messages.spinnaker_request_buffers module
- spinnman.messages.eieio.command_messages.spinnaker_request_read_data module
- spinnman.messages.eieio.command_messages.start_requests module
- spinnman.messages.eieio.command_messages.stop_requests module
- Module contents
- spinnman.messages.eieio.data_messages package
- Submodules
- spinnman.messages.eieio.data_messages.abstract_data_element module
- spinnman.messages.eieio.data_messages.eieio_data_header module
- spinnman.messages.eieio.data_messages.eieio_data_message module
- spinnman.messages.eieio.data_messages.key_data_element module
- spinnman.messages.eieio.data_messages.key_payload_data_element module
- Module contents
Submodules¶
spinnman.messages.eieio.create_eieio_command module¶
-
spinnman.messages.eieio.create_eieio_command.
read_eieio_command_message
(data, offset)[source]¶ Reads the content of an EIEIO command message and returns an object identifying the command which was contained in the packet, including any parameter, if required by the command
Parameters: - data (str) – data received from the network as a bytestring
- offset (int) – offset at which the parsing operation should start
Returns: an object which inherits from EIEIOCommandMessage which contains parsed data received from the network
Return type: spinnman.messages.eieio.command_messages.EIEIOCommandMessage
spinnman.messages.eieio.create_eieio_data module¶
-
spinnman.messages.eieio.create_eieio_data.
read_eieio_data_message
(data, offset)[source]¶ Reads the content of an EIEIO data message and returns an object identifying the data which was contained in the packet
Parameters: - data (str) – data received from the network as a bytestring
- offset (int) – offset at which the parsing operation should start
Returns: an object which inherits from EIEIODataMessage which contains parsed data received from the network
Return type:
spinnman.messages.eieio.eieio_message module¶
spinnman.messages.eieio.eieio_prefix module¶
spinnman.messages.eieio.eieio_type module¶
-
class
spinnman.messages.eieio.eieio_type.
EIEIOType
(value, key_bytes, payload_bytes, doc='')[source]¶ Bases:
enum.Enum
Possible types of EIEIO packets
-
KEY_16_BIT
= 0¶
-
KEY_32_BIT
= 2¶
-
KEY_PAYLOAD_16_BIT
= 1¶
-
KEY_PAYLOAD_32_BIT
= 3¶
-
key_bytes
¶ The number of bytes used by each key element
Return type: int
-
max_value
¶ The maximum value of the key or payload (if there is a payload)
Return type: int
-
payload_bytes
¶ The number of bytes used by each payload element
Return type: int
-
Module contents¶
-
class
spinnman.messages.eieio.
EIEIOPrefix
(value, doc='')[source]¶ Bases:
enum.Enum
Possible prefixing of keys in EIEIO packets
-
LOWER_HALF_WORD
= 0¶
-
UPPER_HALF_WORD
= 1¶
-
-
class
spinnman.messages.eieio.
EIEIOType
(value, key_bytes, payload_bytes, doc='')[source]¶ Bases:
enum.Enum
Possible types of EIEIO packets
-
KEY_16_BIT
= 0¶
-
KEY_32_BIT
= 2¶
-
KEY_PAYLOAD_16_BIT
= 1¶
-
KEY_PAYLOAD_32_BIT
= 3¶
-
key_bytes
¶ The number of bytes used by each key element
Return type: int
-
max_value
¶ The maximum value of the key or payload (if there is a payload)
Return type: int
-
payload_bytes
¶ The number of bytes used by each payload element
Return type: int
-
-
spinnman.messages.eieio.
read_eieio_command_message
(data, offset)[source]¶ Reads the content of an EIEIO command message and returns an object identifying the command which was contained in the packet, including any parameter, if required by the command
Parameters: - data (str) – data received from the network as a bytestring
- offset (int) – offset at which the parsing operation should start
Returns: an object which inherits from EIEIOCommandMessage which contains parsed data received from the network
Return type: spinnman.messages.eieio.command_messages.EIEIOCommandMessage
-
spinnman.messages.eieio.
read_eieio_data_message
(data, offset)[source]¶ Reads the content of an EIEIO data message and returns an object identifying the data which was contained in the packet
Parameters: - data (str) – data received from the network as a bytestring
- offset (int) – offset at which the parsing operation should start
Returns: an object which inherits from EIEIODataMessage which contains parsed data received from the network
Return type: