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.2.tar.gz (14.8 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.2-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for osiris_agent-0.1.2.tar.gz
Algorithm Hash digest
SHA256 e193ec8c436ac8b7d6442b4feabfeb2aede6daa55f4ac0b2f71d4c74898262c4
MD5 c37e9a99609b16de068ae299e92040da
BLAKE2b-256 c62726a6402054493fb0a73b2926292e3d99f2ad8de723524bcd223c1f371fed

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for osiris_agent-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 dcd986d45ae9124b18f77504ea473b76dd0e839a02505bc861da795dbe024ecd
MD5 5fcee95d3d573b7455b26823c36daff9
BLAKE2b-256 79ea25d606dc157fff603ea85accd28f7c146b1cfb39a1a4cfc957d638560de5

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