Skip to content

Commit

Permalink
Update flashing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bstiq committed Jul 24, 2024
1 parent 7954641 commit 830750f
Showing 1 changed file with 49 additions and 16 deletions.
65 changes: 49 additions & 16 deletions fw/flashing.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,38 +12,58 @@ parent: Firmware

# Flashing

{: .tip }
This article applies only to rp2040-based controller in general and the splinky, splinktegrated and the integrated Dilemma controllers in particular.

*Flashing* refers to writing a new firmware binary onto a controller. This article will describe the process and the various ways of initiating it.

This article applies only to RP2040-based controller in general and the splinky, splinktegrated and the integrated Dilemma controllers in particular.

{: .tip }
A note about the TRS/TRRS cable: It does not disturb the flashing process and can remain in place. We advise you not to unplug the cable when flashing to reduce the risk of accidentally hot-plugging it.

# Overview

To flash your new image, you will need to go through a few steps:

- compile your own firmware (not covered in this article)
- put the keyboard into bootloader mode
- copy the image to the USB drive
- (if needed) flash the other hand

Below is detailed the exact procedure to follow. You need to flash either the right side only, or the right and left side separately - this is also detailed below.

# Bootloader

The first step is to put your keyboard into bootloader mode. During this time it will not function as a keyboard, but it will be ready to receive new firmware.

- if you want to flash the right side of your keyboard, grab the right side only
- if you want to flash the left side of your keyboard, grab the left side only

There are several ways of initiating bootloader mode:

## Bootmagic

To initiate bootmagic, unplug the USB cable, and then hold down the top right key for a right and, or the top left key for the left hand as you plug the USB cable in again. It is not necessary to hold both keys; The one on the hand that you are currently flashing is sufficient. Release the key shortly after inserting the plug.
{: .warning }
Using Bootmagic will clear the memory of the chip. This means you will lose all changes you have made in via, as well as your chosen RGB effect and color, and your chosen DPI on a board with a pointing device. If you wish to retain your settings, please use a different method.

To initiate bootmagic:

Bootmagic will not only initiate bootloader mode, but also clears the keyboard's memory, which makes this method very well suited for troubleshooting.
- grab the side of the keyboard you want to flash (either left or right)
- unplug the USB cable
- hold down the top right key (if you're flashing the right side), or
- hold down the the top left key (if you're flashing the left side)
- at the same time, plug the USB cable in again
- release the key

/// PICTURE of several boards with bootmagic keys highlighted

{: .warning }
Clearing the memory will lose all changes you have made in via, as well as your chosen RGB effect and color, as well as your chosen DPI on a board with a pointing device. If you wish to retain your settings, please use a different method.
Once you've put the keyboard in bootloader mode, you can skip to the [usb drive section](#usb-drive).

## The QK_BOOT keycode
## QK_BOOT keycode

There exists a dedicated key code that will immediately reboot into the bootloader.
There exists a dedicated key code that will immediately reboot into the bootloader. This key is present on all default keymaps.

Please refer to the [keymap guide][keymaps] to find the default location of this key for your keyboard.

## The button
## Update button

Locate the button labeled "UPDATE" or "RESET" on your controller.

Expand All @@ -53,19 +73,30 @@ The Dactyl and Charybdis families have a hole in the bottom plate allowing acces

Tapping this button twice within 500 milliseconds will engage the bootloader.

## The hardware fallback {#hardware-fallback}
Once you've put the keyboard in bootloader mode, you can skip to the [usb drive section](#usb-drive).

## Hardware fallback {#hardware-fallback}

In case the currently flashed firmware will not work, for example if none is loaded if you self-sourced a controller, if something went wrong while flashing, or you accidentally flashed a firmware for a different board, an emergency method exists.
The hardware fallback is an emergency method:

- if the currently flashed firmware will not work, eg. if none is loaded
- if you self-sourced a controller and it's not working
- if something went wrong while flashing
- if you accidentally flashed a firmware for a different board

For this, you will need to unscrew the case bottom and locate two through holes, either labelled "BOOT" or unlabelled.

/// PICTURE of splinky, splinktegrated and Dilemma with boot pads highlighted

Next, unplug the USB connector, and then bridge the two pads, for example using metallic tweezers. Hold this connection while you plug in the USB connector, and release it shortly afterward.

# The USB drive
Once you've put the keyboard in bootloader mode, you can skip to the [usb drive section](#usb-drive).

# The USB drive {#usb-drive}

Once you successfully initiated the bootloader, your PC will detect a new USB drive labelled `RPI-RP2` containing two files, `INDEX.HTM` and `UF2_INFO.TXT`. To proceed, write the `.uf2` file that you downloaded from the release section or compiled yourself to this drive, for example by simply dragging and dropping it in your file manager, or by issuing a `qmk flash` command.
Once you successfully initiated the bootloader, your PC will detect a new USB drive labelled `RPI-RP2` containing two files, `INDEX.HTM` and `UF2_INFO.TXT`.

To proceed, write the `.uf2` file that you downloaded from the release section or compiled yourself to this drive, for example by simply dragging and dropping it in your file manager or by issuing a `qmk flash` command.

{: .warning }
Do not unplug the keyboard at this stage, as partially writing firmware will result in a non-functioning keyboard. Should this happen to you, see the [Hardware fallback](#hardware-fallback) section above.
Expand All @@ -77,10 +108,12 @@ On a Linux system, you will need to ensure the drive is automatically mounted an

# The other hand

Next, unplug the USB connector and connect the other hand, and then repeat the procedure, flashing the same firmware file. If you use the `QK_BOOT` method, please note that your layout may now be mirrored!
If you have made changes to the RGB, the QMK version, the rotary encoder, or the trackball behaviour, it's a good idea to flash the other side as well. You can read more on the [splitkb article on this topic][splitkb-whentoflash]. If the keyboard is behaving in a weird manner or if you have any doubt, always flash both hands.

Check warning on line 111 in fw/flashing.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (behaviour)


Flashing both hands is not always required, please see the [splitkb article on this topic][splitkb-whentoflash] for details. However, if there is any doubt, always flash both hands.
Unplug the USB connector and connect the other side, and then repeat the procedure - flashing the same firmware file.

If you use the `QK_BOOT` method, please note that your layout may now be mirrored! This is normal, ignore it and plug the USB back into the right side.
----

[keymaps]: {{site.baseurl}}/fw/default-keymaps.html
Expand Down

0 comments on commit 830750f

Please sign in to comment.