From b496e62bdc31331b505b555d3fd6a8088b4902af Mon Sep 17 00:00:00 2001 From: zvecr Date: Wed, 27 Dec 2023 00:03:51 +0000 Subject: [PATCH] Stub docs --- docs/_summary.md | 1 + docs/feature_lamparray.md | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 docs/feature_lamparray.md diff --git a/docs/_summary.md b/docs/_summary.md index bae93da5b6c..01b23a0a61a 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -84,6 +84,7 @@ * [EEPROM](feature_eeprom.md) * [Key Lock](feature_key_lock.md) * [Key Overrides](feature_key_overrides.md) + * [LampArray](feature_lamparray.md) * [Layers](feature_layers.md) * [One Shot Keys](one_shot_keys.md) * [OS Detection](feature_os_detection.md) diff --git a/docs/feature_lamparray.md b/docs/feature_lamparray.md new file mode 100644 index 00000000000..9ac8b5e74d6 --- /dev/null +++ b/docs/feature_lamparray.md @@ -0,0 +1,36 @@ +# LampArray + +Implements the open Human Interface Devices (HID) Lighting and Illumination standard. + +> LampArray devices have one or more Lamps (i.e. lights/LEDs/bulbs, etc…) that can be directly manipulated; setting state (on/off), brightness and color (RGB). + +Windows provides support for devices under [Dynamic Lighting](https://support.microsoft.com/en-us/windows/control-your-dynamic-lighting-devices-in-windows-8e8f22e3-e820-476c-8f9d-9ffc7b6ffcd2). + +## Overview + +Supported lighting frameworks: + +* [RGB Matrix](feature_rgb_matrix.md) + +Currently unsupported: + +* Split keyboard +* VUSB + +## Basic Configuration :id=basic-configuration + +To enable this feature, add the following to your `rules.mk`: + + LAMPARRAY_ENABLE = yes + +This should provide an out of the box experience, inferred from the existing keyboard and lighting framework configuration. + +## Advanced Configuration :id=advanced-configuration + +To change the default behavior, you can use the following defines in your `config.h` + +|Define |Default |Description | +|---------------|-------------|---------------| +|`X` |*Not defined*| | +|`Y` |*Not defined*| | +|`Z` |`7` | |