Skip to content

Commit

Permalink
formatting fixes from PR324
Browse files Browse the repository at this point in the history
  • Loading branch information
ct2034 committed Jan 18, 2024
1 parent b169c12 commit 1007b26
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
7 changes: 5 additions & 2 deletions diagnostic_aggregator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The robot has two of each, one on each side.
The robot also 4 camera sensors, one left and one right and one in the front and one in the back.
These are all the available diagnostic sources:

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

The `critical` parameter makes the aggregator react immediately to a degradation in diagnostic state.
This is useful if the toplevel state is parsed by a watchdog for example.

## Launching
You can launch the `aggregator_node` like this (see [example.launch.py.in](example/example.launch.py.in)):
``` python
Expand Down Expand Up @@ -186,4 +189,4 @@ This means that things that are ignored by the `IgnoreAnalyzer` will still be pu
- `analyzers` (map, default: {}) - The analyzers that will be used to aggregate the diagnostics

# Tutorials
TODO: Port tutorials #contributions-welcome
TODO: Port tutorials #contributions-welcome
9 changes: 5 additions & 4 deletions diagnostic_aggregator/mainpage.dox
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ See Analyzer for more information on the base class.

\subsubsection generic_analyzer GenericAnalyzer

\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.
\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.

\subsubsection analyzer_group AnalyzerGroup

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

Subscribes to:
- \b "/diagnostics": [diagnostics_msgs/DiagnosticArray]
- \b "/diagnostics": [diagnostics_msgs/DiagnosticArray]

Publishes to:
- \b "/diagnostics_agg": [diagnostics_msgs/DiagnosticArray]
- \b "/diagnostics_agg": [diagnostics_msgs/DiagnosticArray]

\subsubsection parameters ROS parameters

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

\subsection analyzer_loader analyzer_loader

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


*/
*/

0 comments on commit 1007b26

Please sign in to comment.