/navigation — Server REST API

Request Body

Field	Type	Description
`robot_name`	string	Robot asset name in the scene
`goal_x`	int	—
`goal_y`	int	—
`goal_theta`	int	—
`sync`	bool	Wait for completion when true

Response200 OK

Field	Type	Description
`success`	bool	Whether the call succeeded
`msg`	string	Status or error message
`data`	null	Payload; shape depends on the endpoint

{
  "robot_name": "r",
  "goal_x": 2,
  "goal_y": 1,
  "goal_theta": 0,
  "sync": true
}

{
  "success": true,
  "msg": "Navigation complete",
  "data": null
}

Request Body

Field	Type	Description
`robot_name`	string	Robot asset name in the scene

Response200 OK

Field	Type	Description
`success`	bool	Whether the call succeeded
`msg`	string	Status or error message
`data`	object	Payload; shape depends on the endpoint

{
  "robot_name": "r"
}

{
  "success": true,
  "msg": "ok",
  "data": {
    "linear": 0.3,
    "angular": 0.1
  }
}

Request Body

Response200 OK

Field	Type	Description
`success`	bool	Whether the call succeeded
`msg`	string	Status or error message
`data`	null	Payload; shape depends on the endpoint

{
  "robot_name": "r",
  "linear": 0.5,
  "angular": 0
}

{
  "success": true,
  "msg": "ok",
  "data": null
}

Request Body

Field	Type	Description
`robot_name`	string	Robot asset name in the scene

Response200 OK

Field	Type	Description
`success`	bool	Whether the call succeeded
`msg`	string	Status or error message
`data`	null	Payload; shape depends on the endpoint

{
  "robot_name": "r"
}

{
  "success": true,
  "msg": "ok",
  "data": null
}

Request Body

Response200 OK

Field	Type	Description
`success`	bool	Whether the call succeeded
`msg`	string	Status or error message
`data`	bool	Payload; shape depends on the endpoint

{
  "robot_name": "r",
  "pos_tolerance": 0.05,
  "angle_tolerance": 0.1
}

{
  "success": true,
  "msg": "ok",
  "data": true
}

Request Body

Field	Type	Description
`robot_name`	string	Robot asset name in the scene

Response200 OK

Field	Type	Description
`success`	bool	Whether the call succeeded
`msg`	string	Status or error message
`data`	bool	Payload; shape depends on the endpoint

{
  "robot_name": "r"
}

{
  "success": true,
  "msg": "ok",
  "data": false
}

Request Body

Field	Type	Description
`robot_name`	string	Robot asset name in the scene
`source`	string	—

Response200 OK

Field	Type	Description
`success`	bool	Whether the call succeeded
`msg`	string	Status or error message
`data`	null	Payload; shape depends on the endpoint

{
  "robot_name": "r",
  "source": "scene"
}

{
  "success": true,
  "msg": "ok",
  "data": null
}

Request Body

Field	Type	Description
`robot_name`	string	Robot asset name in the scene

Response200 OK

{
  "robot_name": "r"
}

{ "success": true, "msg": "ok", "data": [{"x": 0, "y": 0, "theta": 0}, ...] }