Skip to main content

Data Structures

1 xCoreSDK Error Code ErrorCode​

int value                               # Error code value
String^ message # Error message

2 Robot basic information, loaded after connecting Info​

String^ id                              # Robot uid, can be used to distinguish connected robots
String^ mac # Mac address
String^ version # Controller version
String^ type # Robot model name
Int32 joint_num # Number of axes

3 Coordinate frame Frame​

array<double>^ trans                    # Translation [X, Y, Z], unit: meters
array<double>^ rpy # Euler angles [Rx, Ry, Rz], unit: radians

4 Cartesian point CartesianPosition​

double elbow                            # Elbow angle, for 7-axis robots, unit: radians
List<int>^ confData # Axis configuration data, [cf1, cf2, cf3, cf4, cf5, cf6, cf7, cfx]
List<double>^ external # External joint values, unit: radians|meters. Rail unit is meters

Offset CartesianPosition::Offset:

Offset.Type type                        # Offset type: none | offs relative to workpiece frame | relTool relative to tool frame
Frame^ frame # Offset relative to the specified tool/workpiece frame

5 Joint point JointPosition​

List<double>^ joints                    # Joint angles, unit: radians
List<double>^ external # External joint values, unit: radians|meters. Rail unit is meters

6 Non-real-time motion command MoveCommand​

CartesianPosition^ cartTarget           # Target Cartesian point
JointPosition^ jointTarget # Target joint point
CartesianPosition^ auxPoint # Auxiliary point
CartesianPosition::Offset^ cartTargetOffset # Cartesian target offset option
CartesianPosition::Offset^ auxPointOffset # Auxiliary point offset option
double speed # Maximum end linear speed, unit mm/s. See setDefaultSpeed
double jointSpeed # Joint speed percentage for joint commands, range [0, 1]. Effective when >= 0; when < 0, the joint speed calculated from speed is used
double rotSpeed # Spatial rotation speed for end commands, unit rad/s. Effective when >= 0; when < 0, rotation speed defaults to 200°/s
double zone # Blending zone radius, unit mm. See setDefaultZone
String^ customInfo # Custom information, returned in motion feedback
List<double>^ args # Other parameters. MoveCF length 2: full-circle angle [rad]; rotation type 0 fixed orientation | 1 moving-axis | 2 fixed-axis. MoveSP length 4: initial radius [m]; radius change per radian [m/rad]; total angle [rad]; direction 1 clockwise | 0 counterclockwise. MoveWait length 1: dwell time [s], minimum 1 ms

7 Load Load​

double mass                             # Load mass, unit: kg
array<double>^ cog # Center of mass [x, y, z], unit: meters
array<double>^ inertia # Inertia [ix, iy, iz], unit: kg·m²

8 State list StateList​

array<double>^ joint_pos                            # Joint angles, unit radians
CartesianPosition^ cart_pos # Cartesian pose
array<Tuple<String^, Boolean>^>^ digital_signals # Digital IO names and values
array<Tuple<String^, Double>^>^ analog_signals # Analog IO names and values
OperateMode operation_mode # Operation mode
double speed_override # Speed override ratio

9 Tool/workpiece set, computed from a tool and workpiece pair Toolset​

Load^ load                              # Load held at the robot end
Frame^ end # End frame relative to the flange frame
Frame^ reference # Reference frame relative to the world frame

Does not explicitly distinguish handheld and external. If the tool is handheld, the load and end frame come from the tool and the reference frame from the workpiece; if the workpiece is handheld, the load and end frame come from the workpiece and the reference frame from the tool.

10 Frame calibration result FrameCalibrationResult​

Frame^ frame                            # Calibrated frame
array<double>^ errors # Deviation of sample points from the TCP value: minimum, average, maximum, unit m

11 Controller log LogInfo​

const int id                            # Log ID
String^ timestamp # Date and time
String^ content # Log content
String^ repair # Repair method

12 RL project information RLProjectInfo​

String^ name                            # Project name
List<String^>^ taskList # Task name list

13 Tool/workpiece information. The workpiece frame is already transformed relative to its user frame WorkToolInfo​

String^ name                            # Name
Frame^ frame # Coordinate system
Load^ load # Load information
bool isHeld # true - Handheld | false - External

14 CAN Frame CANFrame​

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

15 Single-Group CAN Send/Receive Parameters CANRwItem​

int can_id                           CAN frame ID
int can_format Frame format (see CANFormat)
int can_type Frame type (see CANType)
int send_len Number of bytes to send. The wrapper calculates it from the length of send_data, so callers can leave this field unset.
int rev_frames_per 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.
array<Byte>^ send_data Raw bytes to send

16 CAN Send/Receive Request CANRwParam​

int interval_ms                      Interval between send/receive groups in ms. Use 0 for no wait.
List<CANRwItem^>^ rw_frames Send/receive sequence