Skip to main content

OSIRIS agent for ROS2/Humble

Project description

OSIRIS Agent

PyPI Python License CI

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

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

osiris_agent-0.1.3.tar.gz (20.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

osiris_agent-0.1.3-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file osiris_agent-0.1.3.tar.gz.

File metadata

  • Download URL: osiris_agent-0.1.3.tar.gz
  • Upload date:
  • Size: 20.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for osiris_agent-0.1.3.tar.gz
Algorithm Hash digest
SHA256 d4b4e37957f052ac097f2c0fad31e895eb40c84d689e6bb9c78911deed850850
MD5 4b1c10fe46d5b49d69e855ec7f7a3b2e
BLAKE2b-256 ebab69d5f94121b15815d8935c9526294b0db6588665b46f46e9af533189984e

See more details on using hashes here.

File details

Details for the file osiris_agent-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: osiris_agent-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for osiris_agent-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f7d91a70587680d0d3a65a859467f7656c29e9a4f9b6e8d8d98e2b29322b5b2c
MD5 2eb0d426a3083a7747104ada9f3ae84c
BLAKE2b-256 f4edcbf36402c7893811738f3927939a9def5519c2d4d8f0410dd449f6ab6324

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page