Skip to main content

Types

1 Robot Operation State OperationState​

StateDescription
idleRobot idle
jogJog state (not moving)
rtControllingReal-time mode controlling
dragDrag enabled
rlProgramRL project running
demoDemo demonstration
dynamicIdentifyDynamics identification
frictionIdentifyFriction identification
loadIdentifyLoad identification
movingRobot moving
joggingJog moving
unknownUnknown

2 Robot Type WorkType​

TypeDescription
industrialIndustrial robot
collaborativeCollaborative robot

3 Robot Operation Mode OperateMode​

ModeDescription
manualManual
automaticAutomatic
unknownUnknown (exception occurred)

4 Robot Power On/Off and E-Stop State PowerState​

StateDescription
onPower on
offPower off
estopEmergency stop pressed
gstopSafety door open
unknownUnknown (exception occurred)

5 Pose Coordinate Type CoordinateType​

TypeDescription
flangeInBaseFlange relative to base frame
endInRefEnd relative to external frame

6 Motion Control Mode MotionControlMode​

ModeDescription
IdleIdle
NrtCommandNon-real-time mode executing motion commands
NrtRLTaskNon-real-time mode running RL project
RtCommandReal-time mode control

7 Controller Real-time Control Mode RtControllerMode​

ModeDescription
jointPositionReal-time joint space position control
cartesianPositionReal-time Cartesian space position control
jointImpedanceReal-time joint space impedance control
cartesianImpedanceReal-time Cartesian space impedance control
torqueReal-time torque control

8 Robot Stop Motion Level StopLevel​

LevelDescription
stop0Quick stop robot motion then power off
stop1Planned stop robot motion then power off, stop on original path
stop2Planned stop robot motion without power off, stop on original path
suppleStopCompliant stop, only applicable to collaborative models

9 Robot Drag Mode Parameter DragParameter​

ParameterDescription
DragParameterSpace::jointSpaceJoint space drag
DragParameterSpace::cartesianSpaceCartesian space drag
DragParameterType::translationOnlyTranslation only
DragParameterType::rotationOnlyRotation only
DragParameterType::freelyFree drag

10 Frame Type FrameType​

TypeDescription
worldWorld frame
baseBase frame
flangeFlange frame
toolTool frame
wobjWorkpiece frame
pathPath frame, force control task frame needs to track trajectory changes
railRail base frame

11 Jog Option - Coordinate System JogOptSpace​

TypeDescription
worldWorld frame
flangeFlange frame
baseFrameBase frame
toolFrameTool frame
wobjFrameWorkpiece frame
jointSpaceJoint space
singularityAvoidModeSingularity avoidance mode for industrial 6-axis, xMateCR and xMateSR. The avoidance method is locking axis 4
baseParallelModeBase parallel mode, for industrial 6-axis models, xMateCR/SR 6-axis models, and CR5-axis models

12 Singularity Avoidance Method AvoidSingularityMethod​

MethodDescription
lockAxis4Lock 4th axis
wristSacrifice orientation
jointWayJoint space short trajectory interpolation

13 MoveCF Full Circle Orientation Rotation Type MoveCFCommandRotType​

TypeDescription
constPoseConstant pose
rotAxisMoving axis rotation
fixedAxisFixed axis rotation

14 xPanel Configuration: External Power Supply Mode xPanelOptVout​

ModeDescription
offNo output
reserveReserved
supply12vOutput 12V
supply24vOutput 24V

15 Torque Type TorqueType​

TypeDescription
fullJoint torque, calculated by dynamics model
inertiaInertia force
coriolisCoriolis force
frictionFriction force
gravityGravity

16 Event Type Event​

TypeDescription
moveExecutionNon-real-time motion command execution info
safetySafety (collision or not)
rlExecutionRL execution status

17 Event Info Keys EventInfoKey​

Dictionary keys returned by queryEventInfo / setEventWatcher.

SubmoduleFieldMeaning
MoveExecutionIDPath ID, the command ID passed to moveAppend, string
MoveExecutionReachTargetWhether the path reached the target, bool
MoveExecutionWaypointIndexIndex of the current path target, starting at 0, int
MoveExecutionErrorError before or during motion command execution
MoveExecutionRemarkOther execution info; currently includes a warning that the target is too close, string
MoveExecutionCustomInfoUser info, corresponding to NrtCommand.customInfo
SafetyCollidedWhether a collision occurred
RlExecutionTaskNameName of the executing task, string
RlExecutionLookaheadLineLookahead line number, int
RlExecutionLookaheadFileLookahead file name, string
RlExecutionExecuteLineExecution line number, int
RlExecutionExecuteFileFile currently executing, string
LogReporterEcodeController log error code
LogReporterEdetailController log error detail

18 Controller Log Level LogInfoLevel​

Used as level of queryControllerLog.

LevelDescription
infoNotice
warningWarning
errorError

19 Cartesian Position Offset Type CartesianPositionOffsetType​

TypeDescription
noneNo offset
offsOffset relative to the workpiece frame
relToolOffset relative to the tool frame

Defined in xCoreSDK_python.model. Cartesian quantities and the Jacobian on xmateModel use it to select a link. The default is flange.

ValueDescription
joint1 … joint7Joint 1 through joint 7
flangeFlange
endEffectorEnd effector
stiffnessStiffness frame

21 xPanel Communication Option Enums​

Python binds flat enum classes (corresponding to C++ xPanelCommOpt), used by xPanelRS485Init / xPanelCANInit:

Enum classDescription
xPanelCommOptRs485BaudRS485 baud. AR models: 4800/9600/19200/38400/57600/115200/2500000;
other models: 9600/19200/38400/57600/115200/230400/460800/1000000/2000000
xPanelCommOptCheckBitnone / odd / even
xPanelCommOptStopBitstopbit1 / stopbit2
xPanelCommOptCanArbitrationBaudb1M(1 Mbps) / b500k / b250k / b125k
xPanelCommOptCanDataBaudb5M(5 Mbps) / b4M / b2M / b1M

22 CAN Frame Format CANFormat​

Used by CANFrame.frame_format.

TypeDescription
CANFormat.STANDARDStandard frame
CANFormat.EXTENDEDExtended frame

23 CAN Frame Type CANType​

Used by CANFrame.frame_type.

TypeDescription
CANType.CANFD_ACCELERATEDCANFD accelerated
CANType.CANFDCANFD
CANType.CANClassic CAN