|
| 1 | ++++ |
| 2 | +title = "Guide to Setting Up and Flashing Your Keyboard with Ergohaven's Qube" |
| 3 | +tags = ["guide", "zmk", "qube", "ergohaven"] |
| 4 | ++++ |
| 5 | + |
| 6 | +In this guide, we will thoroughly break down the process of fully setting up and flashing an Ergohaven split keyboard using the Qube dongle. You will learn how to prepare the files, perform a full reset, and correctly flash all components for stable operation. |
| 7 | + |
| 8 | +**Ergohaven's Qube** is a special dongle that acts as a central device for your split keyboard, simplifying its connection to your computer and displays useful information. |
| 9 | + |
| 10 | + |
| 11 | + |
| 12 | +## Step 1: Preparing the firmware |
| 13 | + |
| 14 | +Before you begin, you need to obtain the latest firmware files. The firmware file is essentially the "brain" of your keyboard, which determines how it works. |
| 15 | + |
| 16 | +1. **If you have a fork (copy) of the repository on GitHub:** Synchronize your fork with the main ZMK repository to get the latest updates. After that, build (compile) the firmware and download the resulting `*.uf2` files: one for the left and right halves, and one for the Qube dongle. |
| 17 | + |
| 18 | +2. **If you don't have your own fork:** Download the ready-made standard firmware from the <a href="https://github.com/ergohaven/keymap_hub" target="_blank">ergohaven/keymap_hub</a> repository. You will also need three `.uf2` files. |
| 19 | + |
| 20 | +Additionally, you will need a **reset firmware** (`settings_reset-ergohaven-zmk.uf2`). Usually, it can be found in the same place as the main firmware, or in our <a href="https://github.com/ergohaven/keymap_hub" target="_blank">keymap_hub</a>. |
| 21 | + |
| 22 | + |
| 23 | + |
| 24 | +## Step 2: Full reset |
| 25 | + |
| 26 | +> This step is necessary for a "clean" installation and to avoid conflicts between the old and new firmware. We will sequentially install the reset firmware on all three devices. |
| 27 | +
|
| 28 | +1. **Turn off the power on both halves of the keyboard.** Use the physical switches on the bottom of the case for this. |
| 29 | + |
| 30 | + |
| 31 | + |
| 32 | +2. **Put the devices into bootloader mode.** To do this, quickly press the `Reset` button on the back of the device twice. |
| 33 | + |
| 34 | +3. **Flash with the reset firmware.** Connect each of the three devices (left half, right half, Qube) to the computer in turn. After connecting, the device will appear in the system as a removable USB drive. Drag the reset firmware file (`settings_reset-ergohaven-zmk.uf2`) to this drive. After copying, the device will automatically reboot. |
| 35 | + |
| 36 | +> It is normal to see a warning about a file transfer error or an improper device ejection after copying the firmware. The file has been transferred successfully, but the drive disconnects before the operating system can register the completion of the transfer. |
| 37 | +
|
| 38 | +## Step 3: Flashing |
| 39 | + |
| 40 | +> Now that all devices are reset, you can install the main firmware. **The order here is important!** |
| 41 | +
|
| 42 | +1. **Flash Qube.** Connect the dongle to the computer, put it into bootloader mode, and copy the corresponding firmware file (`op36_qube-ergohaven-zmk.uf2` or similar) to it. |
| 43 | +2. **Disconnect Qube from the computer.** |
| 44 | +3. **Flash the left half.** Connect the left half of the keyboard, put it into bootloader mode, and copy the firmware file for the left side (`op36_left_qube-ergohaven-zmk.uf2`) to it. |
| 45 | +> To flash the left half of the keyboard, use only the firmware file named **left_qube**-ergohaven-zmk.uf2. |
| 46 | +4. **Disconnect the left half from the computer.** |
| 47 | +5. **Flash the right half.** Connect the right half, put it into bootloader mode, and copy its firmware file (`op36_right-ergohaven-zmk.uf2`) to it. |
| 48 | + |
| 49 | +## Step 4: First power-up and synchronization |
| 50 | + |
| 51 | +All components are flashed. Now they have to be started correctly. |
| 52 | + |
| 53 | +1. **Using a Type-C cable, connect Ergohaven's Qube to the PC.** It will act as a receiver. |
| 54 | +2. **Turn on the power on the left half of the keyboard.** It should automatically connect to Qube. |
| 55 | +3. **Turn on the power on the right half.** It will connect to the Qube, completing the setup. |
| 56 | + |
| 57 | +Wait a few seconds. Try typing something. If everything is done correctly, your keyboard is ready to use! |
| 58 | +> If nothing happens, press the reset button on Qube once. |
| 59 | +
|
| 60 | + |
| 61 | + |
| 62 | +## How to update the layout in the future? |
| 63 | + |
| 64 | +> This is one of the main advantages of using Ergohaven's Qube. All the keyboard layout logic is stored in it. |
| 65 | +
|
| 66 | +If you have changed your layout (swapped keys, added a macro) and built a new firmware, you **do not need** to re-flash the halves of the keyboard. |
| 67 | +It is enough to re-flash only the dongle! Just connect it to the computer, put it into bootloader mode, and copy the new firmware file to it. This makes the update process quick and convenient. |
| 68 | + |
| 69 | +**Congratulations! Your keyboard is ready to use.** |
0 commit comments