OSIRIS Agent
A ROS2 Humble node that bridges your robot to the OSIRIS remote monitoring platform via WebSocket.
Install
Install the OSIRIS agent on your robot:
pip3 install osiris-agent
Quick Start
1. Add token to your environment
export OSIRIS_AUTH_TOKEN=your-token-here
2. (Optional) Enable behaviour tree collector
If you're using BT.CPP with Groot2 monitoring:
export OSIRIS_BT_COLLECTOR_ENABLED=true
Default host is 127.0.0.1. Default port for server is 1667 and for publisher 1668. To change these:
export OSIRIS_BT_HOST=127.0.0.1
export OSIRIS_BT_SERVER_PORT=1667
export OSIRIS_BT_PUBLISHER_PORT=1668
3. Start agent
osiris_node
Usage & Configuration
Required Environment Variables
OSIRIS_AUTH_TOKEN— Your robot authentication token from the OSIRIS platform
Optional Environment Variables
Behaviour Tree Monitoring (BT.CPP + Groot2):
OSIRIS_BT_COLLECTOR_ENABLED— Set totrueto enable BT.CPP tree monitoring (default:false)OSIRIS_BT_HOST— Groot2 ZMQ host address (default:127.0.0.1)OSIRIS_BT_SERVER_PORT— Groot2 REQ/REP server port (default:1667)OSIRIS_BT_PUBLISHER_PORT— Groot2 PUB/SUB publisher port (default:1668)
BT.CPP Integration
The agent automatically collects behaviour tree events from BT.CPP when OSIRIS_BT_COLLECTOR_ENABLED=true. Your BT.CPP application must:
- Enable Groot2 monitoring in your code
- Use the standard Groot2 ZMQ ports (1667/1668) or configure custom ports via environment variables
The collector uses BT.CPP's standardized Groot2 protocol, so it works with any behaviour tree without custom configuration.
Contributing
Open issues and PRs at: https://github.com/nicolaselielll/osiris_agent
License
Apache-2.0 — see the LICENSE file.
Changelog
See release notes on GitHub Releases for v0.1.0 and future versions.
1 maintainer
Metadata
1 maintainer
Release files for osiris-agent 0.3.112
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| osiris_agent-0.3.112.tar.gz | 211.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| osiris_agent-0.3.112-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 426.6 kB
Release files / osiris_agent-0.3.112.tar.gz
| Download URL | osiris_agent-0.3.112.tar.gz |
|---|---|
| Size | 211.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b1b11593d39877f5b2a6c8b947ade1d37c9023c7d8743f819958462331df3cdb
|
|
BLAKE2b-256 checksum How to use checksums |
c4345536b315bdba3beee2d90f492c9401ec29dcb482d4f748880c524d56967d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.0
|
Release files / osiris_agent-0.3.112-py3-none-any.whl
| Download URL | osiris_agent-0.3.112-py3-none-any.whl |
|---|---|
| Size | 214.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
416061f80258a9eab56008fd79a6c091183f7109c3787ff3ec9ffb79b383ded0
|
|
BLAKE2b-256 checksum How to use checksums |
75cb93f58e9d4e3cef3c9be62217607bfedec87ea553fc76c2817661b0479639
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.0
|
Security for osiris-agent 0.3.112
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
