spinnman.messages.scp.abstract_messages package¶
Module contents¶
-
class
spinnman.messages.scp.abstract_messages.
BMPRequest
(boards, scp_request_header, argument_1=None, argument_2=None, argument_3=None, data=None)[source]¶ Bases:
spinnman.messages.scp.abstract_messages.scp_request.AbstractSCPRequest
An SCP request intended to be sent to a BMP.
Parameters: - boards (int or list(int) or tuple(int)) – The board or boards to be addressed by this request
- scp_request_header (SCPRequestHeader) – The SCP request header
- argument_1 (int) – The optional first argument
- argument_2 (int) – The optional second argument
- argument_3 (int) – The optional third argument
- data (bytes) – The optional data to be sent
-
class
spinnman.messages.scp.abstract_messages.
BMPResponse
[source]¶ Bases:
spinnman.messages.scp.abstract_messages.scp_response.AbstractSCPResponse
Represents an SCP request thats tailored for the BMP connection.
-
class
spinnman.messages.scp.abstract_messages.
AbstractSCPRequest
(sdp_header, scp_request_header, argument_1=None, argument_2=None, argument_3=None, data=None)[source]¶ Bases:
object
Represents an Abstract SCP Request.
Parameters: - sdp_header (SDPHeader) – The SDP header of the request
- scp_request_header (SCPRequestHeader) – The SCP header of the request
- argument_1 (int) – The first argument, or None if no first argument
- argument_2 (int) – The second argument, or None if no second argument
- argument_3 (int) – The third argument, or None if no third argument
- data (bytearray or bytes or None) – The optional data, or None if no data
-
DEFAULT_DEST_X_COORD
= 255¶
-
DEFAULT_DEST_Y_COORD
= 255¶
-
get_scp_response
()[source]¶ Get an SCP response message to be used to process any response received.
Returns: An SCP response, or None if no response is required Return type: AbstractSCPResponse
-
scp_request_header
¶ The SCP request header of the message.
Return type: SCPRequestHeader
-
class
spinnman.messages.scp.abstract_messages.
AbstractSCPResponse
[source]¶ Bases:
object
Represents an abstract SCP Response.
-
read_data_bytestring
(data, offset)[source]¶ Reads the remainder of the data following the header.
Parameters:
-
scp_response_header
¶ The SCP header from the response.
Return type: SCPResponseHeader
-