spinnman.messages.eieio.command_messages package

Module contents

class spinnman.messages.eieio.command_messages.EIEIOCommandHeader(command)[source]

Bases: object

EIEIO header for command packets.

property bytestring

The byte-string of the header.

Return type:

bytes

property command
static from_bytestring(data, offset)[source]

Read an EIEIO command header from a byte-string.

Parameters:

  • data (bytes or bytearray) – The byte-string to read the data from

  • offset (int) – The offset where the valid data starts

Returns:

an EIEIO command header

Return type:

EIEIOCommandHeader

Raises:
class spinnman.messages.eieio.command_messages.EIEIOCommandMessage(eieio_command_header, data=None, offset=0)[source]

Bases: AbstractEIEIOMessage

An EIEIO command message.

Parameters:

  • eieio_command_header (EIEIOCommandHeader) – The header of the message

  • data (bytes) – Optional incoming data

  • offset (int) – Offset into the data where valid data begins

property bytestring

The bytes of the message.

Return type:

bytes

property data
property eieio_header

The header of the message.

Return type:

EIEIOCommandHeader

static from_bytestring(command_header, data, offset)[source]
static get_min_packet_length()[source]
property offset
class spinnman.messages.eieio.command_messages.EventStopRequest[source]

Bases: EIEIOCommandMessage

Packet used for the buffering input technique which causes the parser of the input packet to terminate its execution.

Parameters:

  • eieio_command_header (EIEIOCommandHeader) – The header of the message

  • data (bytes) – Optional incoming data

  • offset (int) – Offset into the data where valid data begins

class spinnman.messages.eieio.command_messages.HostDataRead(n_requests, sequence_no, channel, region_id, space_read)[source]

Bases: EIEIOCommandMessage

Packet sent by the host computer to the SpiNNaker system in the context of the buffering output technique to signal that the host has completed reading data from the output buffer, and that such space can be considered free to use again.

Parameters:

  • eieio_command_header (EIEIOCommandHeader) – The header of the message

  • data (bytes) – Optional incoming data

  • offset (int) – Offset into the data where valid data begins

property bytestring

The bytes of the message.

Return type:

bytes

channel(ack_id)[source]
static from_bytestring(command_header, data, offset)[source]
static get_min_packet_length()[source]
property n_requests
region_id(ack_id)[source]
property sequence_no
space_read(ack_id)[source]
class spinnman.messages.eieio.command_messages.HostDataReadAck(sequence_no)[source]

Bases: EIEIOCommandMessage

Packet sent by the host computer to the SpiNNaker system in the context of the buffering output technique to signal that the host has received a request to read data.

Parameters:

  • eieio_command_header (EIEIOCommandHeader) – The header of the message

  • data (bytes) – Optional incoming data

  • offset (int) – Offset into the data where valid data begins

property bytestring

The bytes of the message.

Return type:

bytes

static from_bytestring(command_header, data, offset)[source]
property sequence_no
class spinnman.messages.eieio.command_messages.HostSendSequencedData(region_id, sequence_no, eieio_data_message)[source]

Bases: EIEIOCommandMessage

Packet sent from the host to the SpiNNaker system in the context of buffering input mechanism to identify packet which needs to be stored in memory for future use.

Parameters:

  • eieio_command_header (EIEIOCommandHeader) – The header of the message

  • data (bytes) – Optional incoming data

  • offset (int) – Offset into the data where valid data begins

property bytestring

The bytes of the message.

Return type:

bytes

property eieio_data_message
static from_bytestring(command_header, data, offset)[source]
static get_min_packet_length()[source]
property region_id
property sequence_no
class spinnman.messages.eieio.command_messages.NotificationProtocolDatabaseLocation(database_path=None)[source]

Bases: EIEIOCommandMessage

Packet which contains the path to the database created by the toolchain which is to be used by any software which interfaces with SpiNNaker. Also the acknowledgement of that message.

This message is not sent to SpiNNaker boards but rather to an auxiliary tool (e.g., data visualiser).

Parameters:

database_path (str) – The location of the database. If None, this is an acknowledgement, stating that the database has now been read.

property bytestring

The bytes of the message.

Return type:

bytes

property database_path
static from_bytestring(command_header, data, offset)[source]
class spinnman.messages.eieio.command_messages.NotificationProtocolPauseStop[source]

Bases: EIEIOCommandMessage

Packet which indicates that the toolchain has paused or stopped.

This message is not sent to SpiNNaker boards but rather to an auxiliary tool (e.g., data visualiser).

Parameters:

  • eieio_command_header (EIEIOCommandHeader) – The header of the message

  • data (bytes) – Optional incoming data

  • offset (int) – Offset into the data where valid data begins

static from_bytestring(command_header, data, offset)[source]
class spinnman.messages.eieio.command_messages.NotificationProtocolStartResume[source]

Bases: EIEIOCommandMessage

Packet which indicates that the toolchain has started or resumed.

This message is not sent to SpiNNaker boards but rather to an auxiliary tool (e.g., data visualiser).

Parameters:

  • eieio_command_header (EIEIOCommandHeader) – The header of the message

  • data (bytes) – Optional incoming data

  • offset (int) – Offset into the data where valid data begins

static from_bytestring(command_header, data, offset)[source]
class spinnman.messages.eieio.command_messages.PaddingRequest[source]

Bases: EIEIOCommandMessage

Packet used to pad space in the buffering area, if needed.

Parameters:

  • eieio_command_header (EIEIOCommandHeader) – The header of the message

  • data (bytes) – Optional incoming data

  • offset (int) – Offset into the data where valid data begins

static get_min_packet_length()[source]
class spinnman.messages.eieio.command_messages.SpinnakerRequestBuffers(x, y, p, region_id, sequence_no, space_available)[source]

Bases: EIEIOCommandMessage

Message used in the context of the buffering input mechanism which is sent by the SpiNNaker system to the host computer to ask for more data to inject during the simulation.

Parameters:

  • eieio_command_header (EIEIOCommandHeader) – The header of the message

  • data (bytes) – Optional incoming data

  • offset (int) – Offset into the data where valid data begins

property bytestring

The bytes of the message.

Return type:

bytes

static from_bytestring(command_header, data, offset)[source]
static get_min_packet_length()[source]
property p
property region_id
property sequence_no
property space_available
property x
property y
class spinnman.messages.eieio.command_messages.SpinnakerRequestReadData(x, y, p, region_id, sequence_no, n_requests, channel, start_address, space_to_be_read)[source]

Bases: EIEIOCommandMessage

Message used in the context of the buffering output mechanism which is sent from the SpiNNaker system to the host computer to signal that some data is available to be read.

Parameters:

  • eieio_command_header (EIEIOCommandHeader) – The header of the message

  • data (bytes) – Optional incoming data

  • offset (int) – Offset into the data where valid data begins

property bytestring

The bytes of the message.

Return type:

bytes

channel(request_id)[source]
static from_bytestring(command_header, data, offset)[source]
static get_min_packet_length()[source]
property n_requests
property p
region_id(request_id)[source]
property sequence_no
space_to_be_read(request_id)[source]
start_address(request_id)[source]
property x
property y
class spinnman.messages.eieio.command_messages.StartRequests[source]

Bases: EIEIOCommandMessage

Packet used in the context of buffering input for the host computer to signal to the SpiNNaker system that, if needed, it is possible to send more “SpinnakerRequestBuffers” packet.

Parameters:

  • eieio_command_header (EIEIOCommandHeader) – The header of the message

  • data (bytes) – Optional incoming data

  • offset (int) – Offset into the data where valid data begins

class spinnman.messages.eieio.command_messages.StopRequests[source]

Bases: EIEIOCommandMessage

Packet used in the context of buffering input for the host computer to signal to the SpiNNaker system that to stop sending “SpinnakerRequestBuffers” packet.

Parameters:

  • eieio_command_header (EIEIOCommandHeader) – The header of the message

  • data (bytes) – Optional incoming data

  • offset (int) – Offset into the data where valid data begins