@@ -52,9 +52,22 @@ curl http://localhost:8080/api/v1/apps/move_group/faults
5252# → the aborted MoveGroup goal, as a structured fault with its snapshot
5353```
5454
55- ** The point:** ros2_medkit reads the signals your stack already emits - aborted actions,
56- ` /rosout ` errors, ` /diagnostics ` - through drop-in bridges. You add nothing to Nav2, MoveIt,
57- or your own nodes; you get a remote, queryable, time-traveled fault instead of a log line.
55+ ** Two ways to feed it:**
56+
57+ - ** Native, for code you own** - report faults directly with the
58+ [ ` FaultReporter ` ] ( https://github.com/selfpatch/ros2_medkit/tree/main/src/ros2_medkit_fault_reporter )
59+ client. This is the richest path (your own codes, severities and context) and the canonical way
60+ for new code; see the
61+ [ integration tutorial] ( https://selfpatch.github.io/ros2_medkit/tutorials/integration.html ) .
62+ - ** Drop-in bridges, for the stack you will not rewrite** - most real robots run huge existing
63+ projects nobody is going to retrofit with diagnostics. Point the bridges at what they already
64+ emit and you get structured faults (and states) in minutes, zero code changes:
65+ [ ` /diagnostics ` ] ( https://github.com/selfpatch/ros2_medkit/tree/main/src/ros2_medkit_diagnostic_bridge ) ,
66+ [ ` /rosout ` logs] ( https://github.com/selfpatch/ros2_medkit/tree/main/src/ros2_medkit_log_bridge ) ,
67+ [ aborted actions] ( https://github.com/selfpatch/ros2_medkit/tree/main/src/ros2_medkit_action_status_bridge ) .
68+
69+ So you get a remote, queryable, time-traveled fault instead of a log line - whether or not you
70+ touch the node's code.
5871
5972## vs. standard ROS 2 diagnostics
6073
@@ -63,7 +76,7 @@ current node health to a desktop GUI. ros2_medkit turns that into a queryable, r
6376time-traveled, actionable fault - and it ** consumes ` /diagnostics ` too** , so it is additive,
6477not a rip-and-replace.
6578
66- | | ROS 2 diagnostics | ros2_medkit |
79+ | | 🔴 ROS 2 diagnostics | 🟢 ros2_medkit |
6780| ---| ---| ---|
6881| Access | ` /diagnostics ` topic + rqt GUI (local desktop) | SOVD REST API (remote; any tool / dashboard / agent) |
6982| Instrumentation | required (` diagnostic_updater ` in node code) | works without it - drop-in bridges (` /rosout ` , action status, ` /diagnostics ` passthrough) |
0 commit comments