osiris-agent 0.1.4__tar.gz → 0.1.5__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. {osiris_agent-0.1.4 → osiris_agent-0.1.5}/PKG-INFO +41 -23
  2. osiris_agent-0.1.5/README.md +80 -0
  3. {osiris_agent-0.1.4 → osiris_agent-0.1.5}/osiris_agent.egg-info/PKG-INFO +41 -23
  4. osiris_agent-0.1.5/osiris_agent.egg-info/entry_points.txt +2 -0
  5. {osiris_agent-0.1.4 → osiris_agent-0.1.5}/setup.py +2 -2
  6. osiris_agent-0.1.4/README.md +0 -62
  7. osiris_agent-0.1.4/osiris_agent.egg-info/entry_points.txt +0 -2
  8. {osiris_agent-0.1.4 → osiris_agent-0.1.5}/LICENSE +0 -0
  9. {osiris_agent-0.1.4 → osiris_agent-0.1.5}/osiris_agent/__init__.py +0 -0
  10. {osiris_agent-0.1.4 → osiris_agent-0.1.5}/osiris_agent/agent_node.py +0 -0
  11. {osiris_agent-0.1.4 → osiris_agent-0.1.5}/osiris_agent/bt_collector.py +0 -0
  12. {osiris_agent-0.1.4 → osiris_agent-0.1.5}/osiris_agent.egg-info/SOURCES.txt +0 -0
  13. {osiris_agent-0.1.4 → osiris_agent-0.1.5}/osiris_agent.egg-info/dependency_links.txt +0 -0
  14. {osiris_agent-0.1.4 → osiris_agent-0.1.5}/osiris_agent.egg-info/requires.txt +0 -0
  15. {osiris_agent-0.1.4 → osiris_agent-0.1.5}/osiris_agent.egg-info/top_level.txt +0 -0
  16. {osiris_agent-0.1.4 → osiris_agent-0.1.5}/setup.cfg +0 -0
  17. {osiris_agent-0.1.4 → osiris_agent-0.1.5}/tests/test_agent_node.py +0 -0
{osiris_agent-0.1.4 → osiris_agent-0.1.5}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: osiris_agent
3
- Version: 0.1.4
3
+ Version: 0.1.5
4
4
  Summary: OSIRIS agent for ROS2/Humble
5
5
  Home-page: https://github.com/nicolaselielll/osiris_agent
6
6
  Author: Nicolas Tuomaala
@@ -44,45 +44,63 @@ A ROS2 Humble node that bridges your robot to the OSIRIS remote monitoring platf
44
44
 
45
45
  ## Install
46
46
 
47
- From PyPI:
47
+ Install the OSIRIS agent on your robot:
48
48
  ```bash
49
- python -m pip install --upgrade pip
50
- python -m pip install osiris_agent
49
+ pip3 install osiris-agent
51
50
  ```
52
51
 
53
- Editable / development install:
52
+ ## Quick Start
53
+
54
+ ### 1. Add token to your environment
55
+
54
56
  ```bash
55
- git clone https://github.com/nicolaselielll/osiris_agent.git
56
- cd osiris_agent
57
- python -m pip install -e .
57
+ export OSIRIS_AUTH_TOKEN=your-token-here
58
58
  ```
59
59
 
60
- ## Quick Start
60
+ ### 2. (Optional) Enable behaviour tree collector
61
+
62
+ If you're using BT.CPP with Groot2 monitoring:
61
63
 
62
- Set the auth token and run the agent:
63
64
  ```bash
64
- export OSIRIS_AUTH_TOKEN="your-robot-token-here"
65
- agent_node
65
+ export OSIRIS_BT_COLLECTOR_ENABLED=true
66
66
  ```
67
67
 
68
- Verify installation:
68
+ Default host is `127.0.0.1`. Default port for server is `1667` and for publisher `1668`. To change these:
69
+
69
70
  ```bash
70
- python -c "import importlib.metadata as m; print(m.version('osiris_agent'))"
71
+ export OSIRIS_BT_HOST=127.0.0.1
72
+ export OSIRIS_BT_SERVER_PORT=1667
73
+ export OSIRIS_BT_PUBLISHER_PORT=1668
74
+ ```
75
+
76
+ ### 3. Start agent
77
+
78
+ ```bash
79
+ osiris_node
71
80
  ```
72
81
 
73
82
  ## Usage & Configuration
74
83
 
75
- - Environment: OSIRIS_AUTH_TOKEN — your robot token.
76
- - Editable install reflects code changes immediately.
77
- - Common constants are in `osiris_agent/agent_node.py`:
78
- - MAX_SUBSCRIPTIONS, ALLOWED_TOPIC_PREFIXES, GRAPH_CHECK_INTERVAL, PARAMETER_REFRESH_INTERVAL, TELEMETRY_INTERVAL
84
+ ### Required Environment Variables
85
+
86
+ - `OSIRIS_AUTH_TOKEN` — Your robot authentication token from the OSIRIS platform
87
+
88
+ ### Optional Environment Variables
89
+
90
+ **Behaviour Tree Monitoring (BT.CPP + Groot2):**
91
+ - `OSIRIS_BT_COLLECTOR_ENABLED` — Set to `true` to enable BT.CPP tree monitoring (default: `false`)
92
+ - `OSIRIS_BT_HOST` — Groot2 ZMQ host address (default: `127.0.0.1`)
93
+ - `OSIRIS_BT_SERVER_PORT` — Groot2 REQ/REP server port (default: `1667`)
94
+ - `OSIRIS_BT_PUBLISHER_PORT` — Groot2 PUB/SUB publisher port (default: `1668`)
95
+
96
+ ## BT.CPP Integration
97
+
98
+ The agent automatically collects behaviour tree events from BT.CPP when `OSIRIS_BT_COLLECTOR_ENABLED=true`. Your BT.CPP application must:
79
99
 
80
- ## Badge suggestions
100
+ 1. Enable Groot2 monitoring in your code
101
+ 2. Use the standard Groot2 ZMQ ports (1667/1668) or configure custom ports via environment variables
81
102
 
82
- - PyPI: https://img.shields.io/pypi/v/osiris_agent.svg
83
- - Python versions: https://img.shields.io/pypi/pyversions/osiris_agent.svg
84
- - License: https://img.shields.io/pypi/l/osiris_agent.svg
85
- - GitHub Actions CI: https://github.com/<user>/osiris_agent/actions
103
+ The collector uses BT.CPP's standardized Groot2 protocol, so it works with any behaviour tree without custom configuration.
86
104
 
87
105
  ## Contributing
88
106
 
osiris_agent-0.1.5/README.md ADDED
@@ -0,0 +1,80 @@
1
+ # OSIRIS Agent
2
+
3
+ ![PyPI](https://img.shields.io/pypi/v/osiris_agent.svg)
4
+ ![Python](https://img.shields.io/pypi/pyversions/osiris_agent.svg)
5
+ ![License](https://img.shields.io/pypi/l/osiris_agent.svg)
6
+ ![CI](https://github.com/nicolaselielll/osiris_agent/actions/workflows/ci.yml/badge.svg)
7
+
8
+ A ROS2 Humble node that bridges your robot to the OSIRIS remote monitoring platform via WebSocket.
9
+
10
+ ## Install
11
+
12
+ Install the OSIRIS agent on your robot:
13
+ ```bash
14
+ pip3 install osiris-agent
15
+ ```
16
+
17
+ ## Quick Start
18
+
19
+ ### 1. Add token to your environment
20
+
21
+ ```bash
22
+ export OSIRIS_AUTH_TOKEN=your-token-here
23
+ ```
24
+
25
+ ### 2. (Optional) Enable behaviour tree collector
26
+
27
+ If you're using BT.CPP with Groot2 monitoring:
28
+
29
+ ```bash
30
+ export OSIRIS_BT_COLLECTOR_ENABLED=true
31
+ ```
32
+
33
+ Default host is `127.0.0.1`. Default port for server is `1667` and for publisher `1668`. To change these:
34
+
35
+ ```bash
36
+ export OSIRIS_BT_HOST=127.0.0.1
37
+ export OSIRIS_BT_SERVER_PORT=1667
38
+ export OSIRIS_BT_PUBLISHER_PORT=1668
39
+ ```
40
+
41
+ ### 3. Start agent
42
+
43
+ ```bash
44
+ osiris_node
45
+ ```
46
+
47
+ ## Usage & Configuration
48
+
49
+ ### Required Environment Variables
50
+
51
+ - `OSIRIS_AUTH_TOKEN` — Your robot authentication token from the OSIRIS platform
52
+
53
+ ### Optional Environment Variables
54
+
55
+ **Behaviour Tree Monitoring (BT.CPP + Groot2):**
56
+ - `OSIRIS_BT_COLLECTOR_ENABLED` — Set to `true` to enable BT.CPP tree monitoring (default: `false`)
57
+ - `OSIRIS_BT_HOST` — Groot2 ZMQ host address (default: `127.0.0.1`)
58
+ - `OSIRIS_BT_SERVER_PORT` — Groot2 REQ/REP server port (default: `1667`)
59
+ - `OSIRIS_BT_PUBLISHER_PORT` — Groot2 PUB/SUB publisher port (default: `1668`)
60
+
61
+ ## BT.CPP Integration
62
+
63
+ The agent automatically collects behaviour tree events from BT.CPP when `OSIRIS_BT_COLLECTOR_ENABLED=true`. Your BT.CPP application must:
64
+
65
+ 1. Enable Groot2 monitoring in your code
66
+ 2. Use the standard Groot2 ZMQ ports (1667/1668) or configure custom ports via environment variables
67
+
68
+ The collector uses BT.CPP's standardized Groot2 protocol, so it works with any behaviour tree without custom configuration.
69
+
70
+ ## Contributing
71
+
72
+ Open issues and PRs at: https://github.com/nicolaselielll/osiris_agent
73
+
74
+ ## License
75
+
76
+ Apache-2.0 — see the LICENSE file.
77
+
78
+ ## Changelog
79
+
80
+ See release notes on GitHub Releases for v0.1.0 and future versions.
{osiris_agent-0.1.4 → osiris_agent-0.1.5}/osiris_agent.egg-info/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: osiris_agent
3
- Version: 0.1.4
3
+ Version: 0.1.5
4
4
  Summary: OSIRIS agent for ROS2/Humble
5
5
  Home-page: https://github.com/nicolaselielll/osiris_agent
6
6
  Author: Nicolas Tuomaala
@@ -44,45 +44,63 @@ A ROS2 Humble node that bridges your robot to the OSIRIS remote monitoring platf
44
44
 
45
45
  ## Install
46
46
 
47
- From PyPI:
47
+ Install the OSIRIS agent on your robot:
48
48
  ```bash
49
- python -m pip install --upgrade pip
50
- python -m pip install osiris_agent
49
+ pip3 install osiris-agent
51
50
  ```
52
51
 
53
- Editable / development install:
52
+ ## Quick Start
53
+
54
+ ### 1. Add token to your environment
55
+
54
56
  ```bash
55
- git clone https://github.com/nicolaselielll/osiris_agent.git
56
- cd osiris_agent
57
- python -m pip install -e .
57
+ export OSIRIS_AUTH_TOKEN=your-token-here
58
58
  ```
59
59
 
60
- ## Quick Start
60
+ ### 2. (Optional) Enable behaviour tree collector
61
+
62
+ If you're using BT.CPP with Groot2 monitoring:
61
63
 
62
- Set the auth token and run the agent:
63
64
  ```bash
64
- export OSIRIS_AUTH_TOKEN="your-robot-token-here"
65
- agent_node
65
+ export OSIRIS_BT_COLLECTOR_ENABLED=true
66
66
  ```
67
67
 
68
- Verify installation:
68
+ Default host is `127.0.0.1`. Default port for server is `1667` and for publisher `1668`. To change these:
69
+
69
70
  ```bash
70
- python -c "import importlib.metadata as m; print(m.version('osiris_agent'))"
71
+ export OSIRIS_BT_HOST=127.0.0.1
72
+ export OSIRIS_BT_SERVER_PORT=1667
73
+ export OSIRIS_BT_PUBLISHER_PORT=1668
74
+ ```
75
+
76
+ ### 3. Start agent
77
+
78
+ ```bash
79
+ osiris_node
71
80
  ```
72
81
 
73
82
  ## Usage & Configuration
74
83
 
75
- - Environment: OSIRIS_AUTH_TOKEN — your robot token.
76
- - Editable install reflects code changes immediately.
77
- - Common constants are in `osiris_agent/agent_node.py`:
78
- - MAX_SUBSCRIPTIONS, ALLOWED_TOPIC_PREFIXES, GRAPH_CHECK_INTERVAL, PARAMETER_REFRESH_INTERVAL, TELEMETRY_INTERVAL
84
+ ### Required Environment Variables
85
+
86
+ - `OSIRIS_AUTH_TOKEN` — Your robot authentication token from the OSIRIS platform
87
+
88
+ ### Optional Environment Variables
89
+
90
+ **Behaviour Tree Monitoring (BT.CPP + Groot2):**
91
+ - `OSIRIS_BT_COLLECTOR_ENABLED` — Set to `true` to enable BT.CPP tree monitoring (default: `false`)
92
+ - `OSIRIS_BT_HOST` — Groot2 ZMQ host address (default: `127.0.0.1`)
93
+ - `OSIRIS_BT_SERVER_PORT` — Groot2 REQ/REP server port (default: `1667`)
94
+ - `OSIRIS_BT_PUBLISHER_PORT` — Groot2 PUB/SUB publisher port (default: `1668`)
95
+
96
+ ## BT.CPP Integration
97
+
98
+ The agent automatically collects behaviour tree events from BT.CPP when `OSIRIS_BT_COLLECTOR_ENABLED=true`. Your BT.CPP application must:
79
99
 
80
- ## Badge suggestions
100
+ 1. Enable Groot2 monitoring in your code
101
+ 2. Use the standard Groot2 ZMQ ports (1667/1668) or configure custom ports via environment variables
81
102
 
82
- - PyPI: https://img.shields.io/pypi/v/osiris_agent.svg
83
- - Python versions: https://img.shields.io/pypi/pyversions/osiris_agent.svg
84
- - License: https://img.shields.io/pypi/l/osiris_agent.svg
85
- - GitHub Actions CI: https://github.com/<user>/osiris_agent/actions
103
+ The collector uses BT.CPP's standardized Groot2 protocol, so it works with any behaviour tree without custom configuration.
86
104
 
87
105
  ## Contributing
88
106
 
osiris_agent-0.1.5/osiris_agent.egg-info/entry_points.txt ADDED
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ osiris_node = osiris_agent.agent_node:main
{osiris_agent-0.1.4 → osiris_agent-0.1.5}/setup.py RENAMED
@@ -6,7 +6,7 @@ long_description = (HERE / "README.md").read_text(encoding="utf-8")
6
6
 
7
7
  setup(
8
8
  name='osiris_agent',
9
- version='0.1.4',
9
+ version='0.1.5',
10
10
  description='OSIRIS agent for ROS2/Humble',
11
11
  long_description=long_description,
12
12
  long_description_content_type="text/markdown",
@@ -34,7 +34,7 @@ setup(
34
34
  },
35
35
  entry_points={
36
36
  'console_scripts': [
37
- 'agent_node = osiris_agent.agent_node:main',
37
+ 'osiris_node = osiris_agent.agent_node:main',
38
38
  ],
39
39
  },
40
40
  )
osiris_agent-0.1.4/README.md DELETED
@@ -1,62 +0,0 @@
1
- # OSIRIS Agent
2
-
3
- ![PyPI](https://img.shields.io/pypi/v/osiris_agent.svg)
4
- ![Python](https://img.shields.io/pypi/pyversions/osiris_agent.svg)
5
- ![License](https://img.shields.io/pypi/l/osiris_agent.svg)
6
- ![CI](https://github.com/nicolaselielll/osiris_agent/actions/workflows/ci.yml/badge.svg)
7
-
8
- A ROS2 Humble node that bridges your robot to the OSIRIS remote monitoring platform via WebSocket.
9
-
10
- ## Install
11
-
12
- From PyPI:
13
- ```bash
14
- python -m pip install --upgrade pip
15
- python -m pip install osiris_agent
16
- ```
17
-
18
- Editable / development install:
19
- ```bash
20
- git clone https://github.com/nicolaselielll/osiris_agent.git
21
- cd osiris_agent
22
- python -m pip install -e .
23
- ```
24
-
25
- ## Quick Start
26
-
27
- Set the auth token and run the agent:
28
- ```bash
29
- export OSIRIS_AUTH_TOKEN="your-robot-token-here"
30
- agent_node
31
- ```
32
-
33
- Verify installation:
34
- ```bash
35
- python -c "import importlib.metadata as m; print(m.version('osiris_agent'))"
36
- ```
37
-
38
- ## Usage & Configuration
39
-
40
- - Environment: OSIRIS_AUTH_TOKEN — your robot token.
41
- - Editable install reflects code changes immediately.
42
- - Common constants are in `osiris_agent/agent_node.py`:
43
- - MAX_SUBSCRIPTIONS, ALLOWED_TOPIC_PREFIXES, GRAPH_CHECK_INTERVAL, PARAMETER_REFRESH_INTERVAL, TELEMETRY_INTERVAL
44
-
45
- ## Badge suggestions
46
-
47
- - PyPI: https://img.shields.io/pypi/v/osiris_agent.svg
48
- - Python versions: https://img.shields.io/pypi/pyversions/osiris_agent.svg
49
- - License: https://img.shields.io/pypi/l/osiris_agent.svg
50
- - GitHub Actions CI: https://github.com/<user>/osiris_agent/actions
51
-
52
- ## Contributing
53
-
54
- Open issues and PRs at: https://github.com/nicolaselielll/osiris_agent
55
-
56
- ## License
57
-
58
- Apache-2.0 — see the LICENSE file.
59
-
60
- ## Changelog
61
-
62
- See release notes on GitHub Releases for v0.1.0 and future versions.
osiris_agent-0.1.4/osiris_agent.egg-info/entry_points.txt DELETED
@@ -1,2 +0,0 @@
1
- [console_scripts]
2
- agent_node = osiris_agent.agent_node:main
{osiris_agent-0.1.4 → osiris_agent-0.1.5}/LICENSE RENAMED
File without changes
{osiris_agent-0.1.4 → osiris_agent-0.1.5}/setup.cfg RENAMED
File without changes