spinnman.messages.eieio.command_messages package¶
Module contents¶
-
class
spinnman.messages.eieio.command_messages.
EIEIOCommandHeader
(command)[source]¶ Bases:
object
EIEIO header for command packets.
-
command
¶
-
static
from_bytestring
(data, offset)[source]¶ Read an EIEIO command header from a bytestring.
Parameters: Returns: an EIEIO command header
Return type: 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)[source]¶ 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
-
data
¶
-
eieio_header
¶ The header of the message.
Return type: EIEIOCommandHeader
-
offset
¶
-
class
spinnman.messages.eieio.command_messages.
EventStopRequest
[source]¶ 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)[source]¶ 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.
-
n_requests
¶
-
sequence_no
¶
-
-
class
spinnman.messages.eieio.command_messages.
HostSendSequencedData
(region_id, sequence_no, eieio_data_message)[source]¶ 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.
-
eieio_data_message
¶
-
region_id
¶
-
sequence_no
¶
-
-
class
spinnman.messages.eieio.command_messages.
NotificationProtocolDatabaseLocation
(database_path=None)[source]¶ 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. 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.-
database_path
¶
-
-
class
spinnman.messages.eieio.command_messages.
NotificationProtocolPauseStop
[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.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).
-
class
spinnman.messages.eieio.command_messages.
NotificationProtocolStartResume
[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.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).
-
class
spinnman.messages.eieio.command_messages.
PaddingRequest
[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet used to pad space in the buffering area, if needed.
-
class
spinnman.messages.eieio.command_messages.
SpinnakerRequestBuffers
(x, y, p, region_id, sequence_no, space_available)[source]¶ 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.
-
p
¶
-
region_id
¶
-
sequence_no
¶
-
space_available
¶
-
x
¶
-
y
¶
-
-
class
spinnman.messages.eieio.command_messages.
HostDataReadAck
(sequence_no)[source]¶ 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.
-
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)[source]¶ 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.
-
n_requests
¶
-
p
¶
-
sequence_no
¶
-
x
¶
-
y
¶
-
-
class
spinnman.messages.eieio.command_messages.
StartRequests
[source]¶ 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
[source]¶ 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.