spinnman.messages.eieio.command_messages package

Module contents

class spinnman.messages.eieio.command_messages.DatabaseConfirmation(database_path=None)

Bases: spinnman.messages.eieio.command_messages.eieio_command_message.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.

bytestring

database_path

static from_bytestring(command_header, data, offset)

class spinnman.messages.eieio.command_messages.EIEIOCommandHeader(command)

Bases: object

EIEIO header for command packets

bytestring

Get a bytestring of the header

Return type:bytes

command

static from_bytestring(data, offset)

Read an EIEIO command header from a bytestring

Parameters:

• data (bytes or bytearray) – The bytestring to read the data from
• offset (int) – The offset where the valid data starts

Returns:

an EIEIO command header

Return type:

EIEIOCommandHeader

Raises:

• SpinnmanIOException – If there is an error reading from the reader
• SpinnmanInvalidParameterException – If there is an error setting any of the values

class spinnman.messages.eieio.command_messages.EIEIOCommandMessage(eieio_command_header, data=None, offset=0)

Bases: spinnman.messages.eieio.eieio_message.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

bytestring

data

eieio_header

static from_bytestring(command_header, data, offset)

static get_min_packet_length()

offset

class spinnman.messages.eieio.command_messages.EventStopRequest

Bases: spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage

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

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

Bases: spinnman.messages.eieio.command_messages.eieio_command_message.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

bytestring

channel(ack_id)

static from_bytestring(command_header, data, offset)

static get_min_packet_length()

n_requests

region_id(ack_id)

sequence_no

space_read(ack_id)

class spinnman.messages.eieio.command_messages.HostSendSequencedData(region_id, sequence_no, eieio_data_message)

Bases: spinnman.messages.eieio.command_messages.eieio_command_message.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

bytestring

eieio_data_message

static from_bytestring(command_header, data, offset)

static get_min_packet_length()

region_id

sequence_no

class spinnman.messages.eieio.command_messages.NotificationProtocolPauseStop

Bases: spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage

Packet which indicates that the toolchain has paused or stopped

static from_bytestring(command_header, data, offset)

class spinnman.messages.eieio.command_messages.NotificationProtocolStartResume

Bases: spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage

Packet which indicates that the toolchain has started or resumed

static from_bytestring(command_header, data, offset)

class spinnman.messages.eieio.command_messages.PaddingRequest

Bases: spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage

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

static get_min_packet_length()

class spinnman.messages.eieio.command_messages.SpinnakerRequestBuffers(x, y, p, region_id, sequence_no, space_available)

Bases: spinnman.messages.eieio.command_messages.eieio_command_message.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

bytestring

static from_bytestring(command_header, data, offset)

static get_min_packet_length()

p

region_id

sequence_no

space_available

x

y

class spinnman.messages.eieio.command_messages.HostDataReadAck(sequence_no)

Bases: spinnman.messages.eieio.command_messages.eieio_command_message.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

bytestring

static from_bytestring(command_header, data, offset)

sequence_no

class spinnman.messages.eieio.command_messages.SpinnakerRequestReadData(x, y, p, region_id, sequence_no, n_requests, channel, start_address, space_to_be_read)

Bases: spinnman.messages.eieio.command_messages.eieio_command_message.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

bytestring

channel(request_id)

static from_bytestring(command_header, data, offset)

static get_min_packet_length()

n_requests

p

region_id(request_id)

sequence_no

space_to_be_read(request_id)

start_address(request_id)

x

y

class spinnman.messages.eieio.command_messages.StartRequests

Bases: spinnman.messages.eieio.command_messages.eieio_command_message.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

class spinnman.messages.eieio.command_messages.StopRequests

Bases: spinnman.messages.eieio.command_messages.eieio_command_message.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