diff --git a/README.md b/README.md index 21b9802..50d1cd7 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ KMK is a feature-rich and beginner-friendly firmware for computer keyboards written and configured in [CircuitPython](https://github.com/adafruit/circuitpython). **KMK is currently -in public beta, however should handle almost all workflows without major -issues**. +in public beta, and transitioning to a new core, however should handle almost +all workflows without major issues**. You can always find the latest releases on our CDN, in [compiled and optimized](https://cdn.kmkfw.io/kmk-latest.zip) and [raw, hackable text diff --git a/boards/crkbd/main.py b/boards/crkbd/main.py index 3723479..1997429 100644 --- a/boards/crkbd/main.py +++ b/boards/crkbd/main.py @@ -6,7 +6,7 @@ from kmk.modules.split import Split, SplitSide, SplitType keyboard = KMKKeyboard() -# Adding extentions +# Adding extensions rgb = RGB(pixel_pin=rgb_pixel_pin, num_pixels=27, val_limit=100, hue_default=190, sat_default=100, val_default=5) # TODO Comment one of these on each side diff --git a/boards/lily58/main.py b/boards/lily58/main.py index 3396075..9feedd9 100644 --- a/boards/lily58/main.py +++ b/boards/lily58/main.py @@ -22,7 +22,7 @@ RGB_SAD = KC.RGB_SAD RGB_VAI = KC.RGB_VAI RGB_VAD = KC.RGB_VAD -# Adding extentions +# Adding extensions rgb = RGB(pixel_pin=rgb_pixel_pin, num_pixels=27, val_limit=100, hue_default=190, sat_default=100, val_default=5) # TODO Comment one of these on each side diff --git a/boards/reviung39/main.py b/boards/reviung39/main.py index 5144f81..219861b 100644 --- a/boards/reviung39/main.py +++ b/boards/reviung39/main.py @@ -6,7 +6,7 @@ from kmk.modules.modtap import ModTap keyboard = KMKKeyboard() -# Adding extentions +# Adding extensions rgb = RGB(pixel_pin=keyboard.rgb_pixel_pin, num_pixels=keyboard.rgb_num_pixels, val_limit=100, hue_default=190, sat_default=100, val_default=5) modtap = ModTap() diff --git a/boards/reviung41/main.py b/boards/reviung41/main.py index db632d2..e99554e 100644 --- a/boards/reviung41/main.py +++ b/boards/reviung41/main.py @@ -6,7 +6,7 @@ from kmk.modules.modtap import ModTap keyboard = KMKKeyboard() -# Adding extentions +# Adding extensions rgb = RGB(pixel_pin=keyboard.rgb_pixel_pin, num_pixels=keyboard.rgb_num_pixels, val_limit=100, hue_default=190, sat_default=100, val_default=5) modtap = ModTap() diff --git a/boards/tg4x/main.py b/boards/tg4x/main.py index 4105350..39aa149 100644 --- a/boards/tg4x/main.py +++ b/boards/tg4x/main.py @@ -9,7 +9,7 @@ keyboard = KMKKeyboard() _______ = KC.TRNS XXXXXXX = KC.NO -# Adding extentions +# Adding extensions rgb = RGB(pixel_pin=keyboard.rgb_pixel_pin, num_pixels=keyboard.rgb_num_pixels, val_limit=100, hue_default=190, sat_default=100, val_default=5) layers_ext = Layers() diff --git a/docs/Offiially_Supported_Microcontrollers.md b/docs/Offiially_Supported_Microcontrollers.md index 078a308..e21c649 100644 --- a/docs/Offiially_Supported_Microcontrollers.md +++ b/docs/Offiially_Supported_Microcontrollers.md @@ -13,7 +13,7 @@ Features include Downsides - $25 USD per microcontroller at most retailers -Recommended Retailers +Common Retailers [Boardsource](https://boardsource.xyz/store/5f4a1733bbaa5c635b83ed67) [NiceKeyboards](https://nicekeyboards.com/collections/group-buy/products/nice-nano-v1-0). @@ -26,9 +26,21 @@ Downsides - Needs adapted to work with Pro Micro pinout keyboards. Adapter can be found [HERE](https://github.com/KMKfw/kmk_firmware/tree/master/hardware) -Recommended Retailers +Common Retailers [Adafruit](https://www.adafruit.com/product/3800) +## RP2040 +Features include +- Very affordable +- Very powerful for the price + +Downsides +- Little support for keyboard kits + +Common Retailers +[Adafruit](https://www.adafruit.com/pico?src=raspberrypi) +[Sparkfun](https://www.sparkfun.com/products/17829?src=raspberrypi) + ## Adafruit ItsyBitsy nRF52840 Express Features include - Both USB HID and Bluetooth support @@ -40,6 +52,9 @@ Downsides - No battery support without addon board found [HERE](https://www.adafruit.com/product/2124) +Common Retailers +[Adafruit](https://www.adafruit.com/product/4481) + ## Other microcontrollers What you'll need to have at minimum - CircuitPython/KMKpython diff --git a/docs/ble_hid.md b/docs/ble_hid.md index 94f211e..368e07b 100644 --- a/docs/ble_hid.md +++ b/docs/ble_hid.md @@ -18,7 +18,7 @@ if __name__ == '__main__': keyboard.go(hid_type=HIDModes.BLE) ``` -## Changing the advertisee name +## Changing the advertise name There are two ways to change the advertising name. The first would be to [change the name of the drive](https://learn.adafruit.com/welcome-to-circuitpython/the-circuitpy-drive). The second would be to change the keyboard.go() like this. diff --git a/docs/extensions.md b/docs/extensions.md index b93e4a7..daba745 100644 --- a/docs/extensions.md +++ b/docs/extensions.md @@ -4,7 +4,7 @@ the keyboard. They are meant to be easy to add, and create your own. These live a sandbox to help prevent any bad code from crashing your keyboard. ## Core Extensions -These extensions are proveded in all builds and can be enabled. Currently offered +These extensions are provided in all builds and can be enabled. Currently offered extensions are - [International](international.md): Adds international keycodes diff --git a/docs/international.md b/docs/international.md index d61dac9..218d72c 100644 --- a/docs/international.md +++ b/docs/international.md @@ -1,6 +1,6 @@ # International Keycodes -International extention adds keys for non US layouts. It can simply be added to -the extentions list. +International extension adds keys for non US layouts. It can simply be added to +the extensions list. ```python from kmk.extensions.international import International diff --git a/docs/layers.md b/docs/layers.md index b34fb9c..7c59169 100644 --- a/docs/layers.md +++ b/docs/layers.md @@ -1,6 +1,6 @@ # Layers Layers module adds keys for accessing other layers. It can simply be added to - the extentions list. + the extensions list. ```python from kmk.modules.layers import Layers diff --git a/docs/led.md b/docs/led.md index 2d0b8b0..be03a1e 100644 --- a/docs/led.md +++ b/docs/led.md @@ -1,8 +1,8 @@ # LED (Mono color backlight) Want your keyboard to shine? Add some lights! -## Enabling the extention -The only required values that you need to give the LED extention would be the +## Enabling the extension +The only required values that you need to give the LED extension would be the pixel pin, and the number of pixels/LED's. If using a split keyboard, this number is per side, and not the total of both sides. ```python @@ -28,7 +28,7 @@ keyboard.extensions.append(led_ext) ## Configuration All of these values can be set by default for when the keyboard boots. ```python -from kmk.extentions.led import AnimationModes +from kmk.extensions.led import AnimationModes led_ext = LED( led_pin=led_pin, brightness_step=5, diff --git a/docs/media_keys.md b/docs/media_keys.md index af9f56e..1091a4d 100644 --- a/docs/media_keys.md +++ b/docs/media_keys.md @@ -1,6 +1,6 @@ # Media Keys -Media keys extention adds keys for common media control keys. It can simply be -added to the extentions list. +Media keys extension adds keys for common media control keys. It can simply be +added to the extensions list. ```python from kmk.extensions.media_keys import MediaKeys diff --git a/docs/porting_to_kmk.md b/docs/porting_to_kmk.md index fedf675..912e53a 100644 --- a/docs/porting_to_kmk.md +++ b/docs/porting_to_kmk.md @@ -6,7 +6,7 @@ import board from kmk.kmk_keyboard import KMKKeyboard as _KMKKeyboard from kmk.matrix import DiodeOrientation -{EXTENTIONS_IMPORT} +{EXTENSIONS_IMPORT} class KMKKeyboard(_KMKKeyboard): {REQUIRED} @@ -23,11 +23,11 @@ colums and the diode direction (if any), should be defined like this diode_orientation = DiodeOrientation.COLUMNS ``` -## Additional pins for extentions -KMK includes built in extentions for RGB and split keyboards, and powersave. If +## Additional pins for extensions +KMK includes built in extensions for RGB and split keyboards, and powersave. If these are applicible on your keyboard/microcontroller, the pins should be added -here. Refer to the instructions on the respective extentions page on how to add -them. If not adding any extentions, leave this as an empty list as shown. +here. Refer to the instructions on the respective extensions page on how to add +them. If not adding any extensions, leave this as an empty list as shown. # Coord mapping If your keyboard is not built electrically as a square (though most are), you can @@ -50,7 +50,7 @@ from kmk.matrix import intify_coordinate as ic ## Keymaps Keymaps are organized as a list of lists. Keycodes are added for every key on each layer. See [keycodes](keycodes.md) for more details on what keycodes are -avaliable. If using layers or other extentions, also refer to the extentions +avaliable. If using layers or other extensions, also refer to the extensions page for additional keycodes. ```python from kb import KMKKeyboard diff --git a/docs/power.md b/docs/power.md index 9df0e05..19757a2 100644 --- a/docs/power.md +++ b/docs/power.md @@ -9,7 +9,7 @@ based keyboards. |`KC.PS_ON ` |Turns powersave on | |`KC.PS_OFF ` |Turns powersave off | -# Enabling the extention +# Enabling the extension To turn on basic power saving, this is all that is required. ```python from kmk.modules.power import Power diff --git a/docs/rgb.md b/docs/rgb.md index b0b508a..458705d 100644 --- a/docs/rgb.md +++ b/docs/rgb.md @@ -105,7 +105,7 @@ If you want to create your own animations, or for example, change the lighting i |`keyboard.pixels.animation_speed` |`1` |Increases animation speed of most animations. Recommended 1-5, Maximum 10. | ```python -from kmk.extentions.rgb import AnimationModes +from kmk.extensions.rgb import AnimationModes rgb_ext = RGB(pixel_pin=rgb_pixel_pin, num_pixels=27 num_pixels=0, diff --git a/docs/split_keyboards.md b/docs/split_keyboards.md index d8eeedf..a2e0581 100644 --- a/docs/split_keyboards.md +++ b/docs/split_keyboards.md @@ -1,10 +1,11 @@ # Split Keyboards -Split keyboards are mostly the same as unsplit. Wired UART and Bluetooth are supported. +Split keyboards are mostly the same as unsplit. Wired UART is fully supported, +and testing of bluetooth splits, though we don't currently offer support for this. ## Wired UART Wired connections can use UART over 1 or 2 wires. With 2 wires, you will be able -to syncronize the halves allowing additional features in some extentions. +to syncronize the halves allowing additional features in some extensions. ```python from kb import data_pin :from kmk.modules.split import Split, SplitType @@ -13,8 +14,8 @@ split = Split(split_side=SplitSide.LEFT) keyboard.modules.append(split) ``` -## Bluetooth split (aka no TRRS) -Wireless splits are fully featured with 2 way communication allowing all extentions to work 100%. +## Bluetooth split (aka no TRRS) [Currently in testing] +Wireless splits are fully featured with 2 way communication allowing all extensions to work 100%. ```python from kb import data_pin from kmk.modules.split import Split, SplitType, Split_Side diff --git a/kmk/modules/power.py b/kmk/modules/power.py index d25845b..b0a09d6 100644 --- a/kmk/modules/power.py +++ b/kmk/modules/power.py @@ -57,7 +57,7 @@ class Power(Module): self.psleep() def on_powersave_enable(self, keyboard): - '''Gives 10 cycles to allow other extentions to clean up before powersave''' + '''Gives 10 cycles to allow other extensions to clean up before powersave''' if self._loopcounter > 10: self.enable_powersave(keyboard) self._loopcounter = 0