Skip to main content

Data Structures

1 Robot Basic Info Info​

str id         # Robot uid, can be used to distinguish connected robots
str mac # MAC address
str version # Controller version
str type # Robot model name
int joint_num # Number of axes

2 Frame Frame​

list[float] trans       # Translation, [X, Y, Z], unit: meter
list[float] rpy # XYZ Euler angles, [A, B, C], unit: radian
list[float] pos # Row-major homogeneous transformation matrix.

3 Cartesian Position CartesianPosition​

Inherits Finishable.

list[float] trans         # Translation, [x, y, z], unit: meter
list[float] rpy # XYZ Euler angles, [A, B, C], unit: radian
float elbow # Elbow angle, applicable to 7-axis robots, unit: radian
bool hasElbow # Whether has elbow angle
list[float] confData # Axis configuration data, number of elements should match robot axes
list[float] external # External joint values, unit: radian|meter. Rail unit is meter

4 Cartesian Position Offset CartesianPositionOffset​

CartesianPositionOffsetType type    # none: no offset; offs: workpiece frame; relTool: tool frame
Frame frame # Frame offset (should be Frame type object)

5 Joint Position JointPosition​

Inherits Finishable.

list[float] joints        # Joint angle values, unit: radian
list[float] external # External joint values, unit: radian|meter. Rail unit is meter

6 Joint Torque, Excluding Gravity and Friction Torque​

Inherits Finishable.

list[float] tau           # Desired joint torque, unit: Nm

7 Load Info Load​

float mass                # Load mass, unit: kilogram
list[float] cog # Center of gravity [x, y, z], unit: meter
list[float] inertia # Inertia [ix, iy, iz], unit: kilogram·square meter

8 Tool Workpiece Set Info Toolset​

Calculated based on a pair of tool workpiece coordinates, load, and robot handheld settings.

Load load                 # Robot end handheld load
Frame end # Robot end frame relative to flange frame transformation
Frame ref # Robot reference frame relative to world frame transformation

9 Frame Calibration Result FrameCalibrationResult​

Frame frame                # Calibration result (Frame type object)
list[float] errors # Deviation between sample points and TCP calibration value,依次为 minimum, average, maximum, unit m

10 RL Project Info RLProjectInfo​

str name                  # Project name
list[str] taskList # Task name list

11 Tool/Workpiece Info WorkToolInfo​

str name                  # Name
str alias # Description
bool robotHeld # Whether robot handheld
Frame pos # Pose. Workpiece frame has been transformed relative to its user frame (Frame type object)
Load load # Load (Load type object)

12 Motion Command MoveAbsJ MoveAbsJCommand​

JointPosition target      # Target joint position (JointPosition type object)
int speed # End linear velocity, unit mm/s, joint velocity is divided into several intervals based on end linear velocity size, see setDefaultSpeed() for details
float jointSpeed # Joint speed ratio, range [0, 1]. Takes effect when >= 0; when < 0, the joint speed derived from speed is used
int zone # Zone size, unit mm
str customInfo # Custom info, can be returned in motion info feedback

13 Motion Command MoveJ MoveJCommand​

CartesianPosition target        # Target Cartesian position (CartesianPosition type object)
int speed # End linear velocity, unit mm/s, joint velocity is divided into several intervals based on end linear velocity size, see setDefaultSpeed() for details
float jointSpeed # Joint speed ratio, range [0, 1]. Takes effect when >= 0; when < 0, the joint speed derived from speed is used
int zone # Zone size, unit mm
CartesianPositionOffset offset # Offset (CartesianPositionOffset type object)
str customInfo # Custom info, can be returned in motion info feedback

14 Motion Command MoveL MoveLCommand​

CartesianPosition target            # Target Cartesian position (CartesianPosition type object)
int speed # End linear velocity, unit mm/s
float rotSpeed # Spatial rotation speed, unit rad/s. Takes effect when >= 0; defaults to 200°/s when < 0
int zone # Zone size, unit mm
CartesianPositionOffset offset # Offset (CartesianPositionOffset type object)
str customInfo # Custom info, can be returned in motion info feedback

15 Motion Command MoveC MoveCCommand​

CartesianPosition target                    # Target Cartesian position (CartesianPosition type object)
CartesianPosition aux # Auxiliary position (CartesianPosition type object)
int speed # End linear velocity, unit mm/s
float rotSpeed # Spatial rotation speed, unit rad/s. Takes effect when >= 0; defaults to 200°/s when < 0
int zone # Zone size, unit mm
CartesianPositionOffset targetOffset # Target point offset (CartesianPositionOffset type object)
CartesianPositionOffset auxOffset # Auxiliary point offset (CartesianPositionOffset type object)
str customInfo # Custom info, can be returned in motion info feedback

16 Motion Command MoveCF MoveCFCommand​

target and aux are constructor arguments only; they are not exposed as attributes. rotSpeed and point offsets are not bound either. Accessible fields (speed, zone, and customInfo are inherited from NrtCommand):

float speed                                 # Max end linear velocity, unit mm/s
int zone # Zone radius, unit mm
str customInfo # Custom info, returned in motion feedback
float angle # Full circle execution angle, unit: radian
MoveCFCommandRotType rotType # Full circle orientation rotation mode

17 Motion Command MoveSP MoveSPCommand​

CartesianPosition target                    # End Cartesian position; only rpy is used to set the end orientation (CartesianPosition type object)
CartesianPositionOffset targetOffset # Offset option (CartesianPositionOffset type object)
float radius # Initial radius, unit: meter
float radius_step # Radius change per unit angle, unit: meter/radian
float angle # Total rotation angle, unit: radian
bool direction # Rotation direction, true - clockwise | false - anticlockwise
str customInfo # Custom info, can be returned in motion info feedback

18 Motion Wait Command MoveWaitCommand​

float duration_           # Wait duration, minimum effective duration 1ms

19 Controller Log Info LogInfo​

int id                    # Log ID number
str timestamp # Date and time
str content # Log content
str repair # Repair method

20 End Keypad State KeyPadState​

bool key1_state           # CR1 number
bool key2_state # CR2 number
bool key3_state # CR3 number
bool key4_state # CR4 number
bool key5_state # CR5 number
bool key6_state # CR6 number
bool key7_state # CR7 number

21 CAN Frame CANFrame​

int frame_id              # Frame ID
int frame_format # Frame format (see CANFormat)
int frame_type # Frame type (see CANType)
list[int] data # CAN data (interpreted by data_type as uint8/int16/uint16)
int frame_valid_length # Valid length (element count; must equal len(data))

22 Single-Group CAN Send/Receive Parameters CANRwItem​

can_id: int                  CAN frame ID
can_format: int Frame format (see CANFormat)
can_type: int Frame type (see CANType)
send_len: int Number of bytes to send, must equal len(send_data)
rev_frames_per: int Expected receive frame count. Each group sends one frame and expects one frame if this value is 1, or multiple frames if it is greater than 1.
send_data: list[int] Raw bytes to send

23 CAN Send/Receive Request CANRwParam​

interval_ms: int             Interval between send/receive groups in ms. Use 0 for no wait.
rw_frames: list[CANRwItem] Send/receive sequence