Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readmes from ros2 upstream #346

Merged
merged 11 commits into from
Jun 14, 2024
Binary file added panther_lights/.docs/AUTONOMOUS_ACTION.webp
Binary file not shown.
Binary file added panther_lights/.docs/BATTERY_STATE.webp
Binary file not shown.
Binary file added panther_lights/.docs/CHARGING_BATTERY.webp
Binary file not shown.
Binary file added panther_lights/.docs/CRITICAL_BATTERY.webp
Binary file not shown.
Binary file added panther_lights/.docs/ERROR.webp
Binary file not shown.
Binary file added panther_lights/.docs/E_STOP.webp
Binary file not shown.
Binary file added panther_lights/.docs/GOAL_ACHIEVED.webp
Binary file not shown.
Binary file added panther_lights/.docs/LOW_BATTERY.webp
Binary file not shown.
Binary file added panther_lights/.docs/MANUAL_ACTION.webp
Binary file not shown.
Binary file added panther_lights/.docs/READY.webp
Binary file not shown.
22 changes: 11 additions & 11 deletions panther_lights/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,17 +150,17 @@ The `led_animations` section contains list with definitions for various animatio

Default animations can be found in the table below:

| ID | NAME | PRIORITY | DESCRIPTION |
| :-: | ----------------- | :------: | ----------------------------------------------------------- |
| 0 | E_STOP | 3 | red expanding from the center to the edges |
| 1 | READY | 3 | green expanding from center to the edges |
| 2 | ERROR | 1 | red, whole bumper blinking twice |
| 3 | MANUAL_ACTION | 3 | blue expanding from the center to the edges |
| 4 | AUTONOMOUS_ACTION | 3 | orange expanding from center to the edges |
| 5 | GOAL_ACHIEVED | 2 | purple, whole bumper blinking three times |
| 6 | LOW_BATTERY | 2 | two orange stripes moving towards the center, repeats twice |
| 7 | CRITICAL_BATTERY | 2 | two red stripes moving towards the center, repeats twice |
| 9 | CHARGING_BATTERY | 3 | whole bumper blinks with a duty cycle proportional to the Battery percentage. Short blinking means low Battery, and no blinking means full Battery. The color changes from red to green |
| ID | NAME | PRIORITY | ANIMATION |
| :---: | ----------------- | :------: | --------------------------------------------------------------------------------------------------------------------- |
| 0 | E_STOP | 3 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/E_STOP.webp" width="400"> |
| 1 | READY | 3 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/READY.webp" width="400"> |
| 2 | ERROR | 1 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/ERROR.webp" width="400"> |
| 3 | MANUAL_ACTION | 3 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/MANUAL_ACTION.webp" width="400"> |
| 4 | AUTONOMOUS_ACTION | 3 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/AUTONOMOUS_ACTION.webp" width="400"> |
| 5 | GOAL_ACHIEVED | 2 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/GOAL_ACHIEVED.webp" width="400"> |
| 6 | LOW_BATTERY | 2 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/LOW_BATTERY.webp" width="400"> |
| 7 | CRITICAL_BATTERY | 2 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/CRITICAL_BATTERY.webp" width="400"> |
| 9 | CHARGING_BATTERY | 3 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/CHARGING_BATTERY.webp" width="400"> |
Comment on lines +153 to +163
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add alt text to images for accessibility.

- <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/E_STOP.webp" width="400">
+ <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/E_STOP.webp" alt="E_STOP Animation" width="400">

Please apply similar changes to all image links in the table.

Committable suggestion was skipped due to low confidence.

Tools
Markdownlint

155-155: null (MD045, no-alt-text)
Images should have alternate text (alt text)


156-156: null (MD045, no-alt-text)
Images should have alternate text (alt text)


157-157: null (MD045, no-alt-text)
Images should have alternate text (alt text)


158-158: null (MD045, no-alt-text)
Images should have alternate text (alt text)


159-159: null (MD045, no-alt-text)
Images should have alternate text (alt text)


160-160: null (MD045, no-alt-text)
Images should have alternate text (alt text)


161-161: null (MD045, no-alt-text)
Images should have alternate text (alt text)


162-162: null (MD045, no-alt-text)
Images should have alternate text (alt text)


163-163: null (MD045, no-alt-text)
Images should have alternate text (alt text)


### Animation Types

Expand Down
Loading