spinnman.messages.eieio.command_messages package¶
Module contents¶
- class spinnman.messages.eieio.command_messages.EIEIOCommandHeader(command: int | Enum)¶
Bases:
object
EIEIO header for command packets.
- Parameters:
command (int or Enum)
- static from_bytestring(data: bytes, offset: int) EIEIOCommandHeader [source]¶
Read an EIEIO command header from a byte-string.
- 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: EIEIOCommandHeader, data: bytes | None = None, offset: int = 0)¶
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: bytes¶
The eieio_command_header passed into the init as a byte string.
- Return type:
- property data: bytes | None¶
Gets the data passed into the init (if applicable).
- Return type:
bytes or None
- property eieio_header: EIEIOCommandHeader¶
The header of the message.
Gets the eieio_header passed into the init.
- Return type:
- static from_bytestring(command_header: EIEIOCommandHeader, data: bytes, offset: int) EIEIOCommandMessage [source]¶
Creates an EIEIOCommandMessage based on the supplied information.
- Parameters:
command_header (EIEIOCommandHeader)
data (bytes)
offset (int)
- Return type:
- class spinnman.messages.eieio.command_messages.EventStopRequest¶
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: int, sequence_no: int, channel: List[int] | int, region_id: List[int] | int, space_read: List[int] | int)¶
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:
- property bytestring: bytes¶
The eieio_command_header passed into the init as a byte string.
- Return type:
- channel(ack_id: int) int [source]¶
Gets the channel value for this ack_id.
- Parameters:
ack_id (int)
- Return type:
- Raises:
SpinnmanInvalidParameterTypeException – If the ack_id is invalid
- static from_bytestring(command_header: EIEIOCommandHeader, data: bytes, offset: int) HostDataRead [source]¶
Creates an EIEIOCommandMessage based on the supplied information.
- Parameters:
command_header (EIEIOCommandHeader)
data (bytes)
offset (int)
- Return type:
- class spinnman.messages.eieio.command_messages.HostDataReadAck(sequence_no: int)¶
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:
sequence_no (int)
- property bytestring: bytes¶
The eieio_command_header passed into the init as a byte string.
- Return type:
- static from_bytestring(command_header: EIEIOCommandHeader, data: bytes, offset: int) HostDataReadAck [source]¶
Creates an EIEIOCommandMessage based on the supplied information.
- Parameters:
command_header (EIEIOCommandHeader)
data (bytes)
offset (int)
- Return type:
- class spinnman.messages.eieio.command_messages.HostSendSequencedData(region_id: int, sequence_no: int, eieio_data_message: AbstractEIEIOMessage)¶
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:
region_id (int)
sequence_no (int)
eieio_data_message (AbstractEIEIOMessage)
- property bytestring: bytes¶
The eieio_command_header passed into the init as a byte string.
- Return type:
- property eieio_data_message: AbstractEIEIOMessage¶
The eieio_data_message passed into the init.
- Returns:
AbstractEIEIOMessage
- static from_bytestring(command_header: EIEIOCommandHeader, data: bytes, offset: int) HostSendSequencedData [source]¶
Creates an EIEIOCommandMessage based on the supplied information.
- Parameters:
command_header (EIEIOCommandHeader)
data (bytes)
offset (int)
- Return type:
- class spinnman.messages.eieio.command_messages.NotificationProtocolDatabaseLocation(database_path=None)¶
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 eieio_command_header passed into the init as a byte string.
- Return type:
- property database_path: str | None¶
Gets the database path passed into the init.
The path is encoded by the init and decode back to a str here.
- Return type:
- static from_bytestring(command_header, data, offset)[source]¶
Creates an EIEIOCommandMessage based on the supplied information.
- Parameters:
command_header (EIEIOCommandHeader)
data (bytes)
offset (int)
- Return type:
- class spinnman.messages.eieio.command_messages.NotificationProtocolPauseStop¶
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]¶
Creates an EIEIOCommandMessage based on the supplied information.
- Parameters:
command_header (EIEIOCommandHeader)
data (bytes)
offset (int)
- Return type:
- class spinnman.messages.eieio.command_messages.NotificationProtocolStartResume¶
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]¶
Creates an EIEIOCommandMessage based on the supplied information.
- Parameters:
command_header (EIEIOCommandHeader)
data (bytes)
offset (int)
- Return type:
- class spinnman.messages.eieio.command_messages.PaddingRequest¶
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
- class spinnman.messages.eieio.command_messages.SpinnakerRequestBuffers(x: int, y: int, p: int, region_id: int, sequence_no: int, space_available: int)¶
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.
- property bytestring: bytes¶
The eieio_command_header passed into the init as a byte string.
- Return type:
- static from_bytestring(command_header: EIEIOCommandHeader, data: bytes, offset: int) SpinnakerRequestBuffers [source]¶
Creates an EIEIOCommandMessage based on the supplied information.
- Parameters:
command_header (EIEIOCommandHeader)
data (bytes)
offset (int)
- Return type:
- class spinnman.messages.eieio.command_messages.SpinnakerRequestReadData(x: int, y: int, p: int, region_id: List[int] | int, sequence_no: int, n_requests: int, channel: List[int] | int, start_address: List[int] | int, space_to_be_read: List[int] | int)¶
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:
- property bytestring: bytes¶
The eieio_command_header passed into the init as a byte string.
- Return type:
- channel(request_id: int) int [source]¶
The channel for this request_id.
- Parameters:
request_id (int)
- Return type:
- Raises:
IndexError – If the request_id is invalid
- static from_bytestring(command_header: EIEIOCommandHeader, data: bytes, offset: int) SpinnakerRequestReadData [source]¶
Creates an EIEIOCommandMessage based on the supplied information.
- Parameters:
command_header (EIEIOCommandHeader)
data (bytes)
offset (int)
- Return type:
- region_id(request_id) int [source]¶
The region_id for this request_id.
- Parameters:
request_id (int)
- Return type:
- Raises:
IndexError – If the request_id is invalid
- space_to_be_read(request_id) int [source]¶
The space_to_be_read for this request_id.
- Parameters:
request_id (int)
- Return type:
- Raises:
IndexError – If the request_id is invalid
- start_address(request_id) int [source]¶
The start_address for this request_id.
- Parameters:
request_id (int)
- Return type:
- Raises:
IndexError – If the request_id is invalid
- class spinnman.messages.eieio.command_messages.StartRequests¶
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¶
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