-
Notifications
You must be signed in to change notification settings - Fork 42
Robot Interaction Objects (RIO)
Aaron Chong edited this page Jul 26, 2024
·
2 revisions
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.
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 uniqueid
andtype
-
GET
on/rios
, which allows basic queries on RIOs, using theirid
andtype
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.
- 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