Skip to main content

Robot Map Widget

Widget Type: rc-robot-map

Robot Map

Renders a robot map (the topology of nodes and edges produced by the robot) on top of the base map. Three modes select where the map comes from:

  • fixed — A map stored in the cloud platform, identified by mapId.
  • dynamic — A map streamed from the robot. The initial snapshot is fetched once, then incremental changes are streamed via telemetry.
  • static — A static map fetched once from the robot via service call.

Configuration​

All modes share the environment config (Mapbox token, Google Maps API key, optional origin and tiles URL) plus:

parentFrame (optional) Frame in which the map's nodes are interpreted.

mode Required. fixed, dynamic, or static.

mapId Required for fixed. The map ID stored in the cloud platform. Optional for static.

source Required for dynamic and static. The robot-side source URI (e.g. /map/dynamicMaps/spot).

Example (dynamic)​

{
  "mapBoxToken": "<your-mapbox-token>",
  "googleMapsApiKey": "<your-google-maps-key>",
  "mode": "dynamic",
  "source": "/map/dynamicMaps/spot"
}

Example (static)​

{
  "mapBoxToken": "<your-mapbox-token>",
  "googleMapsApiKey": "<your-google-maps-key>",
  "mode": "static",
  "mapId": "hello-world"
}

Example (fixed)​

{
  "mapBoxToken": "<your-mapbox-token>",
  "googleMapsApiKey": "<your-google-maps-key>",
  "mode": "fixed",
  "mapId": "hello-world"
}