piper_kit.messages.transmit.JointConfigMessage

class documentation

class JointConfigMessage(TransmitMessage):

Constructor: JointConfigMessage(joint_id, set_zero, clear_error)

View In Hierarchy

Message to configure individual joints or all joints.

Method __init__ Create joint config message.
Constant ID Undocumented
Constant MAX_JOINT_ID Undocumented
Constant MIN_JOINT_ID Undocumented
Type Alias JointId Undocumented
def __init__(self, joint_id: JointId, *, set_zero: bool = False, clear_error: bool = False):
overrides piper_kit.messages.transmit.TransmitMessage.__init__

Create joint config message.

Parameters
joint_id:JointIdJoint ID (1-6 for individual joints, 7 for all joints)
set_zero:boolWhether to set the current joint position as the zero position
clear_error:boolWhether to clear the current joint error codes
Raises
InvalidJointIdErrorIf joint_id is not in range 1-7
ID: int =

Undocumented

Value
1141
MAX_JOINT_ID: int =

Undocumented

Value
7
MIN_JOINT_ID: int =

Undocumented

Value
1
JointId =

Undocumented

Value
Literal[1, 2, 3, 4, 5, 6, 7]