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.1.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.1-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: osiris_agent-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 06855805b51125cbf8ab8cb0b96d5ae0441122e11484340dfefe929ca6a0cc1a
MD5 6f49cce7ccd1782c58b30a7c073d952d
BLAKE2b-256 a21f47ecff17a9fb075e061d621d1b506d2e724004fd11440ef487c497ac1b72

See more details on using hashes here.

File details

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

File metadata

  • Download URL: osiris_agent-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 aeeb9346d7f97f4881233acac56d12f9dbf25c9c0e73dc82ae0233d6d8f68aa0
MD5 516798cfa01a4e625be68b9e24c87db1
BLAKE2b-256 16e3915c093f74cfe74164d1448c8ae3ca5c026493a6c23af02bafda6bd48088

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