Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
caksoylar committed Jul 28, 2023
1 parent 5c56741 commit b351617
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions config/boards/shields/rgbled_widget/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# LED indicators using an RGB LED

This is a shield containing a simple widget that utilizes a (typically built-in) RGB LED controlled by three separate GPIOs.

By default this is supported by Xiao BLE and Xiao RP2040 boards, see overlays in the [`boards` folder](boards/).
You can also add support for your board/shield by defining `aliases` to the RGB LED node labels, similar to the examples in that folder.

Currently the widget does the following:
- Blink green/yellow/red on boot depending on battery level (for both central/peripherals), thresholds set by `CONFIG_RGBLED_WIDGET_BATTERY_LEVEL_{HIGH,LOW}`
- Blink red on every battery level read if below critical battery level (`CONFIG_RGBLED_WIDGET_BATTERY_LEVEL_CRITICAL`)
- Blink blue for connected, yellow for open, red for disconnected profile on profile switch (on central side)
- Blink blue for connection, red for disconnection on peripheral side

Blink durations can also be adjusted, see the [Kconfig file](Kconfig.defconfig).

0 comments on commit b351617

Please sign in to comment.