Updates from pre-commit.
This commit is contained in:
ClicketySplit
parent
2b1e91f37d
commit
6cadaa71cd
23 changed files with 277 additions and 247 deletions
|
|
@ -9,66 +9,75 @@ Hardware Supported: Pro Micro, Elite-C, and nice!nano v2
|
|||
Leeloo v2 has been designed from scratch—again. Everything from the wiring schematic to its case. Leeloo v2 still keeps the column stagger that it's known for, along with its low profile design.
|
||||
|
||||
## Features/Differences from Leeloo v1
|
||||
* Support for Kailh Low Profile Choc switches with 18mm x 18mm spacing.
|
||||
|
||||
- Support for Kailh Low Profile Choc switches with 18mm x 18mm spacing.
|
||||
- A version for Kailh Box/MX switches with 19.05mm x 19.05mm spacing will be available in the future.
|
||||
* All switch locations are socketed.
|
||||
* Rotary encoder locations are socketed.
|
||||
- All switch locations are socketed.
|
||||
- Rotary encoder locations are socketed.
|
||||
- One of two locations on each side can be used for a rotary encoder.
|
||||
* OLED Displays and nice!view Displays are natively supported, socketed, and no extra wiring is required.
|
||||
* Support for per-switch RGB underglow.
|
||||
* Better location for 110mAh or 700mAh batteries.
|
||||
- OLED Displays and nice!view Displays are natively supported, socketed, and no extra wiring is required.
|
||||
- Support for per-switch RGB underglow.
|
||||
- Better location for 110mAh or 700mAh batteries.
|
||||
- Different location for soldering battery leads.
|
||||
* Support for Alps Alpine Micro On/off switches.
|
||||
- Support for Alps Alpine Micro On/off switches.
|
||||
|
||||
# Leeloo v1
|
||||
|
||||
|
||||
|
||||
## Features
|
||||
* 4x6x5m Split Keyboard
|
||||
* Support for both Low Profile Choc switches, and Box/MX switches; 19.05mm x 19.05mm spacing.
|
||||
* 90% of the switches are socketed; with the exception to the rotary encoder positions.
|
||||
* Support for Alps Alpine EC11 Rotary Encoders—one on each side, in one of three locations.
|
||||
* Support for OLED Displays or nice!view Displays.
|
||||
|
||||
- 4x6x5m Split Keyboard
|
||||
- Support for both Low Profile Choc switches, and Box/MX switches; 19.05mm x 19.05mm spacing.
|
||||
- 90% of the switches are socketed; with the exception to the rotary encoder positions.
|
||||
- Support for Alps Alpine EC11 Rotary Encoders—one on each side, in one of three locations.
|
||||
- Support for OLED Displays or nice!view Displays.
|
||||
- nice!view displays require a wire to be soldered from the CS Pin on nice!view display to P0.22 or D4 on the nice!nano.
|
||||
* Support for both 110mAh or 700mAh batteries.
|
||||
* Solder pads for battery leads.
|
||||
* Support for Alps Alpine Micro On/off switches.
|
||||
- Support for both 110mAh or 700mAh batteries.
|
||||
- Solder pads for battery leads.
|
||||
- Support for Alps Alpine Micro On/off switches.
|
||||
|
||||
# Building Leeloo's ZMK Firmware
|
||||
|
||||
ZMK Firmware: [Introduction to ZMK](https://zmk.dev/docs/)
|
||||
Installation: [Installing ZMK](https://zmk.dev/docs/user-setup)
|
||||
Customization: [Customizing ZMK](https://zmk.dev/docs/customization)
|
||||
Development Environment: [Basic Setup](https://zmk.dev/docs/development/setup)
|
||||
|
||||
Build commands for the default keymap of Leeloo v1:
|
||||
|
||||
```
|
||||
west build -d build/left -p -b nice_nano_v2 -- -DSHIELD=leeloo_left
|
||||
west build -d build/right -p -b nice_nano_v2 -- -DSHIELD=leeloo_right
|
||||
```
|
||||
|
||||
Build commands for the default keymap of Leeloo v2:
|
||||
|
||||
```
|
||||
west build -d build/left_v2 -p -b nice_nano_v2 -- -DSHIELD=leeloo_rev2_left
|
||||
west build -d build/right_v2 -p -b nice_nano_v2 -- -DSHIELD=leeloo_rev2_right
|
||||
```
|
||||
|
||||
Build commands for your custom keymap of Leeloo v1:
|
||||
|
||||
```
|
||||
west build -d build/right -p -b nice_nano_v2 -- -DSHIELD=leeloo_right -DZMK_CONFIG="C:/dev/zmk/[yourNmae]/leeloo/config"
|
||||
west build -d build/left -p -b nice_nano_v2 -- -DSHIELD=leeloo_left -DZMK_CONFIG="C:/dev/zmk/[yourName]/leeloo/config"
|
||||
```
|
||||
|
||||
Build commands for your custom keymap of Leeloo v2:
|
||||
|
||||
```
|
||||
west build -d build/right_v2 -p -b nice_nano_v2 -- -DSHIELD=leeloo_rev2_right -DZMK_CONFIG="C:/dev/zmk/[yourNmae]/leeloo_v2/config"
|
||||
west build -d build/left_v2 -p -b nice_nano_v2 -- -DSHIELD=leeloo_rev2_left -DZMK_CONFIG="C:/dev/zmk/[yourName]/leeloo_v2/config"
|
||||
```
|
||||
|
||||
## Building Leeloo's ZMK Firmware with nice!view Displays
|
||||
|
||||
There are a couple of files that need to be adjusted before the build commands can be run.
|
||||
|
||||
### Edit the leeloo[_rev2].keymap File
|
||||
|
||||
Near the top 3rd of the leeloo[_rev2].keymap file, locate the following code block:
|
||||
|
||||
```
|
||||
|
|
@ -82,6 +91,7 @@ Near the top 3rd of the leeloo[_rev2].keymap file, locate the following code blo
|
|||
```
|
||||
|
||||
Remove the forward slashes to resemble the following:
|
||||
|
||||
```
|
||||
nice_view_spi: &spi0 {
|
||||
compatible = "nordic,nrf-spim";
|
||||
|
|
@ -95,6 +105,7 @@ nice_view_spi: &spi0 {
|
|||
Save your changes and close the file.
|
||||
|
||||
### Edit the leeloo[_rev2].conf file:
|
||||
|
||||
Near the top of the leeloo[_rev2].conf file, locate the following line items:
|
||||
|
||||
```
|
||||
|
|
@ -103,6 +114,7 @@ Near the top of the leeloo[_rev2].conf file, locate the following line items:
|
|||
```
|
||||
|
||||
Remove the # character in front of the CONFIG_ZMK_DISPLAY configuration item to resemble the following:
|
||||
|
||||
```
|
||||
# Uncomment the following line to enable the OLED Display or nice!view Display
|
||||
CONFIG_ZMK_DISPLAY=y
|
||||
|
|
@ -111,25 +123,30 @@ CONFIG_ZMK_DISPLAY=y
|
|||
Save your changes and close the file.
|
||||
|
||||
### Sample Build Commands for nice!view Displays
|
||||
|
||||
Build commands for the default keymap of Leeloo v1:
|
||||
|
||||
```
|
||||
west build -d build/left -p -b nice_nano_v2 -- -DSHIELD="leeloo_left nice_view_adapter nice_view"
|
||||
west build -d build/right -p -b nice_nano_v2 -- -DSHIELD="leeloo_right nice_view_adapter nice_view"
|
||||
```
|
||||
|
||||
Build commands for the default keymap of Leeloo v2:
|
||||
|
||||
```
|
||||
west build -d build/left_v2 -p -b nice_nano_v2 -- -DSHIELD="leeloo_rev2_left nice_view_adapter nice_view"
|
||||
west build -d build/right_v2 -p -b nice_nano_v2 -- -DSHIELD="leeloo_rev2_right nice_view_adapter nice_view"
|
||||
```
|
||||
|
||||
Build commands for your custom keymap of Leeloo v2:
|
||||
|
||||
```
|
||||
west build -d build/left -p -b nice_nano_v2 -- -DSHIELD="leeloo_rev2_left nice_view_adapter nice_view" -DZMK_CONFIG="/workspaces/zmk-config/[yourNmae]/leeloo_v2/config"
|
||||
west build -d build/right -p -b nice_nano_v2 -- -DSHIELD="leeloo_rev2_right nice_view_adapter nice_view" -DZMK_CONFIG="/workspaces/zmk-config/[yourNmae]/leeloo_v2/config"
|
||||
```
|
||||
|
||||
# Support
|
||||
|
||||
If you have any questions with regards to Leeloo, please [Contact Us](https://clicketysplit.ca/pages/contact-us).
|
||||
|
||||
Clickety Split
|
||||
|
|
|
|||
|
|
@ -9,38 +9,44 @@ Hardware Supported: nice!nano v2, nice!view v1
|
|||
Leeloo-Micro is a 3x5x5m derivative of Leeloo v2; inheriting the column stagger and modifiers row, yet, reducing the number of switches by removing the top row and outside columns. With Leeloo-Micro's inaugural release being wireless, it leverages nice!nanos and nice!views for its microcontrollers and displays.
|
||||
|
||||
## Features
|
||||
* 3x5x5m Split Keyboard
|
||||
* Support for Kailh Low Profile Choc switches with 18mm x 18mm spacing.
|
||||
* All switch locations are socketed.
|
||||
* Support for Alps Alpine EC11 Rotary Encoders—one on each side, in one of two locations.
|
||||
|
||||
- 3x5x5m Split Keyboard
|
||||
- Support for Kailh Low Profile Choc switches with 18mm x 18mm spacing.
|
||||
- All switch locations are socketed.
|
||||
- Support for Alps Alpine EC11 Rotary Encoders—one on each side, in one of two locations.
|
||||
- Rotary encoder locations are socketed.
|
||||
* nice!view Displays are inherently supported, socketed, and no extra wiring is required.
|
||||
* Support for per-switch RGB underglow.
|
||||
* Support for both 110mAh or 700mAh batteries.
|
||||
* Support for Alps Alpine Micro On/off switches.
|
||||
- nice!view Displays are inherently supported, socketed, and no extra wiring is required.
|
||||
- Support for per-switch RGB underglow.
|
||||
- Support for both 110mAh or 700mAh batteries.
|
||||
- Support for Alps Alpine Micro On/off switches.
|
||||
|
||||
# Building Leeloo-Micro ZMK Firmware
|
||||
|
||||
ZMK Firmware: [Introduction to ZMK](https://zmk.dev/docs/)
|
||||
Installation: [Installing ZMK](https://zmk.dev/docs/user-setup)
|
||||
Customization: [Customizing ZMK](https://zmk.dev/docs/customization)
|
||||
Development Environment: [Basic Setup](https://zmk.dev/docs/development/setup)
|
||||
|
||||
Build commands for the default keymap of Leeloo-Micro:
|
||||
|
||||
```
|
||||
west build -d build/left -p -b nice_nano_v2 -- -DSHIELD=leeloo_micro_left
|
||||
west build -d build/right -p -b nice_nano_v2 -- -DSHIELD=leeloo_micro_right
|
||||
```
|
||||
|
||||
Build commands for your custom keymap of Leeloo-Micro:
|
||||
|
||||
```
|
||||
west build -d build/right -p -b nice_nano_v2 -- -DSHIELD=leeloo_micro_right -DZMK_CONFIG="C:/dev/zmk/[yourNmae]/leeloo_micro/config"
|
||||
west build -d build/left -p -b nice_nano_v2 -- -DSHIELD=leeloo_micro_left -DZMK_CONFIG="C:/dev/zmk/[yourName]/leeloo_micro/config"
|
||||
```
|
||||
|
||||
## Building Leeloo-Micro's ZMK Firmware with nice!view Displays
|
||||
|
||||
There are a couple of files that need to be adjusted before the build commands can be run.
|
||||
|
||||
### Edit the leeloo_micro.keymap File
|
||||
|
||||
Near the top 3rd of the leeloo_micro.keymap file, locate the following code block:
|
||||
|
||||
```
|
||||
|
|
@ -54,6 +60,7 @@ Near the top 3rd of the leeloo_micro.keymap file, locate the following code bloc
|
|||
```
|
||||
|
||||
Remove the forward slashes to resemble the following:
|
||||
|
||||
```
|
||||
nice_view_spi: &spi0 {
|
||||
compatible = "nordic,nrf-spim";
|
||||
|
|
@ -67,6 +74,7 @@ nice_view_spi: &spi0 {
|
|||
Save your changes and close the file.
|
||||
|
||||
### Edit the leeloo_micro.conf file:
|
||||
|
||||
Near the top of the leeloo_micro.conf file, locate the following line items:
|
||||
|
||||
```
|
||||
|
|
@ -75,6 +83,7 @@ Near the top of the leeloo_micro.conf file, locate the following line items:
|
|||
```
|
||||
|
||||
Remove the # character in front of the CONFIG_ZMK_DISPLAY configuration item to resemble the following:
|
||||
|
||||
```
|
||||
# Uncomment the following line to enable the OLED Display or nice!view Display
|
||||
CONFIG_ZMK_DISPLAY=y
|
||||
|
|
@ -83,19 +92,23 @@ CONFIG_ZMK_DISPLAY=y
|
|||
Save your changes and close the file.
|
||||
|
||||
### Sample Build Commands for nice!view Displays
|
||||
|
||||
Build commands for the default keymap of Leeloo-Micro:
|
||||
|
||||
```
|
||||
west build -d build/left -p -b nice_nano_v2 -- -DSHIELD="leeloo_micro_left nice_view_adapter nice_view"
|
||||
west build -d build/right -p -b nice_nano_v2 -- -DSHIELD="leeloo_micro_right nice_view_adapter nice_view"
|
||||
```
|
||||
|
||||
Build commands for your custom keymap of Leeloo-Micro:
|
||||
|
||||
```
|
||||
west build -d build/left -p -b nice_nano_v2 -- -DSHIELD="leeloo_micro_left nice_view_adapter nice_view" -DZMK_CONFIG="/workspaces/zmk-config/[yourNmae]/leeloo_micro/config"
|
||||
west build -d build/right -p -b nice_nano_v2 -- -DSHIELD="leeloo_micro_right nice_view_adapter nice_view" -DZMK_CONFIG="/workspaces/zmk-config/[yourNmae]/leeloo_micro/config"
|
||||
```
|
||||
|
||||
# Support
|
||||
|
||||
If you have any questions with regards to Leeloo-Micro, please [Contact Us](https://clicketysplit.ca/pages/contact-us).
|
||||
|
||||
Clickety Split
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue