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.122
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.122.tar.gz | 344.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| osiris_agent-0.3.122-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 695.4 kB
Release files / osiris_agent-0.3.122.tar.gz
| Download URL | osiris_agent-0.3.122.tar.gz |
|---|---|
| Size | 344.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7967a8906b0a86d494d69d88c92bb80afc1cb440d9dbd6bb9756159d580eab66
|
|
BLAKE2b-256 checksum How to use checksums |
c43a975bd687991de55a59493796e89a2cb96c81eeed0cf8b9f8e7e06edd01f6
|
| 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.122-py3-none-any.whl
| Download URL | osiris_agent-0.3.122-py3-none-any.whl |
|---|---|
| Size | 350.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bc84083a43de6b231e4b7e52893841a3be0e97eec6f26c71c5948369088f6789
|
|
BLAKE2b-256 checksum How to use checksums |
1b589c94f93a25e286319ed2ee546426e098b2e90744dcb57dcaf9554d609958
|
| 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.122
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.
