Autoxing REST API Book
  • English
  • zh-CN
GitHub
  • English
  • zh-CN
GitHub
  • Guide

    • Getting Started
    • Start Moving
    • Getting Started with WebSockets
    • Robot Admin (Standalone Version)
  • Reference

    • REST API Principles
    • Map API
    • Move API
    • Current Map and Pose API
    • Overlays
    • Mapping API
    • IoT Devices
    • Device Information API
    • Robot Parameters API
    • System Settings
    • App Store API
    • Hostname API
    • Landmarks
    • Submaps
  • Services

    • Service API
    • Motion & Chassis Control
    • Localization
    • Mapping
    • Cargo Handling
    • Perception & Sensors
    • Calibration
    • Network
    • System & Maintenance
  • WebSocket

    • WebSocket Reference
    • Localization
    • Mapping
    • Navigation & Planning
    • Chassis & Safety
    • Cargo & Equipment
    • Perception & Cameras
    • Environment & Connectivity
    • System & Power
  • Other

    • Deprecations
    • Changelog

Cargo Handling

Operate the jack, roller, towing hook, and cargo-loading mechanisms.

Jack Device Up, Down, Self-Check

Raise or lower the jack device. The state of the jack device is available via the WebSocket Jack State.

curl -X POST \
  -H "Content-Type: application/json" \
  http://192.168.25.25:8090/services/jack_up
curl -X POST \
  -H "Content-Type: application/json" \
  http://192.168.25.25:8090/services/jack_down
curl -X POST \
  -H "Content-Type: application/json" \
  http://192.168.25.25:8090/services/jack_self_check

Clear Jack Errors

The jack device will report an error if it becomes overloaded.

When this occurs, most jack models can still accept new commands. However, some rare models require errors to be cleared manually before they will accept further commands.

curl -X POST http://192.168.25.25:8090/services/clear_jack_errors

Load/Unload Cargo with Roller

Since 2.9.0.

The state of the roller is available via the WebSocket Roller State.

curl -X POST \
  -H "Content-Type: application/json" \
  http://192.168.25.25:8090/services/roller_load
curl -X POST \
  -H "Content-Type: application/json" \
  http://192.168.25.25:8090/services/roller_unload

Load/Unload Cargo

Triggers loading or unloading of cargo via the robot's cargo handling mechanism.

curl -X POST \
  -H "Content-Type: application/json" \
  http://192.168.25.25:8090/services/load_cargo
curl -X POST \
  -H "Content-Type: application/json" \
  http://192.168.25.25:8090/services/unload_cargo

Towing Hook Lock

Locks the towing hook to secure an attached trailer.

curl -X POST \
  -H "Content-Type: application/json" \
  http://192.168.25.25:8090/services/towing_hook_lock

Towing Hook Release

Releases the towing hook to detach an attached trailer.

curl -X POST \
  -H "Content-Type: application/json" \
  http://192.168.25.25:8090/services/towing_hook_release

Clear Towing Hook Error

Clears an error reported by the towing hook device.

curl -X POST \
  -H "Content-Type: application/json" \
  http://192.168.25.25:8090/services/clear_towing_hook_error

Start Rack Size Detection

curl -X POST \
  -H "Content-Type: application/json" \
  http://192.168.25.25:8090/services/start_rack_size_detection

curl -X POST \
  -H "Content-Type: application/json" \
  http://192.168.25.25:8090/services/stop_rack_size_detection

Detect the width and depth of a rack using the robot's laser scanner.

Warning

It is generally more accurate to refer to the rack's technical specifications or measure it manually with a ruler. Use this service only as a last resort.

Steps to use:

  1. Position the robot directly in front of the rack.
  2. Call /start_rack_size_detection.
  3. Subscribe to the /detected_rack WebSocket topic.
  4. Slowly push the robot under the rack.
  5. Once successfully detected, stop pushing and record the rack dimensions.
  6. Enter the width and depth into the system settings.
Edit this page
Last Updated: 10/30/26, 7:15 PM
Contributors: FengZhaolin
Prev
Mapping
Next
Perception & Sensors