mirror of
https://github.com/averymd/sofle-v2-oled-zmk.git
synced 2026-01-07 23:32:00 +00:00
add keymap and confit
This commit is contained in:
hai
73
README.md
Normal file
73
README.md
Normal file
@@ -0,0 +1,73 @@
|
||||
# Sofle V2 Keyboard Guide
|
||||
This guide is for flashing the Ergomech Sofle V2 Keyboard. The Sofle V2 is 6×4+5 keys column-staggered split keyboard, using Cherry switches.
|
||||
|
||||
# ErgoMech Sofle V2 Wireless
|
||||
The Ergomech Sofle V2 Wireless uses a Nice!Nano microcontroller and runs the ZMK firmware. This guide will show you how to flash the ZMK firmware to the Nice!Nano microcontroller.
|
||||
|
||||
## Default keymap
|
||||
The default keymap of this keyboard can be found here:
|
||||
|
||||
|
||||
## Flashing the Sofle V2
|
||||
The ZMK cli tool would typically have you step through several questions to generate the necessary code to flash the firmware then upload it to a new repository on GitHub.
|
||||
However, Ergomech has already done this for you. You can find the repository [here](https://github.com/ergomechstore/sofle-v2-nicenano-oled). Assuming you already have a GitHub account,
|
||||
you can fork the repository, and make modifications to the keymap files in the future. For now, the guide will continue with the assumption that you have forked the repository.
|
||||
|
||||
### Running the Workflow
|
||||
The repository has a GitHub workflow that leverages the zmkfirmware/zmk repository to build the firmware. The workflow will build the firmware and upload it as an artifact to the repository.
|
||||
The workflow is triggered on push, pull_request, and manually via workflow_dispatch. You can trigger the workflow manually by going to the Actions tab in your forked repository and selecting the workflow.
|
||||
|
||||
### Workflow Artifact
|
||||
Once the workflow has completed, you can download the artifact from the Actions tab. The artifact will be a .zip file that contains the firmware. Extract the .zip file in your
|
||||
local directory. The extracted files will include:
|
||||
- `sofle_right-nice_nano_v2-zmk.uf2`
|
||||
- `sofle_left-nice_nano_v2-zmk.uf2`
|
||||
- `settings_reset-nice_nano_v2-zmk.uf2`
|
||||
|
||||
### Flashing the keymap and firmware
|
||||
#### Steps to ensure successful flashing
|
||||
- Keep in mind that the power switch on the wireless Ergomech Sofle V2 is only **one** of the ways that the keyboard can be powered. The other way is to plug in the USB-C cable.
|
||||
When flashing one side of the keyboard, the other side must be off.
|
||||
- The keyboard must be in bootloader mode to flash the firmware. To enter the bootloader mode, press the "BOOT" button twice in quick succession.
|
||||
- If you are having trouble flashing, you can always flash the `settings_reset-nice_nano_v2-zmk.uf2` file first. This is a good way to make sure
|
||||
that the keyboard is in a known state before flashing the firmware. The `reset` flash can be visually confirmed by the screen on the Nice!Nano microcontroller
|
||||
not displaying anything after the flash is complete.
|
||||
|
||||
#### Flashing Order
|
||||
There is no required order to flash the firmware. You can flash the left or right side first. Assuming that you are attempting to flash the sides with the correct
|
||||
file (i.e. the right side with the `sofle_right-nice_nano_v2-zmk.uf2` file), you may find it helpful to follow the following order:
|
||||
1. Confirm both sides of the keyboard are off.
|
||||
2. Flash the right side of the keyboard, unplug the USB-C cable, and set it aside.
|
||||
3. Flash the left side of the keyboard, leaving it plugged in after.
|
||||
4. Turn on the right side of the keyboard. You should see the screen on the Nice!Nano microcontroller light up and display a checkmark next to the wifi icon if the sides have connected.
|
||||
5. Open you favorite text editor and test the keyboard.
|
||||
|
||||
|
||||
#### Flashing the firmware
|
||||
1. Connect the keyboard to your computer via USB-C cable.
|
||||
2. Press the "BOOT" button twice in quick succession to enter bootloader mode.
|
||||
3. The keyboard should appear as a USB drive on your computer.
|
||||
4. Drag and drop the `uf2` file that coincides with the side of the keyboard you are flashing onto the USB drive that represents the keyboard.
|
||||
5. The keyboard will automatically reboot and the new firmware will be flashed.
|
||||
|
||||
**Note:** Some operating systems may show a failure when the keyboard reboots, or the USB drive may disappear. This is normal and the keyboard should be flashed successfully.
|
||||
The keyboard flashing has been confirmed to work successfully on Windows 10, and Linux.
|
||||
|
||||
## Modifying the keymap
|
||||
|
||||
### ZMK Keymap
|
||||
We recommend at least reviewing the [ZMK Keymap documentation](https://zmk.dev/docs/features/keymaps) to understand the structure of the keymap files. This
|
||||
will help you understand the changes we are making to the generated files. While not required, most example keymaps attempt to show the layout of the keyboard
|
||||
shown as a comment underneath the layer declaration.
|
||||
|
||||
### ZMK Firmware
|
||||
ZMK does provide an online [keymap editor](https://nickcoutsos.github.io/keymap-editor) and you can use this to change the keymap, this repo is already setup for the use of this editor.
|
||||
|
||||
#### Modifying the keymap with the keymap editor
|
||||
|
||||
#### Modifying the keymap manually
|
||||
The exact spacing doesn't matter, but keeping the indentation consistent can be helpful for reading your keymap files. If you indent each button it will be easier
|
||||
to confirm the structure of the keymap. Take a look at the [default keymap](config/sofle.keymap) to see how this was done.
|
||||
|
||||
The Ergomech Sofle V2 has a 5 way switch on the right side keyboard. The location of the key presses on the 5 way switch are on the last line of the `bindings` section of each layer.
|
||||
As long as the correct number of entries exist on that row, the 5 way switch will work.
|
||||
1086
sofle.svg
Normal file
1086
sofle.svg
Normal file
File diff suppressed because it is too large
Load Diff
|
After Width: | Height: | Size: 45 KiB |
147
sofle.yaml
Normal file
147
sofle.yaml
Normal file
@@ -0,0 +1,147 @@
|
||||
layout: {qmk_keyboard: sofle/rev1}
|
||||
layers:
|
||||
default:
|
||||
- ['`', '1', '2', '3', '4', '5', '6', '7', '8', '9']
|
||||
- ['0', '', ESC, Q, W, E, R, T, Y, U]
|
||||
- [I, O, P, BSPC, TAB, A, S, D, F, G]
|
||||
- [H, J, K, L, ;, '''', LSHFT, Z, X, C]
|
||||
- [V, B, MUTE, '', N, M, ',', ., /, RSHFT]
|
||||
- [LGUI, LALT, LCTRL, lower, RET, SPACE, raise, RCTRL, RALT, RGUI]
|
||||
lower:
|
||||
- - {t: ▽, type: trans}
|
||||
- F1
|
||||
- F2
|
||||
- F3
|
||||
- F4
|
||||
- F5
|
||||
- F6
|
||||
- F7
|
||||
- F8
|
||||
- F9
|
||||
- [F10, F11, '`', '1', '2', '3', '4', '5', '6', '7']
|
||||
- - '8'
|
||||
- '9'
|
||||
- '0'
|
||||
- F12
|
||||
- {t: ▽, type: trans}
|
||||
- '!'
|
||||
- '@'
|
||||
- '#'
|
||||
- $
|
||||
- '%'
|
||||
- - ^
|
||||
- '&'
|
||||
- KP MULTIPLY
|
||||
- (
|
||||
- )
|
||||
- '|'
|
||||
- {t: ▽, type: trans}
|
||||
- '='
|
||||
- '-'
|
||||
- KP PLUS
|
||||
- - '{'
|
||||
- '}'
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- '['
|
||||
- ']'
|
||||
- ;
|
||||
- ':'
|
||||
- \
|
||||
- {t: ▽, type: trans}
|
||||
- - {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {type: held}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
raise:
|
||||
- - BT CLR
|
||||
- {t: BT, h: '0'}
|
||||
- {t: BT, h: '1'}
|
||||
- {t: BT, h: '2'}
|
||||
- {t: BT, h: '3'}
|
||||
- {t: BT, h: '4'}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- - {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- INS
|
||||
- PSCRN
|
||||
- CMENU
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- PG UP
|
||||
- {t: ▽, type: trans}
|
||||
- - UP
|
||||
- {t: ▽, type: trans}
|
||||
- '0'
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- LALT
|
||||
- LCTRL
|
||||
- LSHFT
|
||||
- {t: ▽, type: trans}
|
||||
- CLCK
|
||||
- - PG DN
|
||||
- LEFT
|
||||
- DOWN
|
||||
- RIGHT
|
||||
- DEL
|
||||
- BSPC
|
||||
- {t: ▽, type: trans}
|
||||
- UNDO
|
||||
- CUT
|
||||
- COPY
|
||||
- - PASTE
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- - {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {type: held}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
- {t: ▽, type: trans}
|
||||
adjust:
|
||||
- - BT CLR
|
||||
- {t: BT, h: '0'}
|
||||
- {t: BT, h: '1'}
|
||||
- {t: BT, h: '2'}
|
||||
- {t: BT, h: '3'}
|
||||
- {t: BT, h: '4'}
|
||||
- ''
|
||||
- ''
|
||||
- ''
|
||||
- ''
|
||||
- ['', '', EP TOG, RGB HUD, RGB HUI, RGB SAD, RGB SAI, RGB EFF, '', '']
|
||||
- ['', '', '', '', '', RGB BRD, RGB BRI, '', '', '']
|
||||
- ['', '', '', '', '', '', '', '', '', '']
|
||||
- ['', '', RGB TOG, '', '', '', '', '', '', '']
|
||||
- - ''
|
||||
- ''
|
||||
- ''
|
||||
- {type: held}
|
||||
- ''
|
||||
- ''
|
||||
- {type: held}
|
||||
- ''
|
||||
- ''
|
||||
- ''
|
||||
Reference in New Issue
Block a user