Skip to content

Enums

Reference for all enum types used in the ACS API.

TaskType

Defines the action type for a task.

Value Name Description
0 TASK_TYPE_UNKNOWN Unknown or unspecified task type.
1 TASK_TYPE_MOVE O0 — Move to a specified location.
2 TASK_TYPE_LOAD O1 — Load task with docking (e.g., picking up materials).
3 TASK_TYPE_UNLOAD O2 — Unload task with docking (e.g., delivering materials).
4 TASK_TYPE_CHARGE O3 — Move to charging station for recharging.
5 TASK_TYPE_DOCK O5 — Docking task, typically used with roller-type AGVs.
6 TASK_TYPE_DIRECT_LOAD O12 — Direct load without docking.
7 TASK_TYPE_DIRECT_UNLOAD O13 — Direct unload without docking.
8 TASK_TYPE_ORIGIN O250 — Origin task; AGV stays at home/origin position.
9 TASK_TYPE_USER_CONFIRM E1 — Wait for user confirmation (e.g., manual release).
10 TASK_TYPE_SYSTEM_CONFIRM E2 — Wait for upper system confirmation (e.g., dynamic reassignment). Use FinishTaskChain to complete.

TaskChainStatus

Represents the lifecycle state of a task chain.

Value Name Description
0 TASK_CHAIN_STATUS_UNKNOWN Unknown or unspecified status.
1 TASK_CHAIN_STATUS_PENDING Task chain has not started.
2 TASK_CHAIN_STATUS_IN_PROGRESS A subtask is currently being executed.
3 TASK_CHAIN_STATUS_SUBTASK_COMPLETED The current subtask was completed.
4 TASK_CHAIN_STATUS_CANCELLED The task chain was cancelled.
5 TASK_CHAIN_STATUS_SUBTASK_ERROR A subtask failed or encountered an error.
6 TASK_CHAIN_STATUS_SKIPPED The task chain was skipped (not executed).
7 TASK_CHAIN_STATUS_CHAIN_ERROR The task chain failed completely.
8 TASK_CHAIN_STATUS_CHAIN_COMPLETED The entire task chain was completed successfully.

TaskStatus

Represents the lifecycle state of an individual subtask within a task chain.

Value Name Description
0 TASK_STATUS_UNKNOWN Unknown or unspecified status.
1 TASK_STATUS_NOT_EXECUTED Subtask has not been executed yet.
2 TASK_STATUS_EXECUTING Subtask is currently executing.
3 TASK_STATUS_COMPLETED Subtask completed successfully.
4 TASK_STATUS_CANCELLED Subtask was cancelled.
5 TASK_STATUS_ERROR Subtask encountered an error.
6 TASK_STATUS_SKIPPED Subtask was skipped.
7 TASK_STATUS_PAUSED Subtask is paused.

RobotState

Represents the state of an AMR/robot.

Value Name Description
0 ROBOT_STATE_UNKNOWN Unknown or unspecified state.
1 ROBOT_STATE_IDLE The robot is idle and ready for task assignment.
2 ROBOT_STATE_WORKING The robot is executing a task.
3 ROBOT_STATE_CHARGING The robot is charging.
4 ROBOT_STATE_TRAFFIC_WAITING The robot is waiting due to traffic control.
5 ROBOT_STATE_MANAGED The robot is under manual or external management.
6 ROBOT_STATE_EXTERNALLY_INTERRUPTED The robot is interrupted by external factors.
7 ROBOT_STATE_OTHER Other/unclassified state.
8 ROBOT_STATE_ERROR_PAUSED The robot is paused due to an error.
9 ROBOT_STATE_USER_CONFIRMATION The robot is waiting for user confirmation.
1000 ROBOT_STATE_AWAITING_DISPATCH_CONFIRM Waiting for upper-level system to confirm dispatch.