RIoT 2.

0 Software Interface Manual

1 Login Interface

1.1 User login

1.1.1 Interface description

To call the RIoT interface, you can log in through the API and obtain the token information that has a validity
period of 1 day.

2 Introduction to the Business Order Interface

The business order contains handling order, and handling order as a task chain, includes moving tasks and handling
tasks. Business orders are generally placed through processes or stations.

2.1 Create an order by using process

2.1.1 Interface description

To place an order through the process, you can create a process that already exists in RIoT by specifying the
process ID.

2.1.2 Scene

In process management, multiple processes are configured for calling. For example, call a process with the ID
“3” to create an order.

1
 RIoT 2.0 Software Interface Manual

2.2 Create a station-to-station business order

2.2.1 Interface description

The order is placed in the RIoT software by designating a station.

2.2.2 Scene

Creating an order for the AGV (Automatic Guided Vehicle) to load at station 22 and unload at station 4 is
realized by specifying the startCode and the endCode and issuing the task. For details, please refer to the
examples of request parameters.

2.3 Create a multi-station business order

2.3.1 Interface description

To call the station and place an order through the external interface, you can select multiple stations and
perform handling tasks in the order of priority.

2.3.2 Scene

The interface calls to place an order for loading at station AAAA and unloading at station BBBB.

2.4 Update the business order task chain

2.4.1 Interface description

The unexecuted task chain in an order can be replaced with a new task chain in the direct mode.
2
 RIoT 2.0 Software Interface Manual

2.4.2 Scene

The unexecuted task chain as an order is directly replaced with a new task chain. For example, replace all the
motions following the second motion with new ones. (Note: The unexecuted motion can only be successfully
modified when the AGV performs the motion task. If the interface is called when the AGV performs the moving
task, the interface returns successfully, but the modification failed. Generally, modifying the unexecuted task
is operated in a customized motion -20.)
The task before the order modification is shown below.

Figure 2-1 Task chain before order modification

The task after the order modification is shown below.

Figure 2-2 Task chain after order modification

3
 RIoT 2.0 Software Interface Manual

2.5 Operate the business order

2.5.1 Interface description

It is available for basic operations on business orders, such as details, pause orders, resume orders, move out
of queue, and move back to queue.

2.5.2 Scene

An order with ID 20210212 in the upper-level system is cancelled in the order pool. Note: Order operations
can also be performed by using the business order ID, such as canceling a business order.

2.6 Query single order data

2.6.1 Interface description

It is available for querying the business orders placed by the upper-level system. The order ID not on the order
management page is the business order ID in process management.

Figure 2-3 Business order ID

2.6.2 Scene

For querying business order ID 72811, in terms of the difference between business orders and handling orders,
the business order is generally placed through the process, and a business order may include multiple handling
orders.

4
 RIoT 2.0 Software Interface Manual

2.7 Query the order in page mode

2.7.1 Interface description

It is available for querying the specified orders or all orders in page mode, and filtering orders by specifying
the order name and status.

2.7.2 Scene

The specified orders or all orders are queried in page mode by calling the interface. For example, display one
piece of data on the first page.

2.8 Report the order status

2.8.1 Interface description

It is available for reporting the order information to the customer’s system.

2.8.2 Scene

Only the relevant fields are described. To report the order status, you need to configure it on the RIoT software
page to specify the parameters and address of the returned order.
(1) Find the HTTP call configuration in the three-party communication management and specify the interface
address for receiving the RIoT software callback by the upper-layer system.

(2) Select the relevant callback parameters. Refer to the optional fields for the fields already in the order and
obtain the parameters in the configuration directly using ${}.

5
 RIoT 2.0 Software Interface Manual

(3) Return the message.

Taking "cancel task" as an example, after defining in a third-party system, “taskStatus 4” means that the order
task is canceled. The value of a specified field can be obtained in the RIoT system via ${key}. The returned
json is shown below, in custom mode. (The detailed content can be customized and confirmed by the user first,
and then the corresponding status notifications will be returned according to specific needs.)

3 Introduction to the Handling Order Interface

The handling order is composed of a task chain, including multiple moving tasks and motion tasks.

3.1 Create a handling order

3.1.1 Interface description

It is available for creating an order from the task list. The task refers to the task chain performed by an AGV,
including both moving tasks and motion tasks.

6
 RIoT 2.0 Software Interface Manual

3.1.2 Scene

A task (task chain) is created for jacking AGV to reach AAAA and pick up (two tasks, one is to move to AAAA
and the other is to perform the jacking with parameter 4, 1, 0).

3.2 Operate the handling order

3.2.1 Interface description

According to the order key, it is available for controlling the life cycle of the order and processing the order.
For the detailed order operation, please refer to the operation type in the request parameters.

3.2.2 Scene

When an order is suspended for exception, the order is executed continuously after the exception is eliminated.
Request example: Cancel the order by specifying the order key and operating instruction.

Figure 3-1 Order key

3.3 Obtain the handling order details from the order ID

3.3.1 Interface description

It is available to obtain the details of an order from the order ID.

7
 RIoT 2.0 Software Interface Manual

3.3.2 Scene

The details of an order with a specified ID (order-1632984831757516800) is obtained.

Figure 3-2 Order ID

3.4 Obtain the handling order details from the upper ID

3.4.1 Interface description

It is available to obtain the details of an order in the process configuration from the upper ID.

3.4.2 Scene

The interface is called to transfer the upper ID to obtain the details of an order with the specified upper ID
("Process Configuration - Jacking AGV Process - 746623782389300").

3.5 Query the handling order list in page mode

3.5.1 Interface description

It is available for filtering related orders in the order list by specifying conditions and displaying them in
specified page mode. For specific filter conditions, please refer to the relevant request parameter fields.

3.5.2 Scene

Example: Filter all orders with end code 4. Display the first page, with 2 pieces of data.

8
 RIoT 2.0 Software Interface Manual

4 Introduction to the AGV Interface

4.1 Obtain the AGV information

4.1.1 Interface description

It is available to obtain the AGV information through deviceKey.

4.1.2 Scene

The cargo status of the AGV is obtained to determine whether the skip car is allowed to pick up cargo. The
AGV information is obtained through deviceKey.

4.2 Activate/Release emergency stop in batch

4.2.1 Interface description

It is available for activating or releasing the emergency stop of the AGV in batch.

4.2.2 Scene

Two AGVs are designated for emergency stop.

4.3 Bring online or offline in batch

4.3.1 Interface description

It is available for bringing the AGV and device online in batch.

9
 RIoT 2.0 Software Interface Manual

4.3.2 Scene

The device with specified deviceKey is put online. Presently, the AGV 001 is offline, after this operation is
performed, the AGV 001 will be in “online state”.

4.4 Report the AGV status

4.4.1 Interface description

It is available for reporting the AGV status information to the user system through the process configuration.
You can select the relevant fields in the process configuration and customize the interface after configuration
according to the fields.

4.4.2 Scene

The information is reported through the process configuration, with reference to the 2.8 Report the order status.
When configuring the address, it is suggested to set the event trigger source to AGV, and then configure the
corresponding address and json in the same manner.

10
 RIoT 2.0 Software Interface Manual

5 Instruction to the Device Interface

5.1 Query the device status

5.1.1 Interface description

It is available to obtain device information, including AGV, connected production equipment, non-production
equipment, etc., and return the attribute set according to the obtained device type.

5.1.2 Scene

The cargo status of the AGV is obtained to determine whether the AGV meets the task trigger conditions. The
device key is entered, and the corresponding attributes are returned.

11