spinnman.messages.eieio package

Subpackages

• spinnman.messages.eieio.command_messages package
  • Module contents
    • EIEIOCommandHeader
      • EIEIOCommandHeader.bytestring
      • EIEIOCommandHeader.command
      • EIEIOCommandHeader.from_bytestring()
    • EIEIOCommandMessage
      • EIEIOCommandMessage.bytestring
      • EIEIOCommandMessage.data
      • EIEIOCommandMessage.eieio_header
      • EIEIOCommandMessage.from_bytestring()
      • EIEIOCommandMessage.get_min_packet_length()
      • EIEIOCommandMessage.offset
    • EventStopRequest
    • HostDataRead
      • HostDataRead.bytestring
      • HostDataRead.channel()
      • HostDataRead.from_bytestring()
      • HostDataRead.get_min_packet_length()
      • HostDataRead.n_requests
      • HostDataRead.region_id()
      • HostDataRead.sequence_no
      • HostDataRead.space_read()
    • HostDataReadAck
      • HostDataReadAck.bytestring
      • HostDataReadAck.from_bytestring()
      • HostDataReadAck.sequence_no
    • HostSendSequencedData
      • HostSendSequencedData.bytestring
      • HostSendSequencedData.eieio_data_message
      • HostSendSequencedData.from_bytestring()
      • HostSendSequencedData.get_min_packet_length()
      • HostSendSequencedData.region_id
      • HostSendSequencedData.sequence_no
    • NotificationProtocolDatabaseLocation
      • NotificationProtocolDatabaseLocation.bytestring
      • NotificationProtocolDatabaseLocation.database_path
      • NotificationProtocolDatabaseLocation.from_bytestring()
    • NotificationProtocolPauseStop
      • NotificationProtocolPauseStop.from_bytestring()
    • NotificationProtocolStartResume
      • NotificationProtocolStartResume.from_bytestring()
    • PaddingRequest
      • PaddingRequest.get_min_packet_length()
    • SpinnakerRequestBuffers
      • SpinnakerRequestBuffers.bytestring
      • SpinnakerRequestBuffers.from_bytestring()
      • SpinnakerRequestBuffers.get_min_packet_length()
      • SpinnakerRequestBuffers.p
      • SpinnakerRequestBuffers.region_id
      • SpinnakerRequestBuffers.sequence_no
      • SpinnakerRequestBuffers.space_available
      • SpinnakerRequestBuffers.x
      • SpinnakerRequestBuffers.y
    • SpinnakerRequestReadData
      • SpinnakerRequestReadData.bytestring
      • SpinnakerRequestReadData.channel()
      • SpinnakerRequestReadData.from_bytestring()
      • SpinnakerRequestReadData.get_min_packet_length()
      • SpinnakerRequestReadData.n_requests
      • SpinnakerRequestReadData.p
      • SpinnakerRequestReadData.region_id()
      • SpinnakerRequestReadData.sequence_no
      • SpinnakerRequestReadData.space_to_be_read()
      • SpinnakerRequestReadData.start_address()
      • SpinnakerRequestReadData.x
      • SpinnakerRequestReadData.y
    • StartRequests
    • StopRequests
• spinnman.messages.eieio.data_messages package
  • Module contents
    • AbstractDataElement
      • AbstractDataElement.get_bytestring()
    • EIEIODataHeader
      • EIEIODataHeader.bytestring
      • EIEIODataHeader.count
      • EIEIODataHeader.eieio_type
      • EIEIODataHeader.from_bytestring()
      • EIEIODataHeader.get_header_size()
      • EIEIODataHeader.increment_count()
      • EIEIODataHeader.is_time
      • EIEIODataHeader.payload_base
      • EIEIODataHeader.prefix
      • EIEIODataHeader.prefix_type
      • EIEIODataHeader.reset_count()
      • EIEIODataHeader.size
      • EIEIODataHeader.tag
    • EIEIODataMessage
      • EIEIODataMessage.add_element()
      • EIEIODataMessage.add_key()
      • EIEIODataMessage.add_key_and_payload()
      • EIEIODataMessage.bytestring
      • EIEIODataMessage.create()
      • EIEIODataMessage.eieio_header
      • EIEIODataMessage.get_min_packet_length()
      • EIEIODataMessage.is_next_element
      • EIEIODataMessage.max_n_elements
      • EIEIODataMessage.min_packet_length()
      • EIEIODataMessage.n_elements
      • EIEIODataMessage.next_element
      • EIEIODataMessage.size
    • KeyDataElement
      • KeyDataElement.get_bytestring()
      • KeyDataElement.key
    • KeyPayloadDataElement
      • KeyPayloadDataElement.get_bytestring()
      • KeyPayloadDataElement.key
      • KeyPayloadDataElement.payload
      • KeyPayloadDataElement.payload_is_timestamp

Module contents

class spinnman.messages.eieio.AbstractEIEIOMessage

Bases: object

Interface for an EIEIOMessage.

abstract property bytestring

The bytes of the message.

Return type:

bytes

abstract property eieio_header

The header of the message.

class spinnman.messages.eieio.EIEIOPrefix(value)

Bases: Enum

Possible prefixing of keys in EIEIO packets.

LOWER_HALF_WORD = 0

UPPER_HALF_WORD = 1

class spinnman.messages.eieio.EIEIOType(value)

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 key_bytes

The number of bytes used by each key element.

Return type:

int

property max_value

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

Return type:

int

property payload_bytes

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