Back Home
Robokit API Protocol
API
TCP/IP API
Overview
Robot Status API
Robot Control API
Robot Navigation API
Robot Config API
Other API
Robot Push API
Read-only state [1x]
Last updated 2024/05/08
Thanks feedbackHelpful
Thanks feedbackNo help
All doc
Help Center starter guide
Help Center starter guide
FAQ
robot
Product dynamics
Roboshop Pro update notes
Roboshop Pro update notes
Scene topic
Core controller topic
Core controller topic
Intelligent resource base
Intelligent resource base
General knowledge
Robot coordinate system specification
Robot coordinate system specification
PGV QR code description
PGV QR code description
Zebra printer prints QR code instructions
Zebra printer prints QR code instructions
Qr code paste requirements for navigation and secondary positioning
Qr code paste requirements for navigation and secondary positioning
Specification for one dimension code of the tank
Specification for one dimension code of the tank
Material box DM code instructions
Material box DM code instructions
server
laser
Network equipment
【TP-link】TL-CPE1300D
【Moxa】1131a Industrial AP
【Moxa】1131a Industrial AP
【Moxa】1137c Network client configuration
【Moxa】1137c Network client configuration
[Node pass] 2458-3x3-AC Industrial AP
[Node pass] 2458-3x3-AC Industrial AP
Laser installation methods and precautions
Laser installation methods and precautions
2D laser behavior table
2D laser behavior table
Navigation laser
Radium God N301
Furui R2
Sengong -SLS-1F50
Furui H100
Wanji 716
SICK NanoScan3 Laser sensor
SICK NanoScan3 Laser sensor
Robosense Helios 16P Multiline Lidar
Robosense Helios 16P Multiline Lidar
Pepplus Fuku R2000 laser sensor
Pepplus Fuku R2000 laser sensor
Radium 1BS series laser sensor
Radium 1BS series laser sensor
Robosense 16-wire laser sensor
Robosense 16-wire laser sensor
Robosense 32-wire laser sensor
Robosense 32-wire laser sensor
Smart Man laser sensor
Smart Man laser sensor
SICK LMS series laser sensors
SICK LMS series laser sensors
Beiyang UAM laser sensor
Beiyang UAM laser sensor
Cobos S50
driver
Driver behavior table
Driver behavior table
Large and medium driver
Large and medium driver
Tongyi drive
ISMC driver (Pure Hall no encoder)
ISMC driver (Pure Hall no encoder)
Tentai drive
SEW Driver (under test)
SEW Driver (under test)
Morikon
Sing one's voice
Motec
RoboteQ Drive
Wirson -DGT drive
Eston Drive
Makikawa drive
ELMO driver
ZLTECH-ZLAC8030L driver
ZLTECH-ZLAC8030L driver
Qingneng Techon drive
Qingneng Techon drive
Technosoft driver
Copley drive
Nanotec N5 drive
ZAPI driver -ACECOMBIX
ZAPI driver -ACECOMBIX
Code reader camera
3D camera
2D camera
Serial port server
Range sensor
Composite robot terminal device
Composite robot terminal device
Touch screen
Cable encoder
External encoder
battery
charge
Function configuration of the original handle of forklift truck
Function configuration of the original handle of forklift truck
Atmosphere lamp
Mobile robot model
Robokit features documentation
Robokit features documentation
Mobile robot general Knowledge
Mobile robot general Knowledge
Overview of mobile robot
Overview of mobile robot
Chassis type
differential
Single wheel vehicle (steer)
Single wheel vehicle (steer)
multiSteers
Double differential module car (dualDiff)
Double differential module car (dualDiff)
Omnidirectional vehicle (Omni)
Omnidirectional vehicle (Omni)
Two-way rail car (RGV2)
Two-way rail car (RGV2)
Four-way rail car (RGV4)
Four-way rail car (RGV4)
lidar
Single line lidar
Multi-line lidar
camera
RDSCore function document
RDSCore function document
Introduction to dispatching system
Introduction to dispatching system
RDS (Fleet Management System)
RDS (Fleet Management System)
About RDS
Installation and Deployment
Installation and Deployment
Instructions for use
Best Practices
Data Card Configuration Instructions
Data Card Configuration Instructions
Action Completion Callback & Roboshop Configuration Tutorial for Wind Task's Robot Universal Action Block
Action Completion Callback & Roboshop Configuration Tutorial for Wind Task's Robot Universal Action Block
Worksite monitoring configuration tutorial
Worksite monitoring configuration tutorial
Development and Integration
Development and Integration
RDS public interfaces
RDS public interfaces
Overview
Device-related interface
Device-related interface
Work site related interfaces
Work site related interfaces
Modify the status of a single work site
Modify the status of a single work site
Query the list of all work site
Query the list of all work site
Query paging library list
Query paging library list
Set the worksite to be occupied by RDS
Set the worksite to be occupied by RDS
Set the worksite to be occupied by Core
Set the worksite to be occupied by Core
Task mission-related interfaces
Task mission-related interfaces
Statisticians
Statisticians
Robot Status Statistics
Robot Status Statistics
Robot Alarm Statistics
Robot Alarm Statistics
Robot Order Statistics
Robot Order Statistics
Task Status Statistics
Task Status Statistics
Average execution time for Wind tasks
Average execution time for Wind tasks
Query the list of tasks finished by the robot
Query the list of tasks finished by the robot
Task Retention List
Current battery level of the robot
Current battery level of the robot
Trend in battery power used by robots during the day
Trend in battery power used by robots during the day
Robot current status display
Robot current status display
Operator related interfaces
Operator related interfaces
RDS Script Methods
Overview
Task Related
Check task parameters
Check task parameters
Create and run a task asynchronously
Create and run a task asynchronously
Query task instances by task instance ID
Query task instances by task instance ID
Query list of task instances by out order no
Query list of task instances by out order no
Query the list of task instances by robot ID
Query the list of task instances by robot ID
Complete Core order
Checks if the task instance ID exists
Checks if the task instance ID exists
Checks if the task name exists
Checks if the task name exists
Get a list of task instances based on query criteria
Get a list of task instances based on query criteria
Receive and persist third-party system task requests
Receive and persist third-party system task requests
Save task runtime log
Save task runtime log
Termination of assignment
Termination of assignment
Create and run a task
Create and run a task
Robot related
Worksite Related
Check if the location exists
Check if the location exists
Check if the worksite exists
Check if the worksite exists
Check if the group name exists
Check if the group name exists
Get a list of worksite based on conditions
Get a list of worksite based on conditions
Get a valid list of worksite according to conditions
Get a valid list of worksite according to conditions
Get a valid list of worksite according to extended fields
Get a valid list of worksite according to extended fields
Update the worksite information according to the conditions
Update the worksite information according to the conditions
Update the worksite extended field value according to the condition
Update the worksite extended field value according to the condition
Global Cache Param
Operator related
Notify operator(Work Station/Work Type)
Notify operator(Work Station/Work Type)
Notify Operator users
Notify Operator users
Modify the label of the handheld button through menuId
Modify the label of the handheld button through menuId
Modify the background color of handheld buttons through menuId
Modify the background color of handheld buttons through menuId
Set whether the handheld button is disabled through menuId
Set whether the handheld button is disabled through menuId
Multi-threading and time
Multi-threading and time
HTTP requests
sends a PUT request with parameters in JSON format
sends a PUT request with parameters in JSON format
Set Set request header
Set Set request header
Send a POST request with parameters in XML format
Send a POST request with parameters in XML format
sends a POST request with parameters in JSON format
sends a POST request with parameters in JSON format
Send GET request
Register methods（The following methods, which need to be called in the boot() function）
Register methods（The following methods, which need to be called in the boot() function）
Timed execution of script methods (TODO Vigo)
Timed execution of script methods (TODO Vigo)
Registration System Startup Initialization Method
Registration System Startup Initialization Method
Registration button
Register Web Interface Methods
Register Web Interface Methods
Register Event Handler
Register Event Handler
Business Configuration
Business Configuration
Database
Modbus Tcp
Func01 Reading Coils
Func01 Reading Coils
Func02 Read Discrete Inputs
Func02 Read Discrete Inputs
Func03 Read Holding Registers
Func03 Read Holding Registers
Func04 Read Input Registers
Func04 Read Input Registers
Func01 Batch Read Coil Status
Func01 Batch Read Coil Status
Func02 Batch Read Coil Status
Func02 Batch Read Coil Status
Func03 Batch Read Holding Register
Func03 Batch Read Holding Register
Func04 Batch Read Input Registers
Func04 Batch Read Input Registers
Func05 Write Single Coil
Func05 Write Single Coil
Func06 Write Single Holding Register
Func06 Write Single Holding Register
Func0f Batch Write Coils
Func0f Batch Write Coils
Func10 Batch Write Holding Registers
Func10 Batch Write Holding Registers
Modbus Common Write Single Address
Modbus Common Write Single Address
Modbus Common Read Single Address
Modbus Common Read Single Address
Melsec
S7
MQTT
MQTT Subscribe message (using the input topic)
MQTT Subscribe message (using the input topic)
MQTT Subscribe message (using the configuration file's topic)
MQTT Subscribe message (using the configuration file's topic)
MQTT Publish message (using the input topic)
MQTT Publish message (using the input topic)
MQTT Publish message (using the configuration file's topic)
MQTT Publish message (using the configuration file's topic)
Demand Task
Others
RDS Custom Project Tutorial
RDS Custom Project Tutorial
binTask Typical Cases
binTask Typical Cases
Event Configuration
Program upgrades and problem handling
Program upgrades and problem handling
Roboshop Pro User Manual
Roboshop Pro User Manual
Chapter 1: About this manual
Chapter 1: About this manual
Chapter 2: Installation Environment Requirements
Chapter 2: Installation Environment Requirements
Chapter 3: Home Page
Chapter 3: Home Page
Robot
Robot
Connect Robot
Enable editing
Enable editing
Map Edit
Map Edit
Pointer
Eraser
Advanced Line
Advanced area
QR code
External Device
Location
Coordinate transformation
Coordinate transformation
Batch operation
Stitching map
Correction Map
Check the map
Map and Control
Map and Control
Control Robot
2D Build map
3D Display
Environmental Requirements
Environmental Requirements
Recommended Scanning Route
Recommended Scanning Route
Caution
Common problems and solutions
Common problems and solutions
Motion and Control
Motion and Control
Path Navigation
Translation/Rotation (Test Function)
Translation/Rotation (Test Function)
Map Management
Parameter configuration
Parameter configuration
Running Status
IO Configuration
Other
Other
Gyro Zero Calibration
Gyro Zero Calibration
Gyro Zero Calibration
Gyro Zero Calibration
Gyro zero alarm code
What is gyroscope zeroing
What is gyroscope zeroing
Why are these Notices generated
Why are these Notices generated
What will be the impact of Notice
What will be the impact of Notice
Unsuccessful zero calibration of the gyroscope
Unsuccessful zero calibration of the gyroscope
Encoder zeroing
Calibration robot
Calibration robot
Robot status confirmation
Robot status confirmation
Calibration step
Export/Import robot.cp
Export/Import robot.cp
Criteria for evaluating the rationality of calibration data
Criteria for evaluating the rationality of calibration data
Precautions
Audio management
Task Chain
Robot model
Identify files
Module Script
Universal script
Dispatch server
Dispatch server
Introduction to basic operations of RdsCore
Introduction to basic operations of RdsCore
RdsCore gating configuration job guide
RdsCore gating configuration job guide
Vision Server
Charging pile
RTKBase
Advanced Configuration
Advanced Configuration
Chapter 5: Others
Chapter 5: Others
Batch sync files
Batch advanced configuration
Batch advanced configuration
Batch operation robot
Batch operation robot
Log
Scheduling scene editing
Scheduling scene editing
Visual Mark
QR code tool
Log Analyzer
Screen shot
Network Protocol Test Tool
Network Protocol Test Tool
Camera network configuration
Camera network configuration
Programming Firmware
Character Conversion Tool
Character Conversion Tool
Text editor
Appendix A-Property Description
Appendix A-Property Description
Other implementation methods
Other implementation methods
Other implementation methods
Other implementation methods
Implementation Deployment Considerations
Implementation Deployment Considerations
Migrate data to new computer
Migrate data to new computer
View APIs used by Roboshop
View APIs used by Roboshop
How to run exe file in Linux system
How to run exe file in Linux system
Auxiliary programs-Robod
Auxiliary programs-Robod
Common ports
Copyright Notice
Robokit API Protocol
API
TCP/IP API
Overview
API Tutorial
Robot Status API
Robot Information Inquiry
Robot Information Inquiry
Robot Running Information Inquiry
Robot Running Information Inquiry
Robot Location Inquiry
Robot Location Inquiry
Robot Speed Inquiry
Robot Blocked Status Inquiry
Robot Blocked Status Inquiry
Robot Battery Status Inquiry
Robot Battery Status Inquiry
Robot Motor Status Inquiry
Robot Motor Status Inquiry
Robot Laser Status Inquiry
Robot Laser Status Inquiry
Robot Area Status Inquiry
Robot Area Status Inquiry
Robot Estop Status Inquiry
Robot Estop Status Inquiry
Robot I/O Status Inquiry
Robot I/O Status Inquiry
Robot IMU Data Inquiry
Robot IMU Data Inquiry
Robot RFID Data Inquiry
Robot RFID Data Inquiry
Robot Ultrasonic Status Inquiry
Robot Ultrasonic Status Inquiry
Robot PGV Data Inquiry
Robot PGV Data Inquiry
Robot Encoder Status Inquiry
Robot Encoder Status Inquiry
Robot Navigation Status Inquiry
Robot Navigation Status Inquiry
Robot Task Status Package Inquiry
Robot Task Status Package Inquiry
Robot Localization Status Inquiry
Robot Localization Status Inquiry
Robot Map Loading Status Inquiry
Robot Map Loading Status Inquiry
Robot SLAM Status Inquiry
Robot SLAM Status Inquiry
Robot Jacking Status Inquiry
Robot Jacking Status Inquiry
Robot fork status inquiry
Robot fork status inquiry
Robot Roller Status Inquiry
Robot Roller Status Inquiry
Robot Dispatching Status Inquiry
Robot Dispatching Status Inquiry
Robot Alarm Status Inquiry
Robot Alarm Status Inquiry
Batch Data Inquiry 1
Batch Data Inquiry 2
Batch Data Inquiry 3
Robot Current Lock Inquiry
Robot Current Lock Inquiry
Loaded Map and Stored Map Inquiry
Loaded Map and Stored Map Inquiry
Status Station Information of Current Map Inquiry
Status Station Information of Current Map Inquiry
Map MD5 Inquiry
Robot Parameters Inquiry
Robot Parameters Inquiry
Download the Robot Model File
Download the Robot Model File
Download the Robot File
Download the Robot File
Driver Params Inquiry
Driver Params Inquiry
Transparent Data Inquiry
Transparent Data Inquiry
GNSS Connection Status Inquiry
GNSS Connection Status Inquiry
List of GNSS Devices Inquiry
List of GNSS Devices Inquiry
Robot Sound Status Inquiry
Robot Sound Status Inquiry
Robot Control API
Robot Navigation API
Path Navigation
Path Navigation 2 (aborted)
Path Navigation 2 (aborted)
Designated Path Navigation
Designated Path Navigation
Translation
Rotation
Circular Motion
Pallet Rotation
Pause Navigation
Resume Navigation
Cancel Navigation
Query Task Chain
Execute Pre-Stored Tasks
Execute Pre-Stored Tasks
Get Navigation Path
Clear Designated Path Navigation
Clear Designated Path Navigation
Robot Config API
Load Map to Robot
Release Control
Configure Ultrasonic
SRC Control Mode
SRC Monitor Mode
Set Third-Party Warning
Set Third-Party Warning
Set Robot Params Temporarily
Set Robot Params Temporarily
Set Third-Party Error
Set Third-Party Error
Set Shelf Description File
Set Shelf Description File
Set GNSS to Rover mode
Set GNSS to Rover mode
Set GNSS Baudrate
Set Driver Params
Set Robot Params Permanently
Set Robot Params Permanently
Reset GNSS Configuration
Reset GNSS Configuration
Require control
Remove Dynamic Obstacles
Remove Dynamic Obstacles
Delete Map in Robot
Restore Robot Params
Release Control (aborted)
Release Control (aborted)
Configure Robot Push Port
Configure Robot Push Port
Motor Clear Fault
Motor Calibration
Upload the Model File to Robot
Upload the Model File to Robot
Preempt Control
Pull Map from Robot
Configure DI
Clear Third-Party Warning
Clear Third-Party Warning
Clear Third-Party Error
Clear Third-Party Error
Clear Robot's All Errors
Clear Robot's All Errors
Reset Running Info
Clear Shelf Description File
Clear Shelf Description File
Add Dynamic Obstacles (Robot Coordinate System)
Add Dynamic Obstacles (Robot Coordinate System)
Add Dynamic Obstacles (World Coordinate System)
Add Dynamic Obstacles (World Coordinate System)
Other API
Write Peripheral User-Defined Data
Write Peripheral User-Defined Data
Update transparent data
Update transparent data
Stop Fork Motion
Stop Audio
Soft Estop
Begin SLAM
Set Virtual DI
Set Relay
Batch Set DO
Set DO
Set Charging Relay
Motor Enabling and Disabling
Motor Enabling and Disabling
Set Fork Height
Set Fork Forward or Backward
Set Fork Forward or Backward
Bind Goods to Containers
Bind Goods to Containers
Roller Stop
Roller Right Unload
Roller Right Roll
Roller Right Pre-Load
Roller Right Pre-Load
Roller right load
Roller Left Unload
Roller Left Roll
Roller Inverse Left and Right
Roller Inverse Left and Right
Roller Left Pre-Load
Roller left load
Roller Front Unload
Roller Front Roll
Roller Front Pre-Load
Roller Front Pre-Load
Roller Front Load
Roller Inverse Front and Back
Roller Inverse Front and Back
Roller Back Unload
Roller Back Roll
Roller Back Pre-Load
Roller Back Load
Resume Audio
Reset Cargo
Play Audio
Pause Audio
Jacking Unload
Jacking Stop
Jacking Height
Jacking Load
Hook Unload
Hook Load
End SLAM
Unbind designate goods
Unbind designate goods
Unbind Goods from Designated Containers
Unbind Goods from Designated Containers
Unbind Goods from all Containers
Unbind Goods from all Containers
Get Audio File List
Robot Push API
Implementation of Dispatching-System
Implementation of Dispatching-System
Help Center
Thanks feedbackThanks feedback
Build your own AMR fleet within days
WhatsApp：+86-18321029192·
E-mail：contact@seer-group.com·
Address：Building 11, 2777 East Jinxiu Road, Pudong New District, Shanghai, China·
English Change
Social Media
