Skip to content

Commit

Permalink
style(pre-commit): autofix
Browse files Browse the repository at this point in the history
  • Loading branch information
pre-commit-ci[bot] authored and xmfcx committed Nov 19, 2024
1 parent 8e5d34a commit ccf1775
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/how-to-guides/configuring-system-error-monitor.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,29 @@
# Configuring System Error Monitor

## Overview

Although Autoware repository has CI tests to do integration testing, there are always unkown error causing function failure.

Check warning on line 5 in docs/how-to-guides/configuring-system-error-monitor.md

View workflow job for this annotation

GitHub Actions / spell-check-differential

Misspelled word (unkown) Suggestions: (unknown*)
This may include:
* Nodes terminates abnormally
* Nodes freezes without crashing and stops publishing message or causes drop in publish rate of message.
* Nodes functioning beyond it's designed state (e.g., losing its localization pose, large deviation from planned trajectory, etc)

- Nodes terminates abnormally
- Nodes freezes without crashing and stops publishing message or causes drop in publish rate of message.
- Nodes functioning beyond it's designed state (e.g., losing its localization pose, large deviation from planned trajectory, etc)

In order to detect such failure and trigger minimum risk manuever, we have system monitoring module.
This page explains how users can configure `system_error_monitor` for Autoware for their use case.

## Configuring Parameters

### Turning on Emergency Handler function

By default, Contorl module will ignore any emergency control sent from System Monitor Module.

Check warning on line 19 in docs/how-to-guides/configuring-system-error-monitor.md

View workflow job for this annotation

GitHub Actions / spell-check-differential

Unknown word (Contorl)
This is because it is not always safe to make a sudden stop at node failure, and we would like the user to be aware of the function when it is turned on.

In order to turn on its function, modify `use_emergency_handling` parameter to true in [vehicle_cmd_gate](https://github.com/autowarefoundation/autoware.universe/tree/main/control/vehicle_cmd_gate) package.
For example, if you are using autoware.launch.xml to launch Autoware, modify the parameter in this [file](https://github.com/autowarefoundation/autoware_launch/blob/main/autoware_launch/config/control/vehicle_cmd_gate/vehicle_cmd_gate.param.yaml).

### Adding new topic monitoring

By default, only few of the topics are monitored as default.
You can add new topic monitor by modifying `topics.yaml` file passed to [component_state_monitor](https://github.com/autowarefoundation/autoware.universe/tree/main/system/component_state_monitor) launch file.

Expand Down

0 comments on commit ccf1775

Please sign in to comment.