Quick Start
This quick start runs a gateway with simulated components behind it, and the OpenRoIS Inspector, a browser app that connects to the gateway as a service application does. No robot is required, and nothing needs to be installed besides Docker with Compose and Git.
1. Get the Source
git clone https://github.com/openrois/openrois.git
cd openrois
2. Start the Stack
docker compose up --build
This builds and starts three containers:
- the gateway, the main HRI Engine, listening on
ws://localhost:8765; - the mock adapter, an engine of its own below the gateway that serves simulated
components:
mock/navigation,mock/person_detection,mock/system_informationand the test fixturemock/fault; - the OpenRoIS Inspector, served on
http://localhost:8080.
3. Open the Inspector
Open http://localhost:8080/?autoconnect=1. The
Inspector connects to the gateway, calls rois.system.get_profile, and shows the engines
behind it and their components.

Things to try:
- On the overview, the Try This cards read the robot position, watch for people, and
drive to a target with
bind,executeandrelease. - Open a component to read its profile, get and set its parameters, run its queries and commands, and subscribe to its events.
- In Command Sequence, combine steps and a concurrent group of branches into one
executecall, then follow every command id until it completes. - Turn on SDK Calls to see the
@openrois/sdkTypeScript for each action, and open the activity log to see every JSON-RPC 2.0 message.
What Just Happened
- The gateway published an HRI Engine profile describing the components of every engine behind it.
- The Inspector discovered the components at runtime instead of hardcoding them. This is what lets one RoIS application work with any robot behind the gateway.
- Commands followed the RoIS reservation lifecycle:
bind, thenexecute, thenrelease.
Stop the stack with docker compose down.
Next Steps
- Read how the pieces fit together in the architecture.
- Write your own service application with the JavaScript, Python or Unity SDK.
- Connect a real platform by writing a component and adapter.