hardware_messages Module

This modue contains all the messages taht are received.

AYABInterface.communication.hardware_messages.read_message_type(file)

Read the message type from a file.

class AYABInterface.communication.hardware_messages.StateIndication(file, communication)

Bases: AYABInterface.communication.hardware_messages.FixedSizeMessage

This message shows the state of the controller.

See also

The indState Message

MESSAGE_ID = 132

The first byte that indicates this message

carriage

The carriage which is reported.

Return type:AYABInterface.communication.carriages.Carriage Returns:the carriage with information about its position

current_needle

The current needle position.

Return type:int

is_ready_to_knit()

Whether this message indicates that the controller can knit now.

is_state_indication()

Whether this is a InformationConfirmation message.

Return type:bool Returns:True

is_valid()

Whether this messages matches the specification.

left_hall_sensor_value

The value of the left hall sensor.

Return type:int

received_by(visitor)

Call visitor.receive_state_indication.

right_hall_sensor_value

The value of the left hall sensor.

Return type:int

class AYABInterface.communication.hardware_messages.LineRequest(file, communication)

Bases: AYABInterface.communication.hardware_messages.FixedSizeMessage

The controller requests a line.

See also

The reqLine Message

MESSAGE_ID = 130

The first byte that indicates this message

is_line_request()

Whether this is a LineRequest message.

Return type:bool Returns:True

line_number

The line number that was requested.

received_by(visitor)

Call visitor.receive_line_request.

class AYABInterface.communication.hardware_messages.TestConfirmation(file, communication)

Bases: AYABInterface.communication.hardware_messages.SuccessConfirmation

This message is sent at/when

MESSAGE_ID = 196

The first byte that indicates this message

is_test_confirmation()

Whether this is a TestConfirmation message.

Return type:bool Returns:True

received_by(visitor)

Call visitor.test_information_confirmation.

class AYABInterface.communication.hardware_messages.InformationConfirmation(file, communication)

Bases: AYABInterface.communication.hardware_messages.FixedSizeMessage

This message is the answer in the initial handshake.

A InformationRequest requests this message from the controller to start the initial handshake.

See also

The cnfInfo Message InformationRequest

MESSAGE_ID = 195

The first byte that indicates this message

api_version

The API version of the controller.

Return type:int

api_version_is_supported()

Whether the communication object supports this API version.

Return type:bool

See also

Communication.api_version_is_supported

firmware_version

The firmware version of the controller.

Return type:FirmwareVersion

minor_version = int()
mayor_version = int()

assert message.firmware_version == (mayor_version, minor_version)
assert message.firmware_version.major == mayor_version
assert message.firmware_version.minor == minor_version

is_information_confirmation()

Whether this is a InformationConfirmation message.

Return type:bool Returns:True

received_by(visitor)

Call visitor.receive_information_confirmation.

class AYABInterface.communication.hardware_messages.Debug(file, communication)

Bases: AYABInterface.communication.hardware_messages.Message

This message contains debug output from the controller.

See also

The debug Message

bytes

The debug message as bytes.

Return type:bytes Returns:the debug message as bytes without the b'\r\n' at the end

is_debug()

Whether this is a Debug message.

Return type:bool Returns:False

received_by(visitor)

Call visitor.receive_debug.

class AYABInterface.communication.hardware_messages.StartConfirmation(file, communication)

Bases: AYABInterface.communication.hardware_messages.SuccessConfirmation

This marks the success or failure of a reqStart message.

See also

The cnfStart Message

MESSAGE_ID = 193

The first byte that indicates this message

is_start_confirmation()

Whether this is a StartConfirmation message.

Return type:bool Returns:True

received_by(visitor)

Call visitor.receive_state_confirmation.

class AYABInterface.communication.hardware_messages.SuccessConfirmation(file, communication)

Bases: AYABInterface.communication.hardware_messages.FixedSizeMessage

Base class for massages of success and failure.

is_success()

Whether the configuration was successful.

Return type:bool

is_valid()

Whether this message is valid.

class AYABInterface.communication.hardware_messages.UnknownMessage(file, communication)

Bases: AYABInterface.communication.hardware_messages.FixedSizeMessage

This is a special message for unknown message types.

is_unknown()

Whether this is a StateIndication message.

Return type:bool Returns:True

is_valid()

Whether the message is valid.

Return type:bool Returns:False

received_by(visitor)

Call visitor.receive_unkown.

class AYABInterface.communication.hardware_messages.Message(file, communication)

Bases: object

This is the base class for messages that are received.

__init__(file, communication)

Create a new Message.

__repr__()

This object as string.

Return type:str

__weakref__

list of weak references to the object (if defined)

is_connection_closed()

Whether this is a ConnectionClosed message.

Return type:bool Returns:False

is_debug()

Whether this is a Debug message.

Return type:bool Returns:False

is_from_controller()

Whether this message is sent by the controller.

Return type:bool Returns:True

is_from_host()

Whether this message is sent by the host.

Return type:bool Returns:False

is_information_confirmation()

Whether this is a InformationConfirmation message.

Return type:bool Returns:False

is_line_request()

Whether this is a LineRequest message.

Return type:bool Returns:False

is_start_confirmation()

Whether this is a StartConfirmation message.

Return type:bool Returns:False

is_state_indication()

Whether this is a StateIndication message.

Return type:bool Returns:False

is_test_confirmation()

Whether this is a TestConfirmation message.

Return type:bool Returns:False

is_unknown()

Whether this is a StateIndication message.

Return type:bool Returns:False

is_valid()

Whether the message is valid.

Return type:bool Returns:True

wants_to_answer()

Whether this message produces and answer message.

Return type:bool Returns:False

class AYABInterface.communication.hardware_messages.ConnectionClosed(file, communication)

Bases: AYABInterface.communication.hardware_messages.Message

This message is notified about when the connection is closed.

is_connection_closed()

Whether this is a ConnectionClosed message.

Return type:bool Returns:True

received_by(visitor)

Call visitor.receive_connection_closed.

class AYABInterface.communication.hardware_messages.FirmwareVersion(major, minor)

Bases: tuple

__getnewargs__()

Return self as a plain tuple. Used by copy and pickle.

__getstate__()

Exclude the OrderedDict from pickling

static __new__(_cls, major, minor)

Create new instance of FirmwareVersion(major, minor)

__repr__()

Return a nicely formatted representation string

major

Alias for field number 0

minor

Alias for field number 1

class AYABInterface.communication.hardware_messages.FixedSizeMessage(file, communication)

Bases: AYABInterface.communication.hardware_messages.Message

This is a message of fixed size.

__init__(file, communication)

Create a new Message.

read_end_of_message()

Read the b”rn” at the end of the message.