Returns all available localization data for a robot

Returns all available localization data for a robot, including pose and lasers if available. If an include query param is sent, only those values are returned.

GET /robots/{robotId}/localization/full

Returns all available localization data for a robot

cURL

curl --request GET \
  --url https://api.inorbit.ai/robots/{robotId}/localization/full \
  --header 'x-auth-inorbit-app-key: <api-key>'

200

{
  "pose": {
    "mapId": "<string>",
    "mapDataHash": "<string>",
    "x": 123,
    "y": 123,
    "theta": 123,
    "ts": 123,
    "xPixels": 123,
    "yPixels": 123
  },
  "lasers": [
    {
      "id": "<string>",
      "runs": [
        123
      ],
      "values": [
        123
      ],
      "ts": 123
    }
  ],
  "paths": [
    {
      "id": "<string>",
      "points": [
        {
          "x": 123,
          "y": 123
        }
      ],
      "ts": 123
    }
  ],
  "costmap": {
    "ts": 123
  }
}

Authorizations

x-auth-inorbit-app-key · string · header · required

InOrbit appKey authenticates API requests using a token.

You can obtain your appKey in the Authentication docs.

Path Parameters

robotId · string · required

The robot's id

Query Parameters

include · enum<string>[]

Data to be included in the response. If not set, all available data is returned.

Available options: pose, laser, costmap, paths

Response

200 - application/json

The current localization data of a robot

pose · object

Robot position and orientation

Show child attributes

lasers · object[]

Show child attributes

paths · object[]

Show child attributes

costmap · object

TBD

Show child attributes