Skip to main content
This page lists the HTTP endpoints provided by the V2 visual localization module. Replace the IP placeholder in each address with the module IP address. Unless an endpoint states otherwise, code: 200 and message: success indicate that the request was processed successfully.
Updating software, deploying or switching maps, restarting the program, and rebooting the camera interrupt localization. Call these endpoints only while the vehicle is stopped and recovery is available.

​
Program and device information

​
Update the main program

Address: http://<ip>:9998/tool/rob/quiet_update
​
string
required
Reachable URL of the main-program upgrade package.

​
Set camera height

Address: http://<ip>:9998/tool/rob/setHeightRequest
​
number
required
Camera height.

​
Get program version

Address: http://<ip>:9998/tool/rob/getRobotVersion This endpoint requires no request parameters.
​
integer
required
Response status code.
​
string
Program version, such as version 12313 .

​
Get vehicle information

Address: http://<ip>:9998/tool/rob/getVehicle This endpoint requires no request parameters.
​
object
required
Vehicle information object.
​
string
Vehicle UUID.
​
string
Current map.
​
string
Vehicle type.

​
Get the current pose

Address: http://<ip>:9998/tool/rob/getAGVPose This endpoint requires no request parameters.
​
object
required
Current pose.
​
number
X coordinate.
​
number
Y coordinate.
​
number
Heading angle.

​
Relocate

Address: http://<ip>:9998/tool/rob/relocate Request header: Content-Type: application/json
​
number
required
X coordinate in meters.
​
number
required
Y coordinate in meters.
​
number
required
Pose angle.
​
number
required
X-axis noise in meters.
​
number
required
Y-axis noise in meters.
​
number
required
Angular noise.

​
Map management

​
Download the current running map package

Address: http://<ip>:9998/tool/rob/getRunMapZip Request header: Content-Type: application/json
​
string
required
Map name.
The response is a ZIP file with content type application/zip.

​
Deploy a map

Address: http://<ip>:9998/tool/rob/deployRunMap
​
string
required
Map name.

​
Apply a map

Address: http://<ip>:9998/tool/rob/changeCurrentRunMap
​
string
required
Map name.

​
Start mapping

Address: http://<ip>:9998/tool/rob/startMapping
​
string
required
Map name.

​
Stop mapping

Address: http://<ip>:9998/tool/rob/stopMapping This endpoint requires no request parameters.

​
Start or stop incremental mapping

Address: http://<ip>:9998/tool/rob/sendCMD

​
Get the map list

Use the local map-list endpoint: http://<ip>:9998/tool/rob/getRunMapLists This endpoint requires no request parameters. The response run_maps is an array of map names.
The backend map-list endpoint http://<ip>:9998/tool/editor/getLocalMaps is deprecated and not recommended.

​
Upload a map package to the camera

Address: http://<ip>:9998/tool/rob/uploadMapZip2RunMaps
​
string
required
Reachable URL of the map package.

​
Download a map

Address: http://<ip>:9998/tool/rob/downloadVisiomWithLaserMap
​
string
required
Reachable URL of the map package.

​
Maintenance endpoints

​
Restart the camera program

Address: http://<ip>:9998/tool/rob/restart This endpoint requires no request parameters.

​
Reboot the camera

Address: http://<ip>:9998/tool/rob/Reboot This endpoint requires no request parameters.