Skip to content

List Robot Maps

List maps and map-file information for a specified robot with pagination.

  • Name: List robot maps
  • Description: Returns the maps associated with quadruped robots.
  • Method: POST
  • Path: remoteApi/mapList
  • Login required: No
  • Permission required: Yes

ParameterTypeRequiredExampleDescription
dogCodeStringNo123Robot code
floorStringNoFloor
{
"floor": "A1",
"dogCode": "DOG2011258510273380352"
}

Complete request example (the same rule applies to the other public HTTP endpoints):

Add the signature parameters timestamp, nonce, sign, and appKey to the business parameters. secretKey participates in signature generation and may be omitted from the actual request.

{
"floor": "A1",
"dogCode": "DOG2011258510273380352",
"secretKey": "kQwIOrYvnXmSDkwEiFngrKidMcdrgKor",
"timestamp": "1770601919986",
"nonce": "0erlgu8db6vuv6dA1RMT2xrwfKU6bNgu",
"sign": "078550748A747823209C55BF8C87410F",
"appKey": "123"
}
Field / TypeDescription and Example
floor
String
Floor code (unique floor identifier)
Example: a002
dogCode
String
Associated quadruped robot code
Example: 2
mapFileName
String
Map file name or path
Example: jueying_20250922162308649
twoDMapInfo
String
2D map coordinate bounds
Example: -1217,-2827;820,1002
twoDMapBmpPath
String
2D map image path; see the field examples below.

twoDMapBmpPath

/mapInfo/showMapPic/jueying_20250922162308649.jpg
{
"success": true,
"code": 200,
"msg": "Operation succeeded",
"data": [
{
"floor": "A1",
"dogCode": "DOG2011258510273380352",
"mapFileName": "orgin_20260114100648249.png",
"twoDMapInfo": "-3008,-467;223,1050",
"twoDMapBmpPath": "/mapInfo/showMapPic/orgin_20260114100648249.png"
}
]
}

Notes:

  1. mapFileName is the map file name or path. Use Download a resource to retrieve the actual map image by file name.
  2. The four values in twoDMapInfo are, in order, the minimum absolute x-coordinate, maximum absolute x-coordinate, minimum absolute y-coordinate, and maximum absolute y-coordinate of the map. Absolute coordinates represent the physical location of each point at the site.
  3. To render a road network on the map image, convert the absolute coordinates of its edges, nodes, and docks to coordinates relative to the map image origin.

Use the top-left corner of the map image as the origin to convert physical absolute coordinates to coordinates relative to the image:

normalized x = ((absolute x - minimum absolute map x) / (maximum absolute map x - minimum absolute map x)) * image width;
normalized y = ((maximum absolute map y - absolute y) / (maximum absolute map y - minimum absolute map y)) * image height;

Get road networks returns absolute coordinates. Apply the formulas above and render the result on the map image retrieved through Download a resource.

{
"dogCode": "DOG2011258510273380352",
"edgeCode": "A1_3",
"edgeStartNode": "A1_2",
"edgeEndNode": "A1_1",
"startCoordinate": "-151.144200,15.114400,0.000000",
"endCoordinate": "156.789000,6.782200,0.000000",
"controlPoint1": "-48.499800,12.337000,0.000000",
"controlPoint2": "54.144600,9.559600,0.000000",
"floor": "A1",
"moveDisable": true
}

edgeStartNode and edgeEndNode identify the start and end nodes of an edge. startCoordinate and endCoordinate contain their corresponding absolute coordinates.

The following image shows a road network rendered over the map:

Road network rendered on a robot map

// Normalize map coordinates. Convert the physical coordinates of road-network edges, nodes, and docks to coordinates relative to the map image origin. This example uses the top-left corner as the map origin.
// x and y are physical coordinates.
normalizeCoordinate(x, y)
{
const canvasWidth = = this.stage.width(); // Width of the map image.
const canvasHeight = this.stage.height(); // Height of the map image.
const normalizedX =
((x - this.minPos.x) / (this.maxPos.x - this.minPos.x)) * canvasWidth; // Normalized x-coordinate.
const normalizedY =
((this.maxPos.y - y) / (this.maxPos.y - this.minPos.y)) * canvasHeight; // Normalized y-coordinate.
return [normalizedX, normalizedY];
} // minPos.x is the first item in twoDMapInfo, maxPos.x the second, minPos.y the third, and maxPos.y the fourth.
CodeDescription
400Invalid parameters
401Unauthorized
403Access denied
404Resource not found
500Internal server error