Skip to content

Control Robot Motion

Send movement, turning, and posture commands to a specified robot.

  • Name: Robot motion control
  • Description: Moves a robot forward, backward, left, or right, or turns it.
  • Method: POST
  • Path: remoteApi/controlDog
  • Login required: No
  • Permission required: Yes

Note: The robot must be in remote-control mode. Sending a road-network target is strongly recommended.


  • dogCode · String · Required

    Robot code
    Example: 001

  • type · Integer · Required

    Control type: 1 switch between remote-control and task modes; 2 body movement
    Example: 2

  • command · Integer · Required

    Command
    Example: 2

  • value · String · Required

    Command value or step size
    Example: 0.5

  • speed · Integer · Optional

    Speed; defaults to 1. For a Lynx M20, this value may be increased for lateral movement and turning. Use the default value of 1 for an X30.
    Example: 1

Command meanings:

Shared parameters: type = 1, command = 6; speed is not applicable.

valueDescription
1Switch to task mode
2Switch to remote-control mode

Shared parameter: type = 2. See the request parameters above for value and speed.

commandDescription
1Move forward
2Move backward
11Move left (recommended value: 0.5)
12Move right (recommended value: 0.5)
3Turn left (recommended value: 0.35)
4Turn right (recommended value: 0.35)
15Crouch
16Stand Up
{
"dogCode": "001",
"type": 2,
"command": 1,
"value": 1,
"speed": 1
}
FieldTypeExampleDescription
codeInteger200Status code
successBooleantrueWhether the request succeeded
msgStringsuccessResponse message
{
"success": true,
"code": 200,
"msg": "success",
"data": null
}
CodeDescription
400Invalid parameters
401Unauthorized
403Access denied
404Resource not found
500Internal server error