xarm_move_step

1. Introduction

Button: [Live Control] - X+ / X- / Y+ / Y- / Z+ / Z-

long-press: keep moving in a certain direction until the button is released.

short-press: move a step in a certain direction.

2. Request & Response

Message

{
    "cmd": "xarm_move_step",
    "data": {
        "isLoop": true,
        "direction": "joint-angle-increase",
        "isMoveTool": true,
        "acc": 500,
        "axis": 3
    },
    "id": "1"
}

Request

Name	Type	Required fields	Description
isloop	bool	Yes	whether a long press or not
direction	String	Yes	Direction of movement： 'position-x-increase’;'position-x-decrease’; ’position-y-increase’;’position-y-decrease’; ’position-z-increase’;’position-z-decrease’; ’attitude-roll-increase’;'attitude-roll-decrease'; ’attitude-pitch-increase’;'attitude-pitch-decrease'; 'attitude-yaw-increase';'attitude-yaw-decrease'; Change of Joint angle:'joint-angle-increase';'joint-angle-decrease'; Aligning the Hand(xArm5 only): 'set-end-level' ;
isMoveTool	bool	Yes	whether use Tool Coordinate or not(Base Coordinate by default)
isSetInitialPoint	bool	No	Not Used

Response

code=0->success;
code!=0->Failed, refer to xarm_api_code

3. Code Example

background

if direction == 'position-x-increase' or direction == 'position-x-decrease':
    self._xarm_sync_tcp(0)
    x = GLOBAL.XArm.xarm_position_step if direction == 'position-x-increase' else -GLOBAL.XArm.xarm_position_step
    if isMoveTool:
        code = GLOBAL.XArm.xarm.set_tool_position(x=x, speed=tcp_speed)
    else:
        code = GLOBAL.XArm.xarm.set_position(x=x, relative=True, speed=tcp_speed)

front_end

moveStep(direction, isLoop) {
      window.CommandsRobotSocket.moveStep({ 'direction': direction, 'isLoop': isLoop, 'isMoveTool': this.isToolCoord });
},

moveStep = (data, callback) => {
  const params = window.GlobalConstant.INIT_CMD_PARAMS_COMMON_DATA();
  Object.assign(params.data, data);
  Object.assign(params.data, {
    mode: self.model.robot.state.info.xarm_mode,
  });
  self.sendCmd(window.GlobalConstant.MOVE_STEP_START, params, (dict) => {
    if (callback) {
      callback(dict);
    }
  });
}