Skip to main content

Installation

OpenRoIS publishes its packages to npm and PyPI, and the Unity package installs by Git URL. Every package is at version 0.1.0, and is alpha, pre-1.0, with an unstable API.

Requirements​

StackVersion
JavaScriptNode.js 22.12 or later, or a browser with a global WebSocket
Python3.12 or later
Unity6000.0 or later
ROS 2 (optional)Jazzy Jalisco, for ROS 2 based components

Client SDKs​

A service application uses one of the three client SDKs. They have the same surface, with one method per operation of the RoIS method catalog.

JavaScript​

npm install @openrois/sdk

@openrois/sdk is one ES module build, written in TypeScript with its types included, for browsers and Node.js. require loads it from Node.js 22.12.

Python​

pip install openrois-sdk

openrois-sdk is an asyncio client in the openrois.sdk module.

Unity​

Add the package by Git URL in the Package Manager window (Install package from git URL), or in Packages/manifest.json:

Packages/manifest.json
{
"dependencies": {
"org.openrois.sdk": "https://github.com/openrois/openrois.git?path=sdk/unity#sdk-unity-v0.1.0"
}
}

The GitHub release also carries the package as a tarball, for Install package from tarball. It is not signed, so Unity 6000.3 and later note that in the Package Manager.

Gateway and Components​

The gateway and the component SDK are Python packages:

pip install openrois-gateway # the gateway process
pip install openrois-components-core # the SDK for writing components and adapters

To try a client without a robot, run the gateway with the mock adapter from a clone of the repository, as the quick start shows.

Packages​

PackageRegistryContents
@openrois/sdknpmJavaScript client SDK
openrois-sdkPyPIPython client SDK
org.openrois.sdkGit URL, release tarballUnity client SDK, with the RoIS types for C# bundled
openrois-interfacesPyPIRoIS types, the source of truth
@openrois/interfacesnpmRoIS types and runtime validators for JavaScript and TypeScript
openrois-enginePyPIThe recursive RoIS HRI Engine, WebSocket server and client
openrois-components-corePyPIComponent SDK
openrois-gatewayPyPIThe gateway process