pycozmo.protocol_encoder

Cozmo protocol packet encoder classes, based on protocol version 2381.

Generated from protocol_declaration.py by protocol_generator.py .

Do not modify.

Classes

AbortAnimation()
AcknowledgeAction([action_id])
AnimBackpackLights([colors])
AnimBody([speed, unknown])
AnimHead([duration_ms, variability_deg, …])
AnimLift([duration_ms, variability_mm, …])
AnimationEnded([anim_id])
AnimationStarted([anim_id])
AnimationState([timestamp, …])
AppendPathSegArc([center_x, center_y, …])
AppendPathSegLine([from_x, from_y, to_x, …])
AppendPathSegPointTurn([x, y, angle_rad, …])
BodyColor An enumeration.
BodyInfo([serial_number, body_hw_version, …])
ButtonPressed([pressed])
ClearPath([unknown])
Connect()
CubeId([object_id, rotation_period_frames])
CubeLights([states])
DebugData([format_id, unused, name_id, …])
Disconnect()
DisplayImage([image])
DriveWheels([lwheel_speed_mmps, …])
Enable()
EnableAnimationState()
EnableCamera([image_send_mode, image_resolution])
EnableColorImages([enable])
EnableStopOnCliff([enable])
EndAnimation()
ExecutePath([event_id, unknown])
FallingStarted([unknown])
FallingStopped([unknown, duration_ms, …])
FirmwareSignature([unknown, signature])
FirmwareUpdate([chunk_id, data])
FirmwareUpdateResult([byte_count, chunk_id, …])
HardwareInfo([serial_number_head, unknown1, …])
ImageChunk([frame_timestamp, image_id, …])
ImageEncoding An enumeration.
ImageImuData([image_id, rate_x, rate_y, …])
ImageResolution An enumeration.
ImageSendMode An enumeration.
Keyframe()
LightState([on_color, off_color, on_frames, …])
LightStateCenter([states, unknown])
LightStateSide([states, unknown])
MotorCalibration([motor_id, calib_started, …])
MotorID An enumeration.
MoveHead([speed_rad_per_sec])
MoveLift([speed_rad_per_sec])
NvEntryTag An enumeration.
NvOperation An enumeration.
NvResult An enumeration.
NvStorageOp([tag, length, op, unknown, data])
NvStorageOpResult([tag, length, op, result, …])
ObjectAccel([timestamp, object_id, accel_x, …])
ObjectAvailable([factory_id, object_type, rssi])
ObjectConnect([factory_id, connect])
ObjectConnectionState([object_id, …])
ObjectMoved([timestamp, object_id, …])
ObjectPowerLevel([object_id, …])
ObjectStoppedMoving([timestamp, object_id])
ObjectTapFiltered([timestamp, object_id, …])
ObjectTapped([timestamp, object_id, …])
ObjectType An enumeration.
ObjectUpAxisChanged([timestamp, object_id, axis])
OutputAudio([samples])
OutputSilence()
PathEventType An enumeration.
PathFollowingEvent([event_id, event_type])
PathSegmentSpeed([speed_mmps, accel_mmps2, …])
Ping([time_sent_ms, counter, last, unknown])
RecordHeading()
RobotDelocalized()
RobotPoked()
RobotState([timestamp, pose_frame_id, …])
SetAccessoryDiscovery([enable])
SetCameraParams([gain, exposure_ms, …])
SetHeadAngle([angle_rad, …])
SetHeadLight([enable])
SetLiftHeight([height_mm, …])
SetOrigin([unknown0, pose_frame_id, …])
SetRobotVolume([level])
ShutdownRobot()
StartAnimation([anim_id])
StartMotorCalibration([head, lift])
StopAllMotors()
StreamObjectAccel([object_id, enable])
SyncTime([timestamp, unknown])
TrimPath([head, tail])
TurnInPlace([angle_rad, speed_rad_per_sec, …])
TurnInPlaceAtSpeed([wheel_speed_mmps, …])
TurnToRecordedHeading()
UpAxis An enumeration.
WifiOff([enable])
class pycozmo.protocol_encoder.AbortAnimation

Bases: pycozmo.protocol_base.Packet

ack
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_encoder.AcknowledgeAction(action_id=0)

Bases: pycozmo.protocol_base.Packet

ack
action_id
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_encoder.AnimBackpackLights(colors=())

Bases: pycozmo.protocol_base.Packet

ack
colors
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_encoder.AnimBody(speed=0, unknown=0)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
speed
to_bytes()
to_writer(writer)
type
unknown
class pycozmo.protocol_encoder.AnimHead(duration_ms=0, variability_deg=0, angle_deg=0)

Bases: pycozmo.protocol_base.Packet

ack
angle_deg
duration_ms
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
variability_deg
class pycozmo.protocol_encoder.AnimLift(duration_ms=0, variability_mm=0, height_mm=0)

Bases: pycozmo.protocol_base.Packet

ack
duration_ms
classmethod from_bytes(buffer)
classmethod from_reader(reader)
height_mm
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
to_bytes()
to_writer(writer)
type
variability_mm
class pycozmo.protocol_encoder.AnimationEnded(anim_id=0)

Bases: pycozmo.protocol_base.Packet

ack
anim_id
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_encoder.AnimationStarted(anim_id=0)

Bases: pycozmo.protocol_base.Packet

ack
anim_id
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_encoder.AnimationState(timestamp=0, num_anim_bytes_played=0, num_audio_frames_played=0, enabled_anim_tracks=0, tag=0, client_drop_count=0)

Bases: pycozmo.protocol_base.Packet

ack
client_drop_count
enabled_anim_tracks
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
num_anim_bytes_played
num_audio_frames_played
seq
tag
timestamp
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.AppendPathSegArc(center_x=0.0, center_y=0.0, radius_mm=0.0, start_angle_rad=0.0, sweep_rad=0.0, speed_mmps=0.0, accel_mmps2=0.0, decel_mmps2=0.0)

Bases: pycozmo.protocol_base.Packet

accel_mmps2
ack
center_x
center_y
decel_mmps2
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
radius_mm
seq
speed_mmps
start_angle_rad
sweep_rad
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.AppendPathSegLine(from_x=0.0, from_y=0.0, to_x=0.0, to_y=0.0, speed_mmps=0.0, accel_mmps2=0.0, decel_mmps2=0.0)

Bases: pycozmo.protocol_base.Packet

accel_mmps2
ack
decel_mmps2
classmethod from_bytes(buffer)
classmethod from_reader(reader)
from_x
from_y
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
speed_mmps
to_bytes()
to_writer(writer)
to_x
to_y
type
class pycozmo.protocol_encoder.AppendPathSegPointTurn(x=0.0, y=0.0, angle_rad=0.0, angle_tolerance_rad=0.0, speed_mmps=0.0, accel_mmps2=0.0, decel_mmps2=0.0, unknown=False)

Bases: pycozmo.protocol_base.Packet

accel_mmps2
ack
angle_rad
angle_tolerance_rad
decel_mmps2
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
speed_mmps
to_bytes()
to_writer(writer)
type
unknown
x
y
class pycozmo.protocol_encoder.BodyColor

Bases: enum.Enum

An enumeration.

CE_LM_v15 = 3
DEV = 5
LE_BL_v16 = 4
RESERVED = 1
UNKNOWN = -1
WHITE_v10 = 0
WHITE_v15 = 2
class pycozmo.protocol_encoder.BodyInfo(serial_number=0, body_hw_version=0, body_color=-1)

Bases: pycozmo.protocol_base.Packet

ack
body_color
body_hw_version
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
serial_number
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.ButtonPressed(pressed=False)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
pressed
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.ClearPath(unknown=0)

Bases: pycozmo.protocol_base.Packet

ack
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
unknown
class pycozmo.protocol_encoder.Connect

Bases: pycozmo.protocol_base.Packet

ack
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_encoder.CubeId(object_id=0, rotation_period_frames=0)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
object_id
rotation_period_frames
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.CubeLights(states=())

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
states
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.DebugData(format_id=0, unused=0, name_id=0, level=0, args=())

Bases: pycozmo.protocol_base.Packet

ack
args
format_id
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
level
name_id
seq
to_bytes()
to_writer(writer)
type
unused
class pycozmo.protocol_encoder.Disconnect

Bases: pycozmo.protocol_base.Packet

ack
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_encoder.DisplayImage(image=())

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
image
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.DriveWheels(lwheel_speed_mmps=0.0, rwheel_speed_mmps=0.0, lwheel_accel_mmps2=0.0, rwheel_accel_mmps2=0.0)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
lwheel_accel_mmps2
lwheel_speed_mmps
rwheel_accel_mmps2
rwheel_speed_mmps
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.Enable

Bases: pycozmo.protocol_base.Packet

ack
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_encoder.EnableAnimationState

Bases: pycozmo.protocol_base.Packet

ack
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_encoder.EnableCamera(image_send_mode=1, image_resolution=4)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
image_resolution
image_send_mode
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.EnableColorImages(enable=False)

Bases: pycozmo.protocol_base.Packet

ack
enable
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_encoder.EnableStopOnCliff(enable=False)

Bases: pycozmo.protocol_base.Packet

ack
enable
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_encoder.EndAnimation

Bases: pycozmo.protocol_base.Packet

ack
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_encoder.ExecutePath(event_id=0, unknown=False)

Bases: pycozmo.protocol_base.Packet

ack
event_id
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
unknown
class pycozmo.protocol_encoder.FallingStarted(unknown=0)

Bases: pycozmo.protocol_base.Packet

ack
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
unknown
class pycozmo.protocol_encoder.FallingStopped(unknown=0, duration_ms=0, impact_intensity=0.0)

Bases: pycozmo.protocol_base.Packet

ack
duration_ms
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
impact_intensity
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
to_bytes()
to_writer(writer)
type
unknown
class pycozmo.protocol_encoder.FirmwareSignature(unknown=0, signature='')

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
signature
to_bytes()
to_writer(writer)
type
unknown
class pycozmo.protocol_encoder.FirmwareUpdate(chunk_id=0, data=())

Bases: pycozmo.protocol_base.Packet

ack
chunk_id
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_encoder.FirmwareUpdateResult(byte_count=0, chunk_id=0, status=0)

Bases: pycozmo.protocol_base.Packet

ack
byte_count
chunk_id
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
status
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.HardwareInfo(serial_number_head=0, unknown1=0, unknown2=0)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
serial_number_head
to_bytes()
to_writer(writer)
type
unknown1
unknown2
class pycozmo.protocol_encoder.ImageChunk(frame_timestamp=0, image_id=0, chunk_debug=0, image_encoding=0, image_resolution=0, image_chunk_count=0, chunk_id=0, status=0, data=())

Bases: pycozmo.protocol_base.Packet

ack
chunk_debug
chunk_id
data
frame_timestamp
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
image_chunk_count
image_encoding
image_id
image_resolution
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
status
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.ImageEncoding

Bases: enum.Enum

An enumeration.

BAYER = 4
JPEGColor = 6
JPEGColorHalfWidth = 7
JPEGGray = 5
JPEGMinimizedColor = 9
JPEGMinimizedGray = 8
NoneImageEncoding = 0
RawGray = 1
RawRGB = 2
YUYV = 3
class pycozmo.protocol_encoder.ImageImuData(image_id=0, rate_x=0.0, rate_y=0.0, rate_z=0.0, line_2_number=0)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
image_id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
line_2_number
rate_x
rate_y
rate_z
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.ImageResolution

Bases: enum.Enum

An enumeration.

CVGA = 5
ImageResolutionCount = 13
ImageResolutionNone = 14
QQQQVGA = 1
QQQVGA = 2
QQVGA = 3
QUXGA = 12
QVGA = 4
QXGA = 11
SVGA = 7
SXGA = 9
UXGA = 10
VGA = 6
VerificationSnapshot = 0
XGA = 8
class pycozmo.protocol_encoder.ImageSendMode

Bases: enum.Enum

An enumeration.

Off = 0
SingleShot = 2
Stream = 1
class pycozmo.protocol_encoder.Keyframe

Bases: pycozmo.protocol_base.Packet

ack
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_encoder.LightState(on_color=0, off_color=0, on_frames=0, off_frames=0, transition_on_frames=0, transition_off_frames=0, offset=0)

Bases: pycozmo.protocol_base.Struct

classmethod from_bytes(buffer)
classmethod from_reader(reader)
off_color
off_frames
offset
on_color
on_frames
to_bytes()
to_writer(writer)
transition_off_frames
transition_on_frames
class pycozmo.protocol_encoder.LightStateCenter(states=(), unknown=0)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
states
to_bytes()
to_writer(writer)
type
unknown
class pycozmo.protocol_encoder.LightStateSide(states=(), unknown=0)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
states
to_bytes()
to_writer(writer)
type
unknown
class pycozmo.protocol_encoder.MotorCalibration(motor_id=0, calib_started=False, auto_started=False)

Bases: pycozmo.protocol_base.Packet

ack
auto_started
calib_started
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
motor_id
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.MotorID

Bases: enum.Enum

An enumeration.

MOTOR_HEAD = 3
MOTOR_LEFT_WHEEL = 0
MOTOR_LIFT = 2
MOTOR_RIGHT_WHEEL = 1
class pycozmo.protocol_encoder.MoveHead(speed_rad_per_sec=0.0)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
speed_rad_per_sec
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.MoveLift(speed_rad_per_sec=0.0)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
speed_rad_per_sec
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.NvEntryTag

Bases: enum.Enum

An enumeration.

NVEntry_BirthCertificate = 2147483648
NVEntry_CalibImage1 = 2147549184
NVEntry_CalibImage2 = 2147614720
NVEntry_CalibImage3 = 2147680256
NVEntry_CalibImage4 = 2147745792
NVEntry_CalibImage5 = 2147811328
NVEntry_CalibImage6 = 2147876864
NVEntry_CalibMetaInfo = 2147483652
NVEntry_CalibPose = 2147483651
NVEntry_CameraCalib = 2147483649
NVEntry_CliffValOnDrop = 2147483655
NVEntry_CliffValOnGround = 2147483656
NVEntry_FACTORY_RESERVED1 = 1835008
NVEntry_FACTORY_RESERVED2 = 1957888
NVEntry_FaceAlbumData = 1589248
NVEntry_FaceEnrollData = 1585152
NVEntry_FactoryBaseTag = 909312
NVEntry_FactoryBaseTagWithBCOffset = 909360
NVEntry_FactoryLock = 2147483665
NVEntry_GameSkillLevels = 1572864
NVEntry_GameUnlocks = 1581056
NVEntry_IMUAverages = 3221225476
NVEntry_IMUInfo = 2147483654
NVEntry_Invalid = 4294967295
NVEntry_InventoryData = 1658880
NVEntry_LabAssignments = 1662976
NVEntry_NEXT_SLOT = 1671168
NVEntry_NurtureGameData = 1654784
NVEntry_ObservedCubePose = 2147483653
NVEntry_OnboardingData = 1576960
NVEntry_PlaypenTestResults = 2147483664
NVEntry_PrePlaypenCentroids = 3221225473
NVEntry_PrePlaypenResults = 3221225472
NVEntry_SavedCubeIDs = 1667072
NVEntry_ToolCodeImageLeft = 2148532224
NVEntry_ToolCodeImageRight = 2148597760
NVEntry_ToolCodeInfo = 2147483650
NVEntry_VersionMagic = 2147483666
class pycozmo.protocol_encoder.NvOperation

Bases: enum.Enum

An enumeration.

NVOP_ERASE = 2
NVOP_READ = 0
NVOP_WIPEALL = 3
NVOP_WRITE = 1
class pycozmo.protocol_encoder.NvResult

Bases: enum.Enum

An enumeration.

NV_BAD_ARGS = -6
NV_BUSY = -5
NV_CORRUPT = -9
NV_ERROR = -3
NV_LOOP = -8
NV_MORE = 3
NV_NOT_FOUND = -1
NV_NO_DO = 2
NV_NO_MEM = -7
NV_NO_ROOM = -2
NV_OKAY = 0
NV_SCHEDULED = 1
NV_TIMEOUT = -4
NV_UNKNOWN_4 = 4
NV_UNKNOWN_5 = 5
NV_UNKNOWN_6 = 6
NV_UNKNOWN_7 = 7
NV_UNKNOWN_8 = 8
class pycozmo.protocol_encoder.NvStorageOp(tag=4294967295, length=0, op=0, unknown=0, data=())

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
length
op
seq
tag
to_bytes()
to_writer(writer)
type
unknown
class pycozmo.protocol_encoder.NvStorageOpResult(tag=4294967295, length=0, op=0, result=0, data=())

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
length
op
result
seq
tag
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.ObjectAccel(timestamp=0, object_id=0, accel_x=0.0, accel_y=0.0, accel_z=0.0)

Bases: pycozmo.protocol_base.Packet

accel_x
accel_y
accel_z
ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
object_id
seq
timestamp
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.ObjectAvailable(factory_id=0, object_type=-1, rssi=0)

Bases: pycozmo.protocol_base.Packet

ack
factory_id
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
object_type
rssi
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.ObjectConnect(factory_id=0, connect=False)

Bases: pycozmo.protocol_base.Packet

ack
connect
factory_id
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_encoder.ObjectConnectionState(object_id=0, factory_id=0, object_type=-1, connected=False)

Bases: pycozmo.protocol_base.Packet

ack
connected
factory_id
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
object_id
object_type
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.ObjectMoved(timestamp=0, object_id=0, active_accel_x=0.0, active_accel_y=0.0, active_accel_z=0.0, axis_of_accel=7)

Bases: pycozmo.protocol_base.Packet

ack
active_accel_x
active_accel_y
active_accel_z
axis_of_accel
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
object_id
seq
timestamp
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.ObjectPowerLevel(object_id=0, missed_packets=0, battery_level=0)

Bases: pycozmo.protocol_base.Packet

ack
battery_level
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
missed_packets
object_id
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.ObjectStoppedMoving(timestamp=0, object_id=0)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
object_id
seq
timestamp
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.ObjectTapFiltered(timestamp=0, object_id=0, time=0, intensity=0)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
intensity
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
object_id
seq
time
timestamp
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.ObjectTapped(timestamp=0, object_id=0, num_taps=0, tap_time=0, tap_neg=0, tap_pos=0)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
num_taps
object_id
seq
tap_neg
tap_pos
tap_time
timestamp
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.ObjectType

Bases: enum.Enum

An enumeration.

Block_LIGHTCUBE1 = 1
Block_LIGHTCUBE2 = 2
Block_LIGHTCUBE3 = 3
Block_LIGHTCUBE_GHOST = 4
Bridge_LONG = 10
Bridge_SHORT = 11
Charger_Basic = 13
CliffDetection = 15
CollisionObstacle = 16
CustomFixedObstacle = 37
CustomType00 = 17
CustomType01 = 18
CustomType02 = 19
CustomType03 = 20
CustomType04 = 21
CustomType05 = 22
CustomType06 = 23
CustomType07 = 24
CustomType08 = 25
CustomType09 = 26
CustomType10 = 27
CustomType11 = 28
CustomType12 = 29
CustomType13 = 30
CustomType14 = 31
CustomType15 = 32
CustomType16 = 33
CustomType17 = 34
CustomType18 = 35
CustomType19 = 36
FlatMat_ANKI_LOGO_8BIT = 7
FlatMat_GEARS_4x4 = 5
FlatMat_LAVA_PLAYTEST = 8
FlatMat_LETTERS_4x4 = 6
InvalidObject = -1
Platform_LARGE = 9
ProxObstacle = 14
Ramp_Basic = 12
UnknownObject = 0
class pycozmo.protocol_encoder.ObjectUpAxisChanged(timestamp=0, object_id=0, axis=7)

Bases: pycozmo.protocol_base.Packet

ack
axis
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
object_id
seq
timestamp
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.OutputAudio(samples=())

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
samples
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.OutputSilence

Bases: pycozmo.protocol_base.Packet

ack
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_encoder.PathEventType

Bases: enum.Enum

An enumeration.

PATH_COMPLETED = 2
PATH_INTERRUPTED = 1
PATH_STARTED = 0
class pycozmo.protocol_encoder.PathFollowingEvent(event_id=0, event_type=0)

Bases: pycozmo.protocol_base.Packet

ack
event_id
event_type
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_encoder.PathSegmentSpeed(speed_mmps=0.0, accel_mmps2=0.0, decel_mmps2=0.0)

Bases: pycozmo.protocol_base.Struct

accel_mmps2
decel_mmps2
classmethod from_bytes(buffer)
classmethod from_reader(reader)
speed_mmps
to_bytes()
to_writer(writer)
class pycozmo.protocol_encoder.Ping(time_sent_ms=0.0, counter=0, last=0, unknown=0)

Bases: pycozmo.protocol_base.Packet

ack
counter
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
last
seq
time_sent_ms
to_bytes()
to_writer(writer)
type
unknown
class pycozmo.protocol_encoder.RecordHeading

Bases: pycozmo.protocol_base.Packet

ack
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_encoder.RobotDelocalized

Bases: pycozmo.protocol_base.Packet

ack
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_encoder.RobotPoked

Bases: pycozmo.protocol_base.Packet

ack
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_encoder.RobotState(timestamp=0, pose_frame_id=0, pose_origin_id=0, pose_x=0.0, pose_y=0.0, pose_z=0.0, pose_angle_rad=0.0, pose_pitch_rad=0.0, lwheel_speed_mmps=0.0, rwheel_speed_mmps=0.0, head_angle_rad=0.0, lift_height_mm=0.0, accel_x=0.0, accel_y=0.0, accel_z=0.0, gyro_x=0.0, gyro_y=0.0, gyro_z=0.0, battery_voltage=0.0, status=0, cliff_data_raw=(), backpack_touch_sensor_raw=0, curr_path_segment=0)

Bases: pycozmo.protocol_base.Packet

accel_x
accel_y
accel_z
ack
backpack_touch_sensor_raw
battery_voltage
cliff_data_raw
curr_path_segment
classmethod from_bytes(buffer)
classmethod from_reader(reader)
gyro_x
gyro_y
gyro_z
head_angle_rad
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
lift_height_mm
lwheel_speed_mmps
pose_angle_rad
pose_frame_id
pose_origin_id
pose_pitch_rad
pose_x
pose_y
pose_z
rwheel_speed_mmps
seq
status
timestamp
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.SetAccessoryDiscovery(enable=False)

Bases: pycozmo.protocol_base.Packet

ack
enable
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_encoder.SetCameraParams(gain=0.0, exposure_ms=0, auto_exposure_enabled=False)

Bases: pycozmo.protocol_base.Packet

ack
auto_exposure_enabled
exposure_ms
classmethod from_bytes(buffer)
classmethod from_reader(reader)
gain
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.SetHeadAngle(angle_rad=0.0, max_speed_rad_per_sec=15.0, accel_rad_per_sec2=20.0, duration_sec=0.0, action_id=0)

Bases: pycozmo.protocol_base.Packet

accel_rad_per_sec2
ack
action_id
angle_rad
duration_sec
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
max_speed_rad_per_sec
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.SetHeadLight(enable=False)

Bases: pycozmo.protocol_base.Packet

ack
enable
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_encoder.SetLiftHeight(height_mm=0.0, max_speed_rad_per_sec=3.0, accel_rad_per_sec2=20.0, duration_sec=0.0, action_id=0)

Bases: pycozmo.protocol_base.Packet

accel_rad_per_sec2
ack
action_id
duration_sec
classmethod from_bytes(buffer)
classmethod from_reader(reader)
height_mm
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
max_speed_rad_per_sec
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.SetOrigin(unknown0=0, pose_frame_id=0, pose_origin_id=1, pose_x=0.0, pose_y=0.0, unknown5=2147483648)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
pose_frame_id
pose_origin_id
pose_x
pose_y
seq
to_bytes()
to_writer(writer)
type
unknown0
unknown5
class pycozmo.protocol_encoder.SetRobotVolume(level=0)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
level
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.ShutdownRobot

Bases: pycozmo.protocol_base.Packet

ack
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_encoder.StartAnimation(anim_id=0)

Bases: pycozmo.protocol_base.Packet

ack
anim_id
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_encoder.StartMotorCalibration(head=False, lift=False)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
head
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
lift
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.StopAllMotors

Bases: pycozmo.protocol_base.Packet

ack
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_encoder.StreamObjectAccel(object_id=0, enable=False)

Bases: pycozmo.protocol_base.Packet

ack
enable
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
object_id
seq
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.SyncTime(timestamp=0, unknown=0)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
timestamp
to_bytes()
to_writer(writer)
type
unknown
class pycozmo.protocol_encoder.TrimPath(head=0, tail=0)

Bases: pycozmo.protocol_base.Packet

ack
classmethod from_bytes(buffer)
classmethod from_reader(reader)
head
id
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
tail
to_bytes()
to_writer(writer)
type
class pycozmo.protocol_encoder.TurnInPlace(angle_rad=0.0, speed_rad_per_sec=0.0, accel_rad_per_sec2=0.0, angle_tolerance_rad=0.0, unknown4=0, unknown5=0, is_absolute=False, action_id=0)

Bases: pycozmo.protocol_base.Packet

accel_rad_per_sec2
ack
action_id
angle_rad
angle_tolerance_rad
classmethod from_bytes(buffer)
classmethod from_reader(reader)
id
is_absolute
is_from_engine() → bool
is_from_robot() → bool
is_oob() → bool
seq
speed_rad_per_sec
to_bytes()
to_writer(writer)
type
unknown4
unknown5
class pycozmo.protocol_encoder.TurnInPlaceAtSpeed(wheel_speed_mmps=0.0, wheel_accel_mmps2=0.0, direction=0)

Bases: pycozmo.protocol_base.Packet

ack
direction
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
wheel_accel_mmps2
wheel_speed_mmps
class pycozmo.protocol_encoder.TurnToRecordedHeading

Bases: pycozmo.protocol_base.Packet

ack
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_encoder.UpAxis

Bases: enum.Enum

An enumeration.

NumAxes = 6
UnknownAxis = 7
XNegative = 0
XPositive = 1
YNegative = 2
YPositive = 3
ZNegative = 4
ZPositive = 5
class pycozmo.protocol_encoder.WifiOff(enable=False)

Bases: pycozmo.protocol_base.Packet

ack
enable
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