Added board definition for nyquist and add RGB and LED pins for nyquest and iris
This commit is contained in:
Kyle Brown
@@ -8,26 +8,9 @@ when you release the layer key. The example uses the MO though any layer switch
|
||||
LAYER_1 key in your keymap, and it's ready to go! You can change animations, colors, or anything in there.
|
||||
|
||||
```python
|
||||
from kmk.handlers.layers import (mo_pressed, mo_released)
|
||||
from kmk.keys import KC, layer_key_validator, make_argumented_key
|
||||
|
||||
|
||||
def layer1p(*args, **kwargs):
|
||||
keyboard.pixels.set_hsv_fill(100, 100, 100)
|
||||
return mo_pressed(*args, **kwargs)
|
||||
|
||||
|
||||
def layer1r(*args, **kwargs):
|
||||
keyboard.pixels.set_hsv_fill.fill(0, 0, 0)
|
||||
return mo_released(*args, **kwargs)
|
||||
|
||||
make_argumented_key(
|
||||
validator=layer_key_validator,
|
||||
names=('LAYER_1',),
|
||||
on_press=layer1p,
|
||||
on_release=layer1r,
|
||||
)
|
||||
|
||||
LAYER_1 = KC.LAYER_1(1)
|
||||
LAYER_1 = KC.MO(1)
|
||||
LAYER_1.after_press_handler(lambda *args, **kwargs: keyboard.pixels.set_hsv_fill(100, 100, 100))
|
||||
LAYER_1.after_release_handler(lambda *args, **kwargs: keyboard.pixels.set_hsv_fill(0, 0, 0))
|
||||
|
||||
keyboard.keymap = [ ....... LAYER_1 ....... ]
|
||||
```
|
||||
@@ -4,12 +4,13 @@
|
||||
| ----- | ------- | --------------- | ----- |
|
||||
| [Adafruit Feather M4 Express](https://www.adafruit.com/product/3857) | Atmel SAMD51 (Cortex M4F) | CircuitPython | An economical solution for basic USB keyboards |
|
||||
| [Adafruit ItsyBitsy M4 Express](https://www.adafruit.com/product/3800) | Atmel SAMD51 (Cortex M4F) | CircuitPython | A smaller solution for basic USB keyboards |
|
||||
| [Adafruit Feather NRF52840 Express](https://www.adafruit.com/product/4062) | Cortex M4F/nrf52840 | CircuitPython | Supports USB HID and soon BLE (Bluetooth) |
|
||||
| [Seeed nRF52840 Micro Dev Kit](https://www.seeedstudio.com/nRF52840-Micro-Development-Kit-p-3079.html) | M4F/nrf52840 | CircuitPython | Supports USB HID and soon BLE (Bluetooth) |
|
||||
|
||||
|
||||
## Support Planned/WIP
|
||||
| Board | Chipset | Python Platform | Notes |
|
||||
| ----- | ------- | --------------- | ----- |
|
||||
| [Seeed nRF52840 Micro Dev Kit](https://www.seeedstudio.com/nRF52840-Micro-Development-Kit-p-3079.html) | nRF52840 | [CircuitPython](https://github.com/KMKfw/circuitpython/tree/topic-nrf52840-mdk) | This is basically as bleeding edge as it gets. Will support BLE HID to PC as well as BLE split boards |
|
||||
| [Planck rev6 Keyboard](https://olkb.com/planck) | STM32F303 | CircuitPython | Requires porting CircuitPython to STM32F3. |
|
||||
| [Proton C Controller?](https://olkb.com/parts/qmk-proton-c) | STM32F303CCT6 | CircuitPython | Requires porting CircuitPython to STM32F3. |
|
||||
|
||||
@@ -20,7 +21,7 @@ Pull requests are welcome and encouraged to add support for new
|
||||
keyboards/microcontrollers. The base requirements for device support
|
||||
- CircuitPython
|
||||
- 256KB of flash storage
|
||||
- HID over USB or Bluetooth.
|
||||
- HID over USB and/or Bluetooth.
|
||||
|
||||
## Secondary Support
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
> can be found in `keycodes.md`. It's probably worth a look at the raw source if
|
||||
> you're stumped: `kmk/keys.py`.
|
||||
|
||||
This is a bunch of documentation about how physical keypress translate to
|
||||
This is a bunch of documentation about how a physical keypress translates to
|
||||
events (and the lifecycle of said events) in KMK. It's somewhat technical, but
|
||||
if you're looking to extend your keyboard's functionality with extra code,
|
||||
you'll need at least some of this technical knowledge.
|
||||
|
||||
16
docs/led.md
16
docs/led.md
@@ -1,15 +1,6 @@
|
||||
# LED (Mono color backlight)
|
||||
Want your keyboard to shine? Add some lights!
|
||||
|
||||
## Usage
|
||||
At minimum you will need to make sure that this set in either your keymap is importing an MCU directly, or it should be included in the predefined boards if they support them.
|
||||
|
||||
|Define |Description |
|
||||
|---------------------|---------------------------------------------|
|
||||
|`keyboard.led_pin` |The pin connected to the data pin of the LEDs|
|
||||
|
||||
Then you should be able to use the keycodes below to change the LED lighting to your liking.
|
||||
|
||||
## [Keycodes]
|
||||
|
||||
|Key |Aliases |Description |
|
||||
@@ -52,3 +43,10 @@ If you want to create your own animations, or for example, change the lighting i
|
||||
|`keyboard.led.animation_mode` |`static` |This can be changed to any modes included, or to something custom for user animations. Any string is valid |
|
||||
|`keyboard.led.animation_speed` |`1` |Increases animation speed of most animations. Recommended 1-5, Maximum 10. |
|
||||
|
||||
# Troubleshooting
|
||||
Make sure that your board supports LED backlight by checking for a line with "LED_PIN". If it does not, you can add it to your keymap.
|
||||
|
||||
|Define |Description |
|
||||
|---------------------|---------------------------------------------|
|
||||
|`keyboard.led_pin` |The pin connected to the data pin of the LEDs|
|
||||
|
||||
|
||||
21
docs/rgb.md
21
docs/rgb.md
@@ -11,16 +11,6 @@ Currently we support the following addressable LEDs:
|
||||
* SK6812, SK6812MINI, SK6805
|
||||
* All neopixels
|
||||
|
||||
## Usage
|
||||
At minimum you will need to make sure that these are set in either your keymap is importing an MCU directly, or it should be included in the predefined boards if they support them.
|
||||
|
||||
|Define |Description |
|
||||
|---------------------|---------------------------------------------|
|
||||
|`keyboard.pixel_pin` |The pin connected to the data pin of the LEDs|
|
||||
|`keyboard.num_pixels`|The number of LEDs connected |
|
||||
|
||||
Then you should be able to use the keycodes below to change the RGB lighting to your liking.
|
||||
|
||||
### Color Selection
|
||||
|
||||
KMK uses [Hue, Saturation, and Value](https://en.wikipedia.org/wiki/HSL_and_HSV) to select colors rather than RGB. The color wheel below demonstrates how this works.
|
||||
@@ -116,4 +106,13 @@ keyboard.pixels.neopixel() # <-- This is the neopixel object
|
||||
If your colors are incorrect, check the pixel order of your specific LED's. Here are some common ones.
|
||||
* WS2811, WS2812, WS2812B, WS2812C are all GRB (1, 0, 2)
|
||||
* SK6812, SK6812MINI, SK6805 are all GRB (1, 0, 2)
|
||||
* Neopixels will vary depending on which one you buy. It will be listed on the product page.
|
||||
* Neopixels will vary depending on which one you buy. It will be listed on the product page.# Troubleshooting
|
||||
|
||||
### Lights don't turn on
|
||||
Make sure that your board supports LED backlight by checking for a line with "PIXEL_PIN". If it does not, you can add it to your keymap.
|
||||
If you added the LED's yourself, you will also need to set num_pixels to the number of installed LED's in total.
|
||||
|
||||
|Define |Description |
|
||||
|---------------------|---------------------------------------------|
|
||||
|`keyboard.pixel_pin` |The pin connected to the data pin of the LEDs|
|
||||
|`keyboard.num_pixels`|The number of LEDs connected |
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
# Support
|
||||
If you are having any issues in installing, configuring, or otherwise issues with KMK, please reach out to us and
|
||||
our community here. We do have a bridge to allow communication between the platforms as well, though we recommend
|
||||
using Matrix if possible.
|
||||
our community here.
|
||||
|
||||
# Matrix
|
||||
* [Software Support](https://matrix.to/#/#kmk-support:kmkfw.io)
|
||||
|
||||
Reference in New Issue
Block a user