OSIRIS agent for ROS2/Humble
Project description
OSIRIS Agent
A ROS2 Humble node that bridges your robot to the OSIRIS remote monitoring platform via WebSocket.
Install
From PyPI:
python -m pip install --upgrade pip
python -m pip install osiris_agent
Editable / development install:
git clone https://github.com/nicolaselielll/osiris_agent.git
cd osiris_agent
python -m pip install -e .
Quick Start
Set the auth token and run the agent:
export OSIRIS_AUTH_TOKEN="your-robot-token-here"
agent_node
Verify installation:
python -c "import importlib.metadata as m; print(m.version('osiris_agent'))"
Usage & Configuration
- Environment: OSIRIS_AUTH_TOKEN — your robot token.
- Editable install reflects code changes immediately.
- Common constants are in
osiris_agent/agent_node.py:- MAX_SUBSCRIPTIONS, ALLOWED_TOPIC_PREFIXES, GRAPH_CHECK_INTERVAL, PARAMETER_REFRESH_INTERVAL, TELEMETRY_INTERVAL
Badge suggestions
- PyPI: https://img.shields.io/pypi/v/osiris_agent.svg
- Python versions: https://img.shields.io/pypi/pyversions/osiris_agent.svg
- License: https://img.shields.io/pypi/l/osiris_agent.svg
- GitHub Actions CI: https://github.com//osiris_agent/actions
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file osiris_agent-0.1.4.tar.gz.
File metadata
- Download URL: osiris_agent-0.1.4.tar.gz
- Upload date:
- Size: 20.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c5c7178a4c35b0426e86cb58ae7b9b0969b431b6ced24a61238a8f47e5d8f94c
|
|
| MD5 |
02863794e0db3f16057eeffd558874ac
|
|
| BLAKE2b-256 |
66330178a719b6da2a5d635e2133e2cf29ad753f9e3cbe8e89b32b7dbaeae350
|
File details
Details for the file osiris_agent-0.1.4-py3-none-any.whl.
File metadata
- Download URL: osiris_agent-0.1.4-py3-none-any.whl
- Upload date:
- Size: 20.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cf8a620c1ab25ea823f7cd0a6c611e4f374b17425ed976233ac36e7194be81d8
|
|
| MD5 |
e4924f1e26a1ad6b5bae7d9252d4b5b1
|
|
| BLAKE2b-256 |
729b97625e964847a3544de300951083cfc093416f5c6504bfa0cf93b73e8c8e
|