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.4.tar.gz (20.4 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.4-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

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

Hashes for osiris_agent-0.1.4.tar.gz
Algorithm Hash digest
SHA256 c5c7178a4c35b0426e86cb58ae7b9b0969b431b6ced24a61238a8f47e5d8f94c
MD5 02863794e0db3f16057eeffd558874ac
BLAKE2b-256 66330178a719b6da2a5d635e2133e2cf29ad753f9e3cbe8e89b32b7dbaeae350

See more details on using hashes here.

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

Hashes for osiris_agent-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 cf8a620c1ab25ea823f7cd0a6c611e4f374b17425ed976233ac36e7194be81d8
MD5 e4924f1e26a1ad6b5bae7d9252d4b5b1
BLAKE2b-256 729b97625e964847a3544de300951083cfc093416f5c6504bfa0cf93b73e8c8e

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