This guide is for flashing the Ergomech Sofle Hybrid Keyboard. The Sofle Hybrid is 6×4+5 keys column-staggered split keyboard, using low profile Kailh Choc switches. Ergomech has modified the original Sofle Hybrid to include a 5 way switch on the right side keyboard instead of a rotary encoder.
The Ergomech Sofle Hybrid 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.
In an effort to create a keymap that is similar to the original keymap for the Sofle Keyboard, Ergomech has created a default keymap for the Sofle Hybrid. You may find that the keymap needs modifications to fit your needs, but it should be a good starting point. The default keymap was designed after the map shown here with the main difference being the 4th layer. The Ergomech Sofle Hybrid has bluetooth and other adjustments on the 4th layer.
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. 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.
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.
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.uf2sofle_left-nice_nano_v2-zmk.uf2settings_reset-nice_nano_v2-zmk.uf2
- Keep in mind that the power switch on the wireless Ergomech Sofle Hybrid 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.uf2file first. This is a good way to make sure that the keyboard is in a known state before flashing the firmware. Theresetflash can be visually confirmed by the screen on the Nice!Nano microcontroller not displaying anything after the flash is complete.
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:
- Confirm both sides of the keyboard are off.
- Flash the right side of the keyboard, unplug the USB-C cable, and set it aside.
- Flash the left side of the keyboard, leaving it plugged in after.
- 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.
- Open you favorite text editor and test the keyboard.
- Connect the keyboard to your computer via USB-C cable.
- Press the "BOOT" button twice in quick succession to enter bootloader mode.
- The keyboard should appear as a USB drive on your computer.
- Drag and drop the
uf2file that coincides with the side of the keyboard you are flashing onto the USB drive that represents the keyboard. - 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.
We recommend at least reviewing the ZMK Keymap documentation 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 does provide an online keymap editor that can be used to create a keymap and generate the necessary files for flashing a standard Sofle Hybrid. However, the 5 way switch is not yet supported by the keymap editor. This guide will show how to modify the generated files to include the 5 way switch.
- The keymap editor is not yet configured to support the 5 way switch. If you use the keymap editor to generate the keymap, you will need to manually modify the files to include the 5 way switch.
- Make sure you create a new branch in your repository before saving any changes in the keymap editor, and select the new branch. The editor will commit the changes to the branch you have selected.
- The commit made by the keymap editor will not have the necessary bindings for the 5 way switch. You will need to manually add the bindings to the keymap file.
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 to see how this was done.
The Ergomech Sofle Hybrid 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.