spinnman.messages.eieio package

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 (bytes) – 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:

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 (bytes) – 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:

EIEIODataMessage
class spinnman.messages.eieio.AbstractEIEIOMessage[source]

Bases: object

Interface for an EIEIOMessage.

bytestring

The bytes of the message.

Return type:bytes
eieio_header

The header of the message.