spinnman.messages.scp.scp_request_header module

class spinnman.messages.scp.scp_request_header.SCPRequestHeader(command, sequence=None)

Bases: object

Represents the header of an SCP Request Each optional parameter in the constructor can be set to a value other than None once, after which it is immutable. It is an error to set a parameter that is not currently None.

Parameters:

• command (spinnman.messages.scp.scp_command.SCPCommand) – The SCP command
• sequence (int) – The number of the SCP packet in order of all packets sent or received, between 0 and 65535

Raises spinnman.exceptions.SpinnmanInvalidParameterException:  

If one of the parameters is incorrect

Attributes

command	The command of the SCP packet
sequence	The sequence number of the SCP packet

Methods

write_scp_request_header(byte_writer)

Write the SCP header to a byte_writer

Detailed Methods

write_scp_request_header(byte_writer)

Write the SCP header to a byte_writer

Parameters:

byte_writer (spinnman.data.abstract_byte_writer.AbstractByteWriter) – The writer to write the data to

Returns:

Nothing is returned

Return type:

None

Raises:

• spinnman.exceptions.SpinnmanIOException – If there is an error writing to the writer
• spinnman.exceptions.SpinnmanInvalidParameterException – If any of the parameter values have not been set