Robot Interaction Objects (RIO)

Description

In order to accommodate custom integrations with devices, workcells, infrastructure, etc, Robot Interaction Objects (RIO) was introduced. RIOs and their states can be defined generically with any JSON, as long as the id and type is unique.

Endpoints

To verify the endpoints, once the API server has been started, check them out at localhost:8000/docs

• PUT on /rios, which allow generic JSON-style dictionary states for any RIO to update its state to the API server with unique id and type
• GET on /rios, which allows basic queries on RIOs, using their id and type

Integration

With the endpoints defined above, users can write their own custom micro-app (see https://github.com/open-rmf/rmf-web/tree/main/packages/dashboard#micro-apps), and display it on the dashboard.

Examples

• Setting up Smart Cart as a RIO, https://github.com/open-rmf/smart_cart_api_server/blob/main/smart_cart_api_server/controllers/update_cart_status.py