pycozmo.protocol_ast¶

Cozmo protocol abstract syntax tree (AST) types.

Classes

`Argument`(name, description, default)	Base class for packet arguments.
`BoolArgument`(name, description, default)	8-bit boolean.
`Command`(packet_id, name, group, description, …)	Command packet.
`Connect`(description)	Connect packet.
`Disconnect`(description)	Disconnect packet.
`DoubleArgument`(name, description, default)	64-bit floating point number.
`Enum`(name, description, members, base)	Enumeration.
`EnumArgument`(name, enum_type, description, …)	Enumeration argument.
`EnumMember`(name, value, description)	Enumeration member.
`Event`(packet_id, name, group, description, …)	Event packet.
`FArrayArgument`(name, description, data_type, …)	Fixed-length array.
`FloatArgument`(name, description, default)	32-bit floating point number.
`FrameType`	Frame type enumeration.
`Int16Argument`(name, description, default)	16-bit signed integer.
`Int32Argument`(name, description, default)	32-bit signed integer.
`Int8Argument`(name, description, default)	8-bit signed integer.
`IntArgument`(name, description, default)	Base class for signed integers.
`Keyframe`(description)	Keyframe packet.
`Packet`(packet_type, name, packet_id, group, …)	Base class for packets.
`PacketType`	Packet type enumeration.
`Ping`(description)	Ping packet.
`Protocol`(enums, structs, packets)	Protocol declaration.
`StringArgument`(name, description, …)	String.
`Struct`(name, description, arguments)	Structure.
`UInt16Argument`(name, description, default)	16-bit unsigned integer.
`UInt32Argument`(name, description, default)	32-bit unsigned integer.
`UInt8Argument`(name, description, default)	8-bit unsigned integer.
`UIntArgument`(name, description, default)	Base class for unsigned integers.
`VArrayArgument`(name, description, data_type, …)	Variable-length array.

class pycozmo.protocol_ast.FrameType¶

Bases: enum.Enum

Frame type enumeration.

ENGINE = 7¶

ENGINE_ACT = 4¶

FIN = 3¶

PING = 11¶

RESET = 1¶

RESET_ACK = 2¶

ROBOT = 9¶

class pycozmo.protocol_ast.PacketType¶

Bases: enum.Enum

Packet type enumeration.

COMMAND = 4¶

CONNECT = 2¶

DISCONNECT = 3¶

EVENT = 5¶

KEYFRAME = 10¶

PING = 11¶

UNKNOWN = -1¶

class pycozmo.protocol_ast.EnumMember(name: str, value: int, description: Optional[str] = None)¶

Bases: object

Enumeration member.

class pycozmo.protocol_ast.Enum(name: str, description: Optional[str] = None, members: Optional[List[pycozmo.protocol_ast.EnumMember]] = None, base: int = 10)¶

Bases: object

Enumeration.

class pycozmo.protocol_ast.Struct(name: Optional[str] = None, description: Optional[str] = None, arguments: Optional[List[pycozmo.protocol_ast.Argument]] = None)¶

Bases: pycozmo.protocol_ast.Argument

Structure.

type_hint()¶

class pycozmo.protocol_ast.Argument(name: Optional[str] = None, description: Optional[str] = None, default: Any = None)¶

Bases: abc.ABC

Base class for packet arguments.

type_hint() → Optional[str]¶

class pycozmo.protocol_ast.FloatArgument(name: Optional[str] = None, description: Optional[str] = None, default: float = 0.0)¶

Bases: pycozmo.protocol_ast.Argument

32-bit floating point number.

type_hint()¶

class pycozmo.protocol_ast.DoubleArgument(name: Optional[str] = None, description: Optional[str] = None, default: float = 0.0)¶

Bases: pycozmo.protocol_ast.Argument

64-bit floating point number.

type_hint()¶

class pycozmo.protocol_ast.BoolArgument(name: Optional[str] = None, description: Optional[str] = None, default: bool = False)¶

Bases: pycozmo.protocol_ast.Argument

8-bit boolean.

type_hint()¶

class pycozmo.protocol_ast.UIntArgument(name: Optional[str] = None, description: Optional[str] = None, default: Any = None)¶

Bases: pycozmo.protocol_ast.Argument, abc.ABC

Base class for unsigned integers.

type_hint() → Optional[str]¶

class pycozmo.protocol_ast.UInt8Argument(name: Optional[str] = None, description: Optional[str] = None, default: int = 0)¶

Bases: pycozmo.protocol_ast.UIntArgument

8-bit unsigned integer.

type_hint()¶

class pycozmo.protocol_ast.UInt16Argument(name: Optional[str] = None, description: Optional[str] = None, default: int = 0)¶

Bases: pycozmo.protocol_ast.UIntArgument

16-bit unsigned integer.

type_hint()¶

class pycozmo.protocol_ast.UInt32Argument(name: Optional[str] = None, description: Optional[str] = None, default: int = 0)¶

Bases: pycozmo.protocol_ast.UIntArgument

32-bit unsigned integer.

type_hint()¶

class pycozmo.protocol_ast.IntArgument(name: Optional[str] = None, description: Optional[str] = None, default: Any = None)¶

Bases: pycozmo.protocol_ast.Argument, abc.ABC

Base class for signed integers.

type_hint() → Optional[str]¶

class pycozmo.protocol_ast.Int8Argument(name: Optional[str] = None, description: Optional[str] = None, default: int = 0)¶

Bases: pycozmo.protocol_ast.IntArgument

8-bit signed integer.

type_hint()¶

class pycozmo.protocol_ast.Int16Argument(name: Optional[str] = None, description: Optional[str] = None, default: int = 0)¶

Bases: pycozmo.protocol_ast.IntArgument

16-bit signed integer.

type_hint()¶

class pycozmo.protocol_ast.Int32Argument(name: Optional[str] = None, description: Optional[str] = None, default: int = 0)¶

Bases: pycozmo.protocol_ast.IntArgument

32-bit signed integer.

type_hint()¶

class pycozmo.protocol_ast.EnumArgument(name: str, enum_type: pycozmo.protocol_ast.Enum, description: Optional[str] = None, data_type: Union[pycozmo.protocol_ast.IntArgument, pycozmo.protocol_ast.UIntArgument] = <pycozmo.protocol_ast.Int8Argument object>, default: int = 0)¶

Bases: pycozmo.protocol_ast.Argument

Enumeration argument.

type_hint()¶

class pycozmo.protocol_ast.FArrayArgument(name: Optional[str] = None, description: Optional[str] = None, data_type: pycozmo.protocol_ast.Argument = <pycozmo.protocol_ast.UInt8Argument object>, length: int = 0, default: Tuple = ())¶

Bases: pycozmo.protocol_ast.Argument

Fixed-length array.

type_hint()¶

class pycozmo.protocol_ast.VArrayArgument(name: Optional[str] = None, description: Optional[str] = None, data_type: pycozmo.protocol_ast.Argument = <pycozmo.protocol_ast.UInt8Argument object>, length_type: pycozmo.protocol_ast.Argument = <pycozmo.protocol_ast.UInt16Argument object>, default: Tuple = ())¶

Bases: pycozmo.protocol_ast.Argument

Variable-length array.

type_hint()¶

class pycozmo.protocol_ast.StringArgument(name: Optional[str] = None, description: Optional[str] = None, length_type: pycozmo.protocol_ast.Argument = <pycozmo.protocol_ast.UInt16Argument object>, default: str = '')¶

Bases: pycozmo.protocol_ast.Argument

String.

type_hint()¶

class pycozmo.protocol_ast.Packet(packet_type: pycozmo.protocol_ast.PacketType, name: str, packet_id: Optional[int] = None, group: Optional[str] = None, description: Optional[str] = None, arguments: Optional[List[pycozmo.protocol_ast.Argument]] = None)¶

Bases: pycozmo.protocol_ast.Struct, abc.ABC

Base class for packets.

type_hint()¶

class pycozmo.protocol_ast.Connect(description: Optional[str] = None)¶

Bases: pycozmo.protocol_ast.Packet

Connect packet.

type_hint()¶

class pycozmo.protocol_ast.Disconnect(description: Optional[str] = None)¶

Bases: pycozmo.protocol_ast.Packet

Disconnect packet.

type_hint()¶

class pycozmo.protocol_ast.Command(packet_id: int, name: str, group: Optional[str] = None, description: Optional[str] = None, arguments: Optional[List[pycozmo.protocol_ast.Argument]] = None)¶

Bases: pycozmo.protocol_ast.Packet

Command packet.

type_hint()¶

class pycozmo.protocol_ast.Event(packet_id: int, name: str, group: Optional[str] = None, description: Optional[str] = None, arguments: Optional[List[pycozmo.protocol_ast.Argument]] = None)¶

Bases: pycozmo.protocol_ast.Packet

Event packet.

type_hint()¶

class pycozmo.protocol_ast.Ping(description: Optional[str] = None)¶

Bases: pycozmo.protocol_ast.Packet

Ping packet.

type_hint()¶

class pycozmo.protocol_ast.Keyframe(description: Optional[str] = None)¶

Bases: pycozmo.protocol_ast.Packet

Keyframe packet.

type_hint()¶

class pycozmo.protocol_ast.Protocol(enums: List[pycozmo.protocol_ast.Enum], structs: List[pycozmo.protocol_ast.Struct], packets: List[pycozmo.protocol_ast.Packet])¶

Bases: object

Protocol declaration.