Skip to content

External Axis Settings


1. Positioner Coordinate Calibration Calculation Settings

Command ID: 0x7001 SYNCPOSITIONER_CALIBRATION_SET

Description: Positioner coordinate calibration calculation settings, send the following command

Send:

json
{
  "calibrateNum": 1
}

Parameter Description:

ParameterTypeRequiredDescription
calibrateNumintYesPositioner group number, available values: 1, 2, 3

Controller Return:

Command ID: 0x7004 SYNCPOSITIONER_CALIBRATION_RESULT

json
{
  "result": true
}
ParameterTypeDescription
resultboolWhether external axis data calculation succeeded

2. Calibration Point Coordinates

Command ID: 0x7002 SYNCPOSITIONER_CALIBRATION_INQUIRE

Description: Calibration point coordinates, send the following command

Send:

json
{
  "syncPositionerNum": 1,
  "pointNum": 0
}

Parameter Description:

ParameterTypeRequiredDescription
syncPositionerNumintYesPositioner group number, available values: 1, 2, 3
pointNumintYesValue range: 0~3 or 5

Controller Response:

Command ID: 0x7003 SYNCPOSITIONER_CALIBRATION_RESPOND

json
{
  "syncPositionerNum": 1,
  "pointNum": 0,
  "pos": [0, 0, 0, 0, 0, 0]
}

Parameter Description:

ParameterTypeDescription
syncPositionerNumintPositioner group number, available values: 1, 2, 3
pointNumintValue range: 0~3 or 5
posarrayCurrent point position

3. Query Calibration Results of All External Axes

Command ID: 0x7005 SYNCPOSITIONER_TYPEANDCALIBRATIONRESULT_INQUIRE

Description: Query calibration results of all external axes

Send:

json
{
  "robot": 1
}

Parameter Description:

ParameterTypeRequiredDescription
robotintYesRobot number

Return External Axis Calibration Results:

Command ID: 0x7006 SYNCPOSITIONER_TYPEANDCALIBRATIONRESULT_RESPOND

json
{
  "robot": 1,
  "calibrateResult": [false, false, true],
  "syncType": [1, 1, 1]
}

Parameter Description:

ParameterTypeDescription
robotintRobot number
calibrateResultarrayWhether calibrated, array indicates whether each external axis group is calibrated
syncTypearraySync type

4. Calibration Result Query

Command ID: 0x7007 SYNCPOSITIONER_COORD_INQUIRE

Description: Calibration result query (teach pendant does not have this function)

Send:

json
{
  "syncPositionerNum": 1,
  "coordNum": 0
}

Parameter Description:

ParameterTypeRequiredDescription
syncPositionerNumintYesPositioner group number
coordNumintYesGet calibration result

Response:

Command ID: 0x7008 SYNCPOSITIONER_COORD_RESPOND

json
{
  "syncPositionerNum": 1,
  "coordNum": 1,
  "pos": [0, 0, 0, 0, 0, 0]
}

Parameter Description:

ParameterTypeDescription
syncPositionerNumintPositioner group number
coordNumintCalibration result number
posarrayCurrent point position

5. Set Current Collaborative External Axis Group Number

Command ID: 0x7009 SYNCPOSITIONER_COORDNUM_SWITCH

Description: Set current collaborative external axis group number

Send:

json
{
  "curSyncPositionerNum": 3
}

Parameter Description:

ParameterTypeRequiredDescription
curSyncPositionerNumintYesCurrent collaborative external axis group number

Query Current Collaborative External Axis Group Number:

Command ID: 0x700A SYNCPOSITIONER_COORDNUM_INQUIRE

Description: No need to send data

Controller Response:

Command ID: 0x700B SYNCPOSITIONER_COORDNUM_RESPOND

json
{
  "curSyncPositionerNum": 2
}

Parameter Description:

ParameterTypeDescription
curSyncPositionerNumintCurrent collaborative external axis group number

6. Set Ground Track Parameters

Command ID: 0x700D SYNCTRACK_SET

Description: Set ground track parameters, teach pendant sends the following command

Send:

json
{
  "calibrateResult": true,
  "xConversionRatio": 1.0,
  "yConversionRatio": 1.0,
  "zConversionRatio": 1.0
}

Parameter Description:

ParameterTypeRequiredDescription
calibrateResultboolYesWhether collaborative
xConversionRatiofloatYesX direction conversion ratio
yConversionRatiofloatYesY direction conversion ratio
zConversionRatiofloatYesZ direction conversion ratio

Query:

Command ID: 0x700E SYNCTRACK_INQUIRE

Controller Response:

Command ID: 0x700F SYNCTRACK_RESPOND

json
{
  "calibrateResult": true,
  "xConversionRatio": 1.0,
  "yConversionRatio": 1.0,
  "zConversionRatio": 1.0
}

7. Current Position Query

Command ID: 0x7012 SYNC_POS_INQUIRE

Description: External axis settings interface, teach pendant sends the following command

Send:

json
{
  "robot": 1,
  "coord": 0
}

Parameter Description:

ParameterTypeRequiredDescription
robotintYesRobot number
coordintYesCoordinate mode
- -1: Controller current coordinate
- 0: Joint coordinate
- 1: Cartesian coordinate
- 2: Tool coordinate
- 3: User coordinate

Controller Response:

Command ID: 0x7013 SYNC_POS_RESPOND

Description: Reset point settings interface, controller sends when receiving current position query

json
{
  "robot": 1,
  "coord": 0,
  "configuration": 1,
  "pos": [0, 0.1, 2, 3.3, 44, 555.55, 66.6, 77.77],
  "posDeg": [0, 0.1, 2, 3.3, 44, 555.55, 66.6, 77.77],
  "posSync": [0, 0.1, 2, 3.3, 44, 555.55, 66.6, 77.77]
}

Parameter Description:

ParameterTypeDescription
robotintRobot number
coordintCoordinate mode
- -1: Controller current coordinate
- 0: Joint coordinate
- 1: Cartesian coordinate
- 2: Tool coordinate
- 3: User coordinate
configurationintPosture or left/right hand
posarrayCurrent position (radian)
posDegarrayCurrent position (degree)
posSyncarrayExternal axis current position

8. Dual-Robot Collaboration Enable

Set Dual-Robot Collaboration Enable Command:

Command ID: 0x7015 COOPERATIVE_SET

json
{
  "cooperativeRobot": 0
}

Parameter Description:

ParameterTypeRequiredDescription
cooperativeRobotintYesCollaboration setting
- 0: No collaboration
- 1: Collaboration

Get Collaboration Status:

Command ID: 0x7016 COOPERATIVE_INQUIRE

Response Collaboration Status:

Command ID: 0x7017 COOPERATIVE_RESPOND

json
{
  "cooperativeRobot": 0
}

Parameter Description:

ParameterTypeDescription
cooperativeRobotintCollaboration status
- 0: No collaboration
- 1: Collaboration

9. External Axis Joint Parameter Settings

Command ID: 0x7021 JOINTPARAMETER_SYNCPOSITIONER_SET

Description: External axis joint parameter settings

Single-Axis Positioner

json
{
  "Joint": [
    {
      "BackLash": 0.0,
      "DeRatedVel": -30000.0,
      "Direction": 1.0,
      "EncoderResolution": 17.0,
      "MaxAcc": 1.0,
      "MaxDeRotSpeed": -1.0,
      "MaxDecel": -1.0,
      "MaxRotSpeed": 1.0,
      "maxJerkAcc": 1.0,
      "maxJerkDec": -1.0,
      "NegSWLimit": -360.0,
      "PosSWLimit": 720.0,
      "RatedDeRotSpeed": -5000.0,
      "RatedRotSpeed": 5000.0,
      "RatedVel": 30000.0,
      "ReducRatio": 1.0,
      "syncAxisNum": 1,
      "syncGroupNum": 1
    }
  ],
  "syncGroupNum": 1
}

Dual-Axis Positioner

json
{
  "Joint": [
    {
      "BackLash": 0.0,
      "DeRatedVel": -18000.0,
      "Direction": 1.0,
      "EncoderResolution": 17.0,
      "MaxAcc": 1.0,
      "MaxDeRotSpeed": -1.0,
      "MaxDecel": -1.0,
      "MaxRotSpeed": 1.0,
      "NegSWLimit": -100.0,
      "PosSWLimit": 100.0,
      "RatedDeRotSpeed": -3000.0,
      "RatedRotSpeed": 3000.0,
      "RatedVel": 18000.0,
      "ReducRatio": 1.0,
      "maxJerkAcc": 1.0,
      "maxJerkDec": -1.0,
      "syncAxisNum": 1,
      "syncGroupNum": 2
    },
    {
      "BackLash": 0.0,
      "DeRatedVel": -12000.0,
      "Direction": -1.0,
      "EncoderResolution": 17.0,
      "MaxAcc": 1.0,
      "MaxDeRotSpeed": -1.0,
      "MaxDecel": -1.0,
      "MaxRotSpeed": 1.0,
      "NegSWLimit": -80.0,
      "PosSWLimit": 80.0,
      "RatedDeRotSpeed": -2000.0,
      "RatedRotSpeed": 2000.0,
      "RatedVel": 12000.0,
      "ReducRatio": 1.0,
      "maxJerkAcc": 1.0,
      "maxJerkDec": -1.0,
      "syncAxisNum": 2,
      "syncGroupNum": 2
    }
  ],
  "syncGroupNum": 2
}

Joint Parameter Description:

ParameterTypeDescription
BackLashfloatGear backlash
DeRatedVelfloatRated negative speed
DirectionfloatForward/reverse: 1.0 means forward
EncoderResolutionfloatEncoder resolution (bit count)
MaxAccfloatMaximum acceleration
MaxDeRotSpeedfloatMaximum reverse rotation speed
MaxDecelfloatMaximum deceleration
MaxRotSpeedfloatMaximum forward rotation speed
maxJerkAccfloatMaximum jerk acceleration
maxJerkDecfloatMaximum jerk deceleration
NegSWLimitfloatNegative limit angle
PosSWLimitfloatPositive limit angle
RatedDeRotSpeedfloatRated reverse rotation speed
RatedRotSpeedfloatRated forward rotation speed
RatedVelfloatRated speed
ReducRatiofloatJoint reduction ratio
syncAxisNumintAxis number
syncGroupNumintSync group number

Root Level Parameter Description:

ParameterTypeDescription
syncGroupNumintSync group number

Query Joint Parameters:

Command ID: 0x7022 JOINTPARAMETER_SYNCPOSITIONER_INQUIRE

json
{
  "syncGroupNum": 1
}

Parameter Description:

ParameterTypeRequiredDescription
syncGroupNumintYesSync group number

Joint Parameter Return:

Command ID: 0x7023 JOINTPARAMETER_SYNCPOSITIONER_RESPOND

Description: Same as 0x7021


10. External Axis Jog Joint Speed Settings

Command ID: 0x7024 JOG_JOINTPARAMETER_SYNCPOSITIONER_SET

Description: External axis jog joint speed settings

Single-Axis Positioner

json
{
  "syncGroupNum": 1,
  "syncJog": [
    {
      "MaxAcc": 800.0,
      "MaxSpeed": 40.0
    }
  ]
}

Dual-Axis Positioner

json
{
  "syncGroupNum": 2,
  "syncJog": [
    {"MaxAcc": 400.0, "MaxSpeed": 20.0},
    {"MaxAcc": 800.0, "MaxSpeed": 40.0}
  ]
}

Parameter Description:

ParameterTypeDescription
syncGroupNumintExternal axis group number
syncJog[].MaxAccfloatMaximum acceleration (°/s)
syncJog[].MaxSpeedfloatMaximum speed (°/s)

Query External Axis Jog Joint Speed:

Command ID: 0x7025 JOG_JOINTPARAMETER_SYNCPOSITIONER_INQUIRE

json
{
  "syncGroupNum": 1
}

Parameter Description:

ParameterTypeRequiredDescription
syncGroupNumintYesExternal axis group number

External Axis Jog Joint Speed Parameter Return:

Command ID: 0x7026 JOG_JOINTPARAMETER_SYNCPOSITIONER_RESPOND

Description: Same as 0x7024


11. Encoder Multi-Turn Overflow Count Function

Command ID: 0x7027 SYNCENCODE_OVERFLOW_PARM_SET

Send:

json
{
  "robot": 1,
  "syncAxis": [
    {
      "encode": [
        {
          "encoderRange": 0,
          "encoderType": 0,
          "max": "0.0",
          "min": "0.0"
        }
      ]
    }
  ],
  "syncGroupNum": 1
}

Parameter Description:

ParameterTypeRequiredDescription
robotintYesRobot number
syncGroupNumintYesSync group number
syncAxis[].encodearrayYesEncoder related settings
syncAxis[].encode[].encoderRangeintYesEncoder range setting
syncAxis[].encode[].encoderTypeintYesMulti-turn value type
syncAxis[].encode[].maxstringYesMaximum value measured by encoder
syncAxis[].encode[].minstringYesMinimum value measured by encoder

Query:

Command ID: 0x7028 SYNCENCODE_OVERFLOW_PARM_INQUIRE

json
{
  "robot": 1,
  "syncGroupNum": 1
}

Parameter Description:

ParameterTypeRequiredDescription
robotintYesRobot number
syncGroupNumintYesExternal axis group number

Return:

Command ID: 0x7029 SYNCENCODE_OVERFLOW_PARM_RESPOND

Description: Same as 0x7027, where encode includes an additional encoderResolution parameter returning encoder bit count


12. Encoder Multi-Turn Value Switch Communication Protocol

Command ID: 0x7030 SYNCENCODE_OVERFLOW_ENABLE_PARM_SET

Send:

json
{
  "robot": 1,
  "syncAxis": [
    {
      "enable": 1
    }
  ],
  "syncGroupNum": 1
}

Parameter Description:

ParameterTypeRequiredDescription
robotintYesRobot number
syncGroupNumintYesExternal axis group number
syncAxis[].enableintYesEncoder multi-turn overflow count function switch

13. External Axis Zero Point Parameter Settings

Command ID: 0x7031 SYNCPOSITIONER_ENCODER_RESET

Send:

json
{
  "axis": 1,
  "clearEncoder": false
}

Parameter Description:

ParameterTypeRequiredDescription
axisintYesExternal axis number
- 0: All external axes
- 1: External axis 1
- 2: External axis 2
clearEncoderboolYesClear encoder
- true: Clear multi-turn value
- false: Mark zero point

Controller Response After Zero Point Set Successfully:

Command ID: 0x7033 SYNCPOSITIONER_ENCODER_RESET_RESPOND

json
{
  "axis": 1
}

Parameter Description:

ParameterTypeDescription
axisintExternal axis number
- 0: All external axes
- 1: External axis 1
- 2: External axis 2

14. External Axis Zero Offset

Command ID: 0x7034 SYNCPOSITIONER_ENCODER_ZERO_OFFSET_SET

Description: Teach pendant does not have this function

Send:

json
{
  "robot": 1,
  "axis": 0,
  "allValue": [0.1, 0.2, 0.3, 0.4, 0.5, 0.6]
}

Parameter Description:

ParameterTypeRequiredDescription
robotintYesRobot number
axisintYesExternal axis number
- 0: All external axes
- 1: External axis 1
- 2: External axis 2
allValuearrayYesValues are placed in the corresponding array positions

15. Single-Turn Value Setting

Command ID: 0x7035 SYNCPOSITIONER_SINGLE_ENCODER_RESET

Send:

json
{
  "robot": 1,
  "allValue": [1, 2, 3, 4, 5]
}

Parameter Description:

ParameterTypeRequiredDescription
robotintYesRobot number
allValuearrayYesValues are placed in the corresponding array positions

Query External Axis Single-Turn Value:

Command ID: 0x7036 SYNCPOSITIONER_SINGLE_ENCODER_INQUIRE

json
{
  "robot": 1
}

Parameter Description:

ParameterTypeRequiredDescription
robotintYesRobot number

Controller Response:

Command ID: 0x7037 SYNCPOSITIONER_SINGLE_ENCODER_RESPOND

json
{
  "robot": 1,
  "allValue": [0.1, 0.2, 0.3, 0.4, 0.5, 0.6]
}

Parameter Description:

ParameterTypeDescription
robotintRobot number
allValuearraySingle-turn value, array elements correspond to each axis

16. External Axis Calibration Result Settings

Command ID: 0x7041 SYNCPOSITIONER_CALIBRATION_RESULT_SET

Description: Teach pendant does not have this function

Send:

json
{
  "syncPositionerNum": 1,
  "resultArray": [
    [0, 0, 0, 0, 0, 0],
    [0, 0, 0, 0, 0, 0],
    [0, 0, 0, 0, 0, 0]
  ]
}

Parameter Description:

ParameterTypeRequiredDescription
syncPositionerNumintYesExternal axis group number
resultArrayarrayYesCalibration result array

External Axis Calibration Result Query:

Command ID: 0x7042 SYNCPOSITIONER_CALIBRATION_RESULT_INQUIRE

json
{
  "syncPositionerNum": 1
}

Parameter Description:

ParameterTypeRequiredDescription
syncPositionerNumintYesExternal axis group number

External Axis Calibration Result Return:

Command ID: 0x7043 SYNCPOSITIONER_CALIBRATION_RESULT_RESPOND

json
{
  "calibrateResult": true,
  "resultArray": [
    [524.340205626059, -82.982822853146, 643.197959948330, -3.141346895452, 0.0, 2.382157019678]
  ],
  "syncPositionerNum": 1
}

Parameter Description:

ParameterTypeDescription
calibrateResultboolWhether calibrated
resultArrayarrayCalibration result array
syncPositionerNumintExternal axis group number