osiris-agent 0.1.4__py3-none-any.whl → 0.1.5__py3-none-any.whl

{osiris_agent-0.1.4.dist-info → osiris_agent-0.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: osiris_agent
-Version: 0.1.4
+Version: 0.1.5
 Summary: OSIRIS agent for ROS2/Humble
 Home-page: https://github.com/nicolaselielll/osiris_agent
 Author: Nicolas Tuomaala
@@ -44,45 +44,63 @@ A ROS2 Humble node that bridges your robot to the OSIRIS remote monitoring platf
 
 ## Install
 
-From PyPI:
+Install the OSIRIS agent on your robot:
 ```bash
-python -m pip install --upgrade pip
-python -m pip install osiris_agent
+pip3 install osiris-agent
 ```
 
-Editable / development install:
+## Quick Start
+
+### 1. Add token to your environment
+
 ```bash
-git clone https://github.com/nicolaselielll/osiris_agent.git
-cd osiris_agent
-python -m pip install -e .
+export OSIRIS_AUTH_TOKEN=your-token-here
 ```
 
-## Quick Start
+### 2. (Optional) Enable behaviour tree collector
+
+If you're using BT.CPP with Groot2 monitoring:
 
-Set the auth token and run the agent:
 ```bash
-export OSIRIS_AUTH_TOKEN="your-robot-token-here"
-agent_node
+export OSIRIS_BT_COLLECTOR_ENABLED=true
 ```
 
-Verify installation:
+Default host is `127.0.0.1`. Default port for server is `1667` and for publisher `1668`. To change these:
+
 ```bash
-python -c "import importlib.metadata as m; print(m.version('osiris_agent'))"
+export OSIRIS_BT_HOST=127.0.0.1
+export OSIRIS_BT_SERVER_PORT=1667
+export OSIRIS_BT_PUBLISHER_PORT=1668
+```
+
+### 3. Start agent
+
+```bash
+osiris_node
 ```
 
 ## 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
+### Required Environment Variables
+
+- `OSIRIS_AUTH_TOKEN` — Your robot authentication token from the OSIRIS platform
+
+### Optional Environment Variables
+
+**Behaviour Tree Monitoring (BT.CPP + Groot2):**
+- `OSIRIS_BT_COLLECTOR_ENABLED` — Set to `true` to enable BT.CPP tree monitoring (default: `false`)
+- `OSIRIS_BT_HOST` — Groot2 ZMQ host address (default: `127.0.0.1`)
+- `OSIRIS_BT_SERVER_PORT` — Groot2 REQ/REP server port (default: `1667`)
+- `OSIRIS_BT_PUBLISHER_PORT` — Groot2 PUB/SUB publisher port (default: `1668`)
+
+## BT.CPP Integration
+
+The agent automatically collects behaviour tree events from BT.CPP when `OSIRIS_BT_COLLECTOR_ENABLED=true`. Your BT.CPP application must:
 
-## Badge suggestions
+1. Enable Groot2 monitoring in your code
+2. Use the standard Groot2 ZMQ ports (1667/1668) or configure custom ports via environment variables
 
-- 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/<user>/osiris_agent/actions
+The collector uses BT.CPP's standardized Groot2 protocol, so it works with any behaviour tree without custom configuration.
 
 ## Contributing
 

osiris_agent-0.1.5.dist-info/RECORD

@@ -0,0 +1,9 @@
+osiris_agent/__init__.py,sha256=E0YxGzSMUelxIPB6kRPKL-2Da_QaYCZeOd8fEaLtQ5c,73
+osiris_agent/agent_node.py,sha256=Rx1IXKCL7tRhLwZQS4YaJTKuE9A47pRayMSC_plezZ8,39973
+osiris_agent/bt_collector.py,sha256=lFfrjObFnZKgrAb9HUpEpWAROc52QdqPXBjAtRDpkjg,20976
+osiris_agent-0.1.5.dist-info/licenses/LICENSE,sha256=tv_rYfXPsDuLDPIrpAFFZfgaO15H-gz89GW1TfyCQ48,10758
+osiris_agent-0.1.5.dist-info/METADATA,sha256=CZyg3IW7ndtZM-uX2c6aVcr5VKVKqC53Hjex5QNzKsQ,3230
+osiris_agent-0.1.5.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+osiris_agent-0.1.5.dist-info/entry_points.txt,sha256=eIDN_LuzMOpqZgGnMz8MGqYxZSJ7bS76sm2xv2zwdcU,61
+osiris_agent-0.1.5.dist-info/top_level.txt,sha256=qT-C0LRSrwlNjTuA7bVsTmwYJzhONP18wuyAXwUBZnU,13
+osiris_agent-0.1.5.dist-info/RECORD,,

osiris_agent-0.1.5.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+osiris_node = osiris_agent.agent_node:main

osiris_agent-0.1.4.dist-info/RECORD

@@ -1,9 +0,0 @@
-osiris_agent/__init__.py,sha256=E0YxGzSMUelxIPB6kRPKL-2Da_QaYCZeOd8fEaLtQ5c,73
-osiris_agent/agent_node.py,sha256=Rx1IXKCL7tRhLwZQS4YaJTKuE9A47pRayMSC_plezZ8,39973
-osiris_agent/bt_collector.py,sha256=lFfrjObFnZKgrAb9HUpEpWAROc52QdqPXBjAtRDpkjg,20976
-osiris_agent-0.1.4.dist-info/licenses/LICENSE,sha256=tv_rYfXPsDuLDPIrpAFFZfgaO15H-gz89GW1TfyCQ48,10758
-osiris_agent-0.1.4.dist-info/METADATA,sha256=HFMNlgTWH2rFWMl9ZBXMmb1YxSplITY2F1ZTopRWykQ,2702
-osiris_agent-0.1.4.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-osiris_agent-0.1.4.dist-info/entry_points.txt,sha256=ff4USKDLj8unIsvb7iQrVvfhP52Fhp3QAR5AchypnuE,60
-osiris_agent-0.1.4.dist-info/top_level.txt,sha256=qT-C0LRSrwlNjTuA7bVsTmwYJzhONP18wuyAXwUBZnU,13
-osiris_agent-0.1.4.dist-info/RECORD,,

osiris_agent-0.1.4.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-agent_node = osiris_agent.agent_node:main