PiPER Kit API Documentation Modules Classes Names
Clear Help

For more information on the search, visit the help page.

Class Hierarchy

  • can.Message
    • piper_kit.messages.transmit.TransmitMessage - Base class for CAN messages sent to the PiPER robotic arm.
      • piper_kit.messages.transmit.EnableJointMessage - Message to enable or disable individual joints or all joints.
      • piper_kit.messages.transmit.EndPoseControlRyMessage - Message for controlling roll and yaw rotations of end-effector pose.
      • piper_kit.messages.transmit.EndPoseControlXyMessage - Message for controlling X and Y positions of end-effector pose.
      • piper_kit.messages.transmit.EndPoseControlZpMessage - Message for controlling Z position and pitch rotation of end-effector pose.
      • piper_kit.messages.transmit.GripperControlMessage - CAN message for controlling gripper position and effort.
      • piper_kit.messages.transmit.JointConfigMessage - Message to configure individual joints or all joints.
      • piper_kit.messages.transmit.JointControl12Message - Joint control message for joints 1 and 2.
      • piper_kit.messages.transmit.JointControl34Message - Joint control message for joints 3 and 4.
      • piper_kit.messages.transmit.JointControl56Message - Joint control message for joints 5 and 6.
      • piper_kit.messages.transmit.MotionControlBMessage - Message to configure motion control parameters for the robotic arm.
  • cursers.Thread
    • piper_kit._commands.teleop.follow.FollowerThread - Undocumented
  • cursers.ThreadedApp
    • piper_kit._commands.teleop.end_pose.TeleopEndPoseApp - Undocumented
    • piper_kit._commands.teleop.follow.TeleopFollowApp - Undocumented
    • piper_kit._commands.teleop.joint.TeleopJointApp - Undocumented
  • piper_kit.messages.receive.GripperFeedbackMessage.GripperStatus - Gripper status information parsed from status byte.
  • piper_kit.messages.receive.MotorInfoBMessage.DriverStatus - Driver status information parsed from status byte.
  • piper_kit.messages.receive.ReceiveMessage - Base class for CAN messages received from the PiPER robotic arm.
    • piper_kit.messages.receive.GripperFeedbackMessage - CAN message containing gripper position and status feedback.
    • piper_kit.messages.receive.JointFeedback12Message - Joint feedback message for joints 1 and 2.
    • piper_kit.messages.receive.JointFeedback34Message - Joint feedback message for joints 3 and 4.
    • piper_kit.messages.receive.JointFeedback56Message - Joint feedback message for joints 5 and 6.
    • piper_kit.messages.receive.MotorInfoBMessage - Motor information message containing status and diagnostic data.
    • piper_kit.messages.receive.UnknownMessage - Container for unrecognized CAN messages.
  • piper_kit.Piper - Interface for controlling the AgileX PiPER robotic arm via CAN bus.
  • ValueError
    • piper_kit.errors.InvalidControlModeError - Raised when an invalid control mode is provided.
    • piper_kit.errors.InvalidGripperEffortError - Raised when an invalid gripper effort is provided.
    • piper_kit.errors.InvalidJointIdError - Raised when an invalid joint ID is provided.
    • piper_kit.errors.InvalidMoveModeError - Raised when an invalid move mode is provided.
    • piper_kit.errors.InvalidMoveSpeedRateError - Raised when an invalid move speed rate is provided.

API Documentation for PiPER Kit, generated by pydoctor 25.4.0 at 2025-07-11 11:17:26.