From 0e6817e72f9cfbf1b1db1ef9ecdce29810ba6ff8 Mon Sep 17 00:00:00 2001 From: Cem Aksoylar Date: Mon, 14 Oct 2024 10:16:30 -0700 Subject: [PATCH] Move features before install instructions --- README.md | 44 +++++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index d85528d..6c3d440 100644 --- a/README.md +++ b/README.md @@ -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 + +
+ Short video demo + 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 +
+ +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`: @@ -40,26 +61,7 @@ include: For other keyboards, see the "Adding support" section below. -## Features - -
- Short video demo - 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 -
- -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: