Locations & Maps

Retrieve data about a robot's operating environment, including maps, floors, annotations, and navigable destinations.

---

GetCurrentMap

Retrieves the current map used by the robot.

The returned map includes annotations and destinations, which can be used in mission destination, localization goals, and navigation.

Request

robot_id string required

The robot ID used to request the map currently loaded on the robot.

JSON Request Example

JSON

  {
    "robot_id": "pennybot-abc123"
  }

Response

map Map

Map represents a navigable map used by robots, including metadata and associated annotations.

Field	Message Type	Description
map_id	string	Unique identifier for the map. Example: "9578"
created_time	Timestamp	Indicating when the map was created.
modified_time	Timestamp	Indicating the last time the map was modified.
display_name	string	Display name of the map, matching the name used in Bear Universe. Example: "ITCT SEOUL"
annotation	Annotation	Annotation associated with this map, defining specific areas and destinations.

Annotation

Annotation defines a specific area on the map, often used to group destinations or assign special parameters.

Field	Message Type	Description
annotation_id	string	Unique identifier for the annotation. Example: "67305"
display_name	string	Descriptive name for the annotation. Example: "ITCT annotation A"
created_time	Timestamp	Timestamp indicating when the annotation was created.
destinations	map<string, Destination> See Destination	A collection of destinations associated with this annotation. Each entry pairs a destination ID (key) with its corresponding Destination message (value).

Destination

Destination represents a single point of interest on the map that a robot can navigate to and align itself with.

Field	Message Type	Description
destination_id	string	Unique identifier for the destination.
display_name	string	Human-readable name for the destination.

JSON Response Example

JSON

   {
    "mapId": "map-01",
    "createdTime": "2025-03-28T12:00:00Z",
    "modifiedTime": "2025-04-01T09:45:00Z",
    "displayName": "Main Floor Map",
    "annotation": {
      "annotationId": "annot-123",
      "displayName": "Service Area Zones",
      "createdTime": "2025-03-30T10:15:00Z",
      "destinations": {
        "Loading Dock 1": {
          // destinationId and displayName are the same values. 
          "destinationId": "Loading Dock 1",
          "displayName": "Loading Dock 1"
        },
        "Main Kitchen": {
          "destinationId": "Main Kitchen",
          "displayName": "Main Kitchen"
        }
      }
    }
  }

Errors

ErrorCode	Description
NOT_FOUND	The annotation (of the requested map) does not exist.