spinnman.messages.eieio package

Subpackages

Module contents

class spinnman.messages.eieio.AbstractEIEIOMessage

Bases: object

Interface for an EIEIOMessage.

abstract property bytestring: bytes

The bytes of the message.

Return type:

bytes

abstract property eieio_header: EIEIOCommandHeader | EIEIODataHeader

The header of the message.

class spinnman.messages.eieio.EIEIOPrefix(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Possible prefixing of keys in EIEIO packets.

LOWER_HALF_WORD = 0
UPPER_HALF_WORD = 1
class spinnman.messages.eieio.EIEIOType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Possible types of EIEIO packets.

KEY_16_BIT = 0
KEY_32_BIT = 2
KEY_PAYLOAD_16_BIT = 1
KEY_PAYLOAD_32_BIT = 3
property encoded_value: int

The encoded value representing the type.

property key_bytes: int

The number of bytes used by each key element.

Return type:

int

property max_value: int

The maximum value of the key or payload (if there is a payload).

Return type:

int

property payload_bytes: int

The number of bytes used by each payload element.

Return type:

int

spinnman.messages.eieio.read_eieio_command_message(data, offset)

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 byte-string

  • 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)

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 byte-string

  • 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