robodiag-harness 0.1__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.
- robodiag_harness-0.1/LICENSE +201 -0
- robodiag_harness-0.1/MANIFEST.in +5 -0
- robodiag_harness-0.1/NOTICE +14 -0
- robodiag_harness-0.1/PKG-INFO +398 -0
- robodiag_harness-0.1/README.md +365 -0
- robodiag_harness-0.1/pyproject.toml +7 -0
- robodiag_harness-0.1/robodiag +66 -0
- robodiag_harness-0.1/robodiag_harness.egg-info/PKG-INFO +398 -0
- robodiag_harness-0.1/robodiag_harness.egg-info/SOURCES.txt +15 -0
- robodiag_harness-0.1/robodiag_harness.egg-info/dependency_links.txt +1 -0
- robodiag_harness-0.1/robodiag_harness.egg-info/entry_points.txt +2 -0
- robodiag_harness-0.1/robodiag_harness.egg-info/requires.txt +11 -0
- robodiag_harness-0.1/robodiag_harness.egg-info/top_level.txt +1 -0
- robodiag_harness-0.1/robodiag_ros2.py +1916 -0
- robodiag_harness-0.1/setup.cfg +49 -0
- robodiag_harness-0.1/setup.py +9 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
RoboDiag ROS 2 Diagnostic Harness
|
|
2
|
+
Copyright 2026 RoboDiag Contributors
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
you may not use this file except in compliance with the License.
|
|
6
|
+
You may obtain a copy of the License at
|
|
7
|
+
|
|
8
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
|
|
10
|
+
Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
See the License for the specific language governing permissions and
|
|
14
|
+
limitations under the License.
|
|
@@ -0,0 +1,398 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: robodiag-harness
|
|
3
|
+
Version: 0.1
|
|
4
|
+
Summary: AI diagnostic agent for ROS 2 robots — evidence-based, tool-calling, safety-gated
|
|
5
|
+
Home-page: https://github.com/YueBit/robodiag-harness
|
|
6
|
+
Author: RoboDiag Contributors
|
|
7
|
+
Author-email: YueBit@users.noreply.github.com
|
|
8
|
+
License: Apache-2.0
|
|
9
|
+
Project-URL: Source, https://github.com/YueBit/robodiag-harness
|
|
10
|
+
Project-URL: Issues, https://github.com/YueBit/robodiag-harness/issues
|
|
11
|
+
Classifier: Development Status :: 3 - Alpha
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Intended Audience :: Science/Research
|
|
14
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
15
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Topic :: Scientific/Engineering
|
|
20
|
+
Classifier: Topic :: System :: Monitoring
|
|
21
|
+
Requires-Python: >=3.10
|
|
22
|
+
Description-Content-Type: text/markdown
|
|
23
|
+
License-File: LICENSE
|
|
24
|
+
Requires-Dist: rich>=12
|
|
25
|
+
Provides-Extra: completion
|
|
26
|
+
Requires-Dist: prompt_toolkit>=3.0; extra == "completion"
|
|
27
|
+
Provides-Extra: agent
|
|
28
|
+
Requires-Dist: openai>=1.0; extra == "agent"
|
|
29
|
+
Provides-Extra: all
|
|
30
|
+
Requires-Dist: prompt_toolkit>=3.0; extra == "all"
|
|
31
|
+
Requires-Dist: openai>=1.0; extra == "all"
|
|
32
|
+
Dynamic: license-file
|
|
33
|
+
|
|
34
|
+
# RoboDiag Harness 🩺🤖
|
|
35
|
+
|
|
36
|
+
**A command-line tool for checking your robot's health and investigating problems.**
|
|
37
|
+
|
|
38
|
+
[](LICENSE)
|
|
39
|
+

|
|
40
|
+

|
|
41
|
+
|
|
42
|
+
Your robot is connected—but is it working properly? Is sensor data arriving?
|
|
43
|
+
Are there any reported faults? What should you check when something goes wrong?
|
|
44
|
+
|
|
45
|
+
RoboDiag brings robot checks, telemetry, and diagnostic tools into one terminal
|
|
46
|
+
interface.
|
|
47
|
+
|
|
48
|
+
Think of it as a robot checkup: **collect evidence, inspect problems, and decide
|
|
49
|
+
what to investigate next.**
|
|
50
|
+
|
|
51
|
+
## What can I use it for?
|
|
52
|
+
|
|
53
|
+
- **Check your robot** — inspect its status and available diagnostic information.
|
|
54
|
+
- **Inspect sensor readings** — view telemetry and collect samples over time.
|
|
55
|
+
- **Investigate problems** — examine reported faults and review previous results.
|
|
56
|
+
- **Run supported tests** — use the checks and actions available for your robot.
|
|
57
|
+
- **Give an AI assistant access to diagnostic tools** — let it work with robot
|
|
58
|
+
data through the harness.
|
|
59
|
+
|
|
60
|
+
Available features depend on the robot, its software, and the selected
|
|
61
|
+
configuration.
|
|
62
|
+
|
|
63
|
+
## Who is it for?
|
|
64
|
+
|
|
65
|
+
Robot owners, students, and developers who want a more convenient way to inspect
|
|
66
|
+
and troubleshoot their robots.
|
|
67
|
+
|
|
68
|
+
You will need basic familiarity with a terminal. For the ROS 2 version, you also
|
|
69
|
+
need a working ROS 2 environment.
|
|
70
|
+
|
|
71
|
+
You do **not** need an AI assistant to use the command-line interface.
|
|
72
|
+
|
|
73
|
+
## What does “Harness” mean?
|
|
74
|
+
|
|
75
|
+
A harness connects tools together so they can be used through a common interface.
|
|
76
|
+
|
|
77
|
+
Here, it connects robot data, diagnostic checks, and supported actions—so you
|
|
78
|
+
can access them from one place.
|
|
79
|
+
|
|
80
|
+
## Getting started with ROS 2
|
|
81
|
+
|
|
82
|
+
### 1. Prepare your robot
|
|
83
|
+
|
|
84
|
+
Make sure:
|
|
85
|
+
|
|
86
|
+
- ROS 2 is installed.
|
|
87
|
+
- Your robot's ROS 2 software is running.
|
|
88
|
+
- The computer running RoboDiag can communicate with your robot.
|
|
89
|
+
|
|
90
|
+
The launcher looks for ROS 2 under `/opt/ros`. It uses the distribution
|
|
91
|
+
identified by `ROS_DISTRO` when available, otherwise it tries Humble.
|
|
92
|
+
|
|
93
|
+
### 2. Download the project
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
git clone https://github.com/YueBit/robodiag-harness.git
|
|
97
|
+
cd robodiag-harness
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### 3. Start RoboDiag
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
bash ./robodiag
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
If your robot needs a workspace overlay, specify its location:
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
ROBODIAG_WS=~/robot_ws bash ./robodiag
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
The workspace should already be built, with an `install/setup.bash` file.
|
|
113
|
+
|
|
114
|
+
### 4. Start with a check
|
|
115
|
+
|
|
116
|
+
Begin with status checks and telemetry inspection. Review the available data
|
|
117
|
+
before running actions that move the robot.
|
|
118
|
+
|
|
119
|
+
Missing data does not necessarily mean broken hardware: the relevant sensor,
|
|
120
|
+
driver, or ROS 2 node may not be running.
|
|
121
|
+
|
|
122
|
+
## Configure your robot's interfaces
|
|
123
|
+
|
|
124
|
+
Robots may use different topic and service names. You can pass these to the
|
|
125
|
+
launcher:
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
bash ./robodiag \
|
|
129
|
+
--cmd-vel-topic /cmd_vel \
|
|
130
|
+
--estop-service /emergency_stop
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
Use the names provided by your robot's software. Specifying a name does not
|
|
134
|
+
create the corresponding topic or service.
|
|
135
|
+
|
|
136
|
+
## Using it with an AI assistant
|
|
137
|
+
|
|
138
|
+
An AI assistant can use diagnostic tools to collect information and help
|
|
139
|
+
interpret it.
|
|
140
|
+
|
|
141
|
+
A typical workflow is:
|
|
142
|
+
|
|
143
|
+
1. You describe the problem.
|
|
144
|
+
2. The assistant requests relevant robot data.
|
|
145
|
+
3. It reviews the results and suggests further checks.
|
|
146
|
+
4. You decide whether to proceed with any physical tests.
|
|
147
|
+
|
|
148
|
+
**AI suggestions can be wrong.** Check the underlying readings before acting on
|
|
149
|
+
a conclusion.
|
|
150
|
+
|
|
151
|
+
## Before running movement tests
|
|
152
|
+
|
|
153
|
+
Some actions can move real hardware.
|
|
154
|
+
|
|
155
|
+
- Place the robot in a clear, stable area.
|
|
156
|
+
- Keep people and obstacles away from moving parts.
|
|
157
|
+
- Know how to stop your robot independently of RoboDiag.
|
|
158
|
+
- Review the requested action before confirming it.
|
|
159
|
+
|
|
160
|
+
A software stop command depends on the robot's implementation and communication
|
|
161
|
+
connection. It does **not** replace a physical emergency stop.
|
|
162
|
+
|
|
163
|
+
## Limitations
|
|
164
|
+
|
|
165
|
+
RoboDiag helps gather and interpret diagnostic evidence. It cannot guarantee
|
|
166
|
+
that a robot is safe or identify every hardware fault.
|
|
167
|
+
|
|
168
|
+
The checks it can perform depend on the information and control interfaces your
|
|
169
|
+
robot exposes. Support for ROS 2 does not mean every ROS 2 robot works without
|
|
170
|
+
configuration.
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
## Features
|
|
175
|
+
|
|
176
|
+
- Inspect the ROS graph: nodes, topics, services and their types.
|
|
177
|
+
- Collect standard `/diagnostics` (`diagnostic_msgs/DiagnosticArray`).
|
|
178
|
+
- Inspect `ros2_control` through `controller_manager` services, when available.
|
|
179
|
+
- Snapshot/sample **any** discovered ROS 2 topic by loading its message type at
|
|
180
|
+
runtime; nothing is hard-coded.
|
|
181
|
+
- Time-window sampling with `min/max/mean/std/range` statistics for jitter,
|
|
182
|
+
drift, dropouts and intermittency.
|
|
183
|
+
- Deterministic health tests (`PASS / WARN / FAIL / SKIP`) persisted to SQLite.
|
|
184
|
+
- A fail-closed Safety Gate for motion-related operations.
|
|
185
|
+
- A software emergency stop (zero Twist + optional Trigger service).
|
|
186
|
+
- An OpenAI-compatible diagnostic agent (DeepSeek by default) with function
|
|
187
|
+
calling.
|
|
188
|
+
- `rich` terminal UI with an animated banner and `/`-command completion.
|
|
189
|
+
|
|
190
|
+
## How it works
|
|
191
|
+
|
|
192
|
+
```
|
|
193
|
+
natural language slash commands
|
|
194
|
+
│ │
|
|
195
|
+
▼ ▼
|
|
196
|
+
┌──────────────────┐ ┌──────────────────┐
|
|
197
|
+
│ Agent loop │ │ REPL (rich) │
|
|
198
|
+
│ LLM function │ │ direct dispatch │
|
|
199
|
+
│ calling, ≤10 │ └────────┬─────────┘
|
|
200
|
+
└────────┬─────────┘ │
|
|
201
|
+
│ tool calls same deterministic tools
|
|
202
|
+
▼ ▼
|
|
203
|
+
┌──────────────────────────────────────────────────────────┐
|
|
204
|
+
│ Deterministic tool layer │
|
|
205
|
+
│ HarnessNode (rclpy) · TestRunner · HistoryStore │
|
|
206
|
+
└───────────┬───────────────────────┬──────────────────────┘
|
|
207
|
+
│ │
|
|
208
|
+
ROS 2 graph / topics SQLite test history
|
|
209
|
+
│
|
|
210
|
+
┌───────┴────────┐
|
|
211
|
+
│ Safety Gate │ fail-closed, no LLM in the loop
|
|
212
|
+
│ diagnostics / │ checks freshness + battery + joints
|
|
213
|
+
│ battery / │
|
|
214
|
+
│ joint states │
|
|
215
|
+
└────────────────┘
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
The core rule:
|
|
219
|
+
|
|
220
|
+
> **The LLM may request evidence and tests, but deterministic code decides
|
|
221
|
+
> whether a write or motion operation is permitted.**
|
|
222
|
+
|
|
223
|
+
### How is this different from `ros2 doctor`?
|
|
224
|
+
|
|
225
|
+
`ros2 doctor` inspects the local ROS installation and its configuration. RoboDiag
|
|
226
|
+
Harness inspects the **live running graph and robot telemetry**, samples topics
|
|
227
|
+
over time, runs deterministic health tests, stores history, and adds an LLM agent
|
|
228
|
+
that can decide *which* evidence to collect next.
|
|
229
|
+
|
|
230
|
+
## Install with pip
|
|
231
|
+
|
|
232
|
+
`pip install` provides the `robodiag` console command. **rclpy and the ROS
|
|
233
|
+
message packages are not on PyPI** — they come from your ROS 2 distribution, so
|
|
234
|
+
source ROS before running.
|
|
235
|
+
|
|
236
|
+
```bash
|
|
237
|
+
# from PyPI (once published)
|
|
238
|
+
pip install robodiag-harness # core (rich only)
|
|
239
|
+
pip install "robodiag-harness[all]" # + prompt_toolkit completion + openai agent
|
|
240
|
+
|
|
241
|
+
# from source / editable
|
|
242
|
+
pip install -e ".[all]"
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
> ROS 2 Humble images ship setuptools < 61 and may have no PyPI access. In that
|
|
246
|
+
> case build with the system setuptools instead of an isolated one:
|
|
247
|
+
>
|
|
248
|
+
> ```bash
|
|
249
|
+
> pip install --user --no-build-isolation ".[all]"
|
|
250
|
+
> ```
|
|
251
|
+
|
|
252
|
+
### Dependencies
|
|
253
|
+
|
|
254
|
+
- ROS 2 (tested on Humble; mostly distro-agnostic), Python 3.10
|
|
255
|
+
- `rich` (required)
|
|
256
|
+
- `prompt_toolkit` (optional, live completion)
|
|
257
|
+
- `openai` (optional, AI agent)
|
|
258
|
+
- `ros-humble-controller-manager-msgs` (optional, for ros2_control checks)
|
|
259
|
+
|
|
260
|
+
## REPL commands
|
|
261
|
+
|
|
262
|
+
```
|
|
263
|
+
/graph ROS graph summary
|
|
264
|
+
/diagnostics Standard /diagnostics status
|
|
265
|
+
/control ros2_control status
|
|
266
|
+
/check Composite read-only health check
|
|
267
|
+
/topic <topic> Snapshot one message from a topic
|
|
268
|
+
/sample <topic> [sec] [Hz] Sample a topic over time and compute statistics
|
|
269
|
+
/tests Test catalog
|
|
270
|
+
/run <test_id> Run a deterministic test (all read-only in v0.1)
|
|
271
|
+
/history [n] Recent n test runs
|
|
272
|
+
/safety Show the motion Safety Gate
|
|
273
|
+
/stop Software stop: zero cmd_vel + optional Trigger service
|
|
274
|
+
/help /quit
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
Any other input goes to the AI diagnostic agent (requires an API key).
|
|
278
|
+
|
|
279
|
+
### CLI flags
|
|
280
|
+
|
|
281
|
+
| Flag | Default | Purpose |
|
|
282
|
+
|---|---|---|
|
|
283
|
+
| `--controller-manager` | `/controller_manager` | controller_manager node namespace |
|
|
284
|
+
| `--cmd-vel-topic` | `/cmd_vel` | topic used by the software stop |
|
|
285
|
+
| `--estop-service` | *(none)* | optional `std_srvs/Trigger` E-stop service |
|
|
286
|
+
| `--db` | `~/.robodiag_ros2.db` | SQLite history path |
|
|
287
|
+
| `--model` | `deepseek-chat` | LLM model; overrides `DEEPSEEK_MODEL` |
|
|
288
|
+
| `--base-url` | `https://api.deepseek.com` | OpenAI-compatible base URL |
|
|
289
|
+
| `--api-key` | *(none)* | LLM API key (visible in `ps`/shell history) |
|
|
290
|
+
| `--api-key-file` | *(none)* | read the API key from a file (safer) |
|
|
291
|
+
|
|
292
|
+
## AI diagnostic agent
|
|
293
|
+
|
|
294
|
+
The agent runs a function-calling loop of at most 10 rounds. Each tool result is
|
|
295
|
+
fed back as structured JSON, and the final answer follows a fixed shape:
|
|
296
|
+
**symptom → evidence → root cause → recommendations**.
|
|
297
|
+
|
|
298
|
+
### Tools and risk layers
|
|
299
|
+
|
|
300
|
+
| Layer | Tool | What it does |
|
|
301
|
+
|---|---|---|
|
|
302
|
+
| Read-only | `inspect_graph` | Nodes, topics, services and types |
|
|
303
|
+
| Read-only | `get_diagnostics` | Cached standard `/diagnostics` statuses |
|
|
304
|
+
| Read-only | `inspect_ros2_control` | Controllers, hardware components, interfaces |
|
|
305
|
+
| Read-only | `get_topic_snapshot` | One message from any discovered topic |
|
|
306
|
+
| Read-only | `sample_topic` | Time-window sampling with statistics |
|
|
307
|
+
| Read-only | `list_tests` | Deterministic test catalog |
|
|
308
|
+
| Read-only | `run_test` | Run one deterministic health test |
|
|
309
|
+
| Read-only | `query_history` | Recent test runs from SQLite |
|
|
310
|
+
| Read-only | `check_motion_safety` | Run the deterministic Safety Gate |
|
|
311
|
+
| **Emergency** | `emergency_stop` | Software stop: zero Twist + optional Trigger service. **Never blocked.** |
|
|
312
|
+
|
|
313
|
+
v0.1 contains no write or motion tool, so there is nothing to confirm. When
|
|
314
|
+
motion extensions land, the Safety Gate and an explicit operator confirmation
|
|
315
|
+
will gate them.
|
|
316
|
+
|
|
317
|
+
### Configuration
|
|
318
|
+
|
|
319
|
+
The agent resolves its LLM settings with this precedence:
|
|
320
|
+
|
|
321
|
+
```
|
|
322
|
+
CLI flags > environment variables > ~/.robodiag.env > built-in defaults
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
`~/.robodiag.env`:
|
|
326
|
+
|
|
327
|
+
```bash
|
|
328
|
+
DEEPSEEK_API_KEY=sk-...
|
|
329
|
+
DEEPSEEK_BASE_URL=https://api.deepseek.com
|
|
330
|
+
DEEPSEEK_MODEL=deepseek-chat
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
One-off overrides, including non-DeepSeek providers (any OpenAI-compatible
|
|
334
|
+
endpoint):
|
|
335
|
+
|
|
336
|
+
```bash
|
|
337
|
+
./robodiag --model deepseek-reasoner
|
|
338
|
+
./robodiag --base-url https://dashscope.aliyuncs.com/compatible-mode/v1 --model qwen-max
|
|
339
|
+
./robodiag --api-key-file ~/.deepseek.key # safer than --api-key
|
|
340
|
+
```
|
|
341
|
+
|
|
342
|
+
> `--api-key` works but is visible in `ps` and shell history. Prefer
|
|
343
|
+
> `DEEPSEEK_API_KEY` in `~/.robodiag.env` (mode `600`) or `--api-key-file`.
|
|
344
|
+
|
|
345
|
+
### Health thresholds
|
|
346
|
+
|
|
347
|
+
| Variable | Default | Meaning |
|
|
348
|
+
|---|---|---|
|
|
349
|
+
| `ROBODIAG_MIN_BATTERY_PCT` | `0.10` | minimum battery percentage for motion |
|
|
350
|
+
| `ROBODIAG_MIN_BATTERY_V` | `0.0` | minimum battery voltage for motion |
|
|
351
|
+
| `ROBODIAG_MAX_DIAG_AGE_S` | `5.0` | max age of `/diagnostics` before it is stale |
|
|
352
|
+
| `ROBODIAG_MAX_JOINT_STATE_AGE_S` | `1.0` | max age of `/joint_states` before it is stale |
|
|
353
|
+
| `ROBODIAG_DB` | `~/.robodiag_ros2.db` | SQLite history path |
|
|
354
|
+
|
|
355
|
+
## Test catalog
|
|
356
|
+
|
|
357
|
+
| `test_id` | Checks | Outcomes |
|
|
358
|
+
|---|---|---|
|
|
359
|
+
| `graph_health` | Node/topic counts; presence of `/joint_states` | `FAIL` if only the harness node is visible; `WARN` if `/joint_states` is missing |
|
|
360
|
+
| `diagnostics_health` | `/diagnostics` freshness and levels | `SKIP` if none received; `FAIL` on stale or ERROR/STALE; `WARN` on WARN |
|
|
361
|
+
| `joint_states_health` | Samples `/joint_states`: rate, finite values, named joints | `WARN` on low rate / few samples / missing positions |
|
|
362
|
+
| `ros2_control_health` | `controller_manager` controllers, hardware, interfaces | `SKIP` if unavailable; `FAIL` if hardware is not active |
|
|
363
|
+
| `system_health` | Composite of the four tests above | Worst sub-result |
|
|
364
|
+
|
|
365
|
+
Every run is written to SQLite and can be inspected with `/history` or the
|
|
366
|
+
`query_history` tool.
|
|
367
|
+
|
|
368
|
+
## Design principles
|
|
369
|
+
|
|
370
|
+
1. **Evidence before reasoning.** The agent must gather real telemetry; it may
|
|
371
|
+
not invent hardware state from the robot model.
|
|
372
|
+
2. **Deterministic code decides writes.** The Safety Gate is plain code, is
|
|
373
|
+
fail-closed, and distinguishes *unhealthy* evidence from *missing* evidence.
|
|
374
|
+
"No data" is never treated as "normal".
|
|
375
|
+
3. **Structured results.** Evidence and tests are first-class objects
|
|
376
|
+
(`Evidence`, `TestResult`), not free-form strings.
|
|
377
|
+
|
|
378
|
+
## Contributing
|
|
379
|
+
|
|
380
|
+
Bug reports, documentation improvements, and robot integrations are welcome.
|
|
381
|
+
|
|
382
|
+
When reporting an issue, please include:
|
|
383
|
+
|
|
384
|
+
- Your robot model and ROS 2 distribution.
|
|
385
|
+
- The command or check you ran.
|
|
386
|
+
- What you expected and what happened.
|
|
387
|
+
- Relevant logs, with credentials and private information removed.
|
|
388
|
+
|
|
389
|
+
The v0.1 test catalog is intentionally read-only; new tests should follow the
|
|
390
|
+
same rule — deterministic, structured evidence, and no motion without a Safety
|
|
391
|
+
Gate precondition.
|
|
392
|
+
|
|
393
|
+
## License
|
|
394
|
+
|
|
395
|
+
Apache License 2.0 — see [LICENSE](LICENSE).
|
|
396
|
+
|
|
397
|
+
ROS and ROS 2 are trademarks of Open Robotics. This project is not affiliated
|
|
398
|
+
with or endorsed by Open Robotics or Intrinsic.
|