piper_kit.messages.transmit.EnableJointMessage

class documentation

class EnableJointMessage(TransmitMessage):

Constructor: EnableJointMessage(joint_id, enable)

View In Hierarchy

Message to enable or disable individual joints or all joints.

Method __init__ Create joint enable/disable message.
Constant ID Undocumented
Constant MAX_JOINT_ID Undocumented
Constant MIN_JOINT_ID Undocumented
Type Alias JointId Undocumented
def __init__(self, joint_id: JointId, *, enable: bool = True):
overrides piper_kit.messages.transmit.TransmitMessage.__init__

Create joint enable/disable message.

Parameters
joint_id:JointIdJoint ID (1-6 for individual joints, 7 for all joints)
enable:boolTrue to enable, False to disable
Raises
InvalidJointIdErrorIf joint_id is not in range 1-7
ID: int =

Undocumented

Value
1137
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]