pycozmo.protocol_base¶
Cozmo protocol implementation base.
Classes
Packet (packet_type, packet_id) |
|
Struct |
|
UnknownCommand (packet_id, data) |
|
UnknownEvent (packet_id, data) |
|
UnknownPacket (packet_type, data, packet_id) |
-
class
pycozmo.protocol_base.
Struct
¶ Bases:
abc.ABC
-
classmethod
from_bytes
(buffer: bytes) → pycozmo.protocol_base.Struct¶
-
classmethod
from_reader
(reader: pycozmo.protocol_utils.BinaryReader) → pycozmo.protocol_base.Struct¶
-
to_bytes
() → bytes¶
-
to_writer
(writer: pycozmo.protocol_utils.BinaryWriter) → None¶
-
classmethod
-
class
pycozmo.protocol_base.
Packet
(packet_type: pycozmo.protocol_ast.PacketType, packet_id: Optional[int] = None)¶ Bases:
pycozmo.protocol_base.Struct
,abc.ABC
-
ack
¶
-
classmethod
from_bytes
(buffer: bytes) → pycozmo.protocol_base.Struct¶
-
classmethod
from_reader
(reader: pycozmo.protocol_utils.BinaryReader) → pycozmo.protocol_base.Struct¶
-
id
¶
-
is_from_engine
() → bool¶
-
is_from_robot
() → bool¶
-
is_oob
() → bool¶
-
seq
¶
-
to_bytes
() → bytes¶
-
to_writer
(writer: pycozmo.protocol_utils.BinaryWriter) → None¶
-
type
¶
-
-
class
pycozmo.protocol_base.
UnknownPacket
(packet_type: pycozmo.protocol_ast.PacketType, data: bytes, packet_id: Optional[int] = None)¶ Bases:
pycozmo.protocol_base.Packet
-
ack
¶
-
data
¶
-
classmethod
from_bytes
(buffer)¶
-
classmethod
from_reader
(reader)¶
-
id
¶
-
is_from_engine
() → bool¶
-
is_from_robot
() → bool¶
-
is_oob
() → bool¶
-
seq
¶
-
to_bytes
()¶
-
to_writer
(writer)¶
-
type
¶
-
-
class
pycozmo.protocol_base.
UnknownCommand
(packet_id: int, data: bytes = b'')¶ Bases:
pycozmo.protocol_base.UnknownPacket
-
ack
¶
-
data
¶
-
classmethod
from_bytes
(buffer)¶
-
classmethod
from_reader
(reader)¶
-
id
¶
-
is_from_engine
() → bool¶
-
is_from_robot
() → bool¶
-
is_oob
() → bool¶
-
seq
¶
-
to_bytes
()¶
-
to_writer
(writer)¶
-
type
¶
-
-
class
pycozmo.protocol_base.
UnknownEvent
(packet_id: int, data: bytes = b'')¶ Bases:
pycozmo.protocol_base.UnknownPacket
-
ack
¶
-
data
¶
-
classmethod
from_bytes
(buffer)¶
-
classmethod
from_reader
(reader)¶
-
id
¶
-
is_from_engine
() → bool¶
-
is_from_robot
() → bool¶
-
is_oob
() → bool¶
-
seq
¶
-
to_bytes
()¶
-
to_writer
(writer)¶
-
type
¶
-