Skip to content

Update status_led.md - improvements to grammar #5511

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: current
Choose a base branch
from
Open

Update status_led.md - improvements to grammar #5511

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions content/components/light/status_led.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ params:
image: led-on.svg
---

The `status_led` light platform allows to share a single LED for indicating the status of
the device (when on error/warning state) or as binary light (when on OK state).
The `status_led` light platform allows a single LED to indicate the status of
the device (such as an error/warning state) or as a binary light (such as an OK state).
This is useful for devices with only one LED available.
You can also use a binary [Output Component](#output).

It provides the combined functionality of {{< docref "/components/status_led" "status_led component" >}} and a
{{< docref "/components/light/binary" "binary light component" >}} over a single shared GPIO led.

When the device is on error/warning state, the function of `status_led` will take precedence and control the blinking of the LED.
When the device is in error/warning state, the function of `status_led` will take precedence and control the blinking of the LED.
When the device is in OK state, the LED will be restored to the state of the `binary light` function and can be controlled as such.

```yaml
Expand All @@ -34,7 +34,7 @@ light:

## Configuration variables

- **pin** (*Optional*, [Pin Schema](#config-pin_schema)): The GPIO pin to operate the LED on.
- **pin** (*Optional*, [Pin Schema](#config-pin_schema)): The GPIO pin to control the LED on.
- **output** (*Optional*, [ID](#config-id)): The id of the binary [Output Component](#output) to use for this light.
- All other options from [Light](#config-light).

Expand Down
Loading