Skip to content

Commit ac97a0c

Browse files
authored
formatting fixes from PR324 (#327)
1 parent b169c12 commit ac97a0c

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

diagnostic_aggregator/README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The robot has two of each, one on each side.
1414
The robot also 4 camera sensors, one left and one right and one in the front and one in the back.
1515
These are all the available diagnostic sources:
1616

17-
```
17+
```
1818
/arms/left/motor
1919
/arms/right/motor
2020
/legs/left/motor
@@ -119,6 +119,9 @@ Additional parameters depend on the type of the analyzer.
119119
Any diagnostic item that is not matched by any analyzer will be published by an "Other" analyzer.
120120
Items created by the "Other" analyzer will go stale after 5 seconds.
121121

122+
The `critical` parameter makes the aggregator react immediately to a degradation in diagnostic state.
123+
This is useful if the toplevel state is parsed by a watchdog for example.
124+
122125
## Launching
123126
You can launch the `aggregator_node` like this (see [example.launch.py.in](example/example.launch.py.in)):
124127
``` python
@@ -186,4 +189,4 @@ This means that things that are ignored by the `IgnoreAnalyzer` will still be pu
186189
- `analyzers` (map, default: {}) - The analyzers that will be used to aggregate the diagnostics
187190

188191
# Tutorials
189-
TODO: Port tutorials #contributions-welcome
192+
TODO: Port tutorials #contributions-welcome

diagnostic_aggregator/mainpage.dox

+5-4
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ See Analyzer for more information on the base class.
1616

1717
\subsubsection generic_analyzer GenericAnalyzer
1818

19-
\b generic_analyzer holds the GenericAnalyzer class, which is the most basic of the Analyzer's. It is used by the diagnostic_aggregator/Aggregator to store, process and republish diagnostics data. The GenericAnalyzer is loaded by the pluginlib as a Analyzer plugin. It is the most basic of all Analyzer's.
19+
\b generic_analyzer holds the GenericAnalyzer class, which is the most basic of the Analyzer's. It is used by the diagnostic_aggregator/Aggregator to store, process and republish diagnostics data. The GenericAnalyzer is loaded by the pluginlib as a Analyzer plugin. It is the most basic of all Analyzer's.
2020

2121
\subsubsection analyzer_group AnalyzerGroup
2222

@@ -37,10 +37,10 @@ aggregator_node subscribes to "/diagnostics" and publishes an aggregated set of
3737
\subsubsection topics ROS topics
3838

3939
Subscribes to:
40-
- \b "/diagnostics": [diagnostics_msgs/DiagnosticArray]
40+
- \b "/diagnostics": [diagnostics_msgs/DiagnosticArray]
4141

4242
Publishes to:
43-
- \b "/diagnostics_agg": [diagnostics_msgs/DiagnosticArray]
43+
- \b "/diagnostics_agg": [diagnostics_msgs/DiagnosticArray]
4444

4545
\subsubsection parameters ROS parameters
4646

@@ -49,6 +49,7 @@ Reads the following parameters from the parameter server
4949
- \b "~pub_rate" : \b double [optional] Rate that output diagnostics published
5050
- \b "~base_path" : \b double [optional] Prepended to all analyzed output
5151
- \b "~analyzers" : \b {} Configuration for loading analyzers
52+
- \b "~critical" : \b bool [optional] React immediately to a degradation in diagnostic state
5253

5354
\subsection analyzer_loader analyzer_loader
5455

@@ -61,4 +62,4 @@ Reads the following parameters from the parameter server
6162
- \b "~analyzers" : \b {} Configuration for loading and testing analyzers
6263

6364

64-
*/
65+
*/

0 commit comments

Comments
 (0)