Skip to content

Commit

Permalink
Move features before install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
caksoylar authored Oct 14, 2024
1 parent 8ed0d99 commit 0e6817e
Showing 1 changed file with 23 additions and 21 deletions.
44 changes: 23 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,28 @@
This is a [ZMK module](https://zmk.dev/docs/features/modules) containing a simple widget that utilizes a (typically built-in) RGB LED controlled by three separate GPIOs.
It is used to indicate battery level and BLE connection status in a minimalist way.

## Usage
## Features

<details>
<summary>Short video demo</summary>
See below video for a short demo, running through power on, profile switching and power offs.

https://github.com/caksoylar/zmk-rgbled-widget/assets/7876996/cfd89dd1-ff24-4a33-8563-2fdad2a828d4
</details>

Currently the widget does the following:

- Blink 🟢/🟡/🔴 on boot depending on battery level (for both central/peripherals), thresholds set by `CONFIG_RGBLED_WIDGET_BATTERY_LEVEL_HIGH` and `CONFIG_RGBLED_WIDGET_BATTERY_LEVEL_LOW`
- Blink 🔴 on every battery level change if below critical battery level (`CONFIG_RGBLED_WIDGET_BATTERY_LEVEL_CRITICAL`)
- Blink 🔵 for connected, 🟡 for open (advertising), 🔴 for disconnected profiles on every BT profile switch (on central side for splits)
- Blink 🔵 for connected, 🔴 for disconnected on peripheral side of splits

If you enable `CONFIG_RGBLED_WIDGET_SHOW_LAYER_CHANGE`, the LED will show the highest active layer on every layer activation
using a sequence of N cyan color blinks, where N is the zero-based index of the layer.

In addition, there are keymap behaviors you can use to show the status on demand, see [below](#showing-status-on-demand).

## Installation

To use, first add this module to your `config/west.yml` by adding a new entry to `remotes` and `projects`:

Expand Down Expand Up @@ -40,26 +61,7 @@ include:

For other keyboards, see the "Adding support" section below.

## Features

<details>
<summary>Short video demo</summary>
See below video for a short demo, running through power on, profile switching and power offs.

https://github.com/caksoylar/zmk-rgbled-widget/assets/7876996/cfd89dd1-ff24-4a33-8563-2fdad2a828d4
</details>

Currently the widget does the following:

- Blink 🟢/🟡/🔴 on boot depending on battery level (for both central/peripherals), thresholds set by `CONFIG_RGBLED_WIDGET_BATTERY_LEVEL_HIGH` and `CONFIG_RGBLED_WIDGET_BATTERY_LEVEL_LOW`
- Blink 🔴 on every battery level change if below critical battery level (`CONFIG_RGBLED_WIDGET_BATTERY_LEVEL_CRITICAL`)
- Blink 🔵 for connected, 🟡 for open (advertising), 🔴 for disconnected profiles on every BT profile switch (on central side for splits)
- Blink 🔵 for connected, 🔴 for disconnected on peripheral side of splits

In addition, you can enable `CONFIG_RGBLED_WIDGET_SHOW_LAYER_CHANGE` to show the highest active layer on every layer activation
using a sequence of N cyan color blinks, where N is the zero-based index of the layer.

### Showing status on demand
## Showing status on demand

This module also defines keymap [behaviors](https://zmk.dev/docs/keymaps/behaviors) to let you show battery or connection status on demand:

Expand Down

0 comments on commit 0e6817e

Please sign in to comment.