Skip to content

Commit

Permalink
Add uconsole_keyboard_flash.tar.gz readme in wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
cuu committed Dec 15, 2024
1 parent b94258b commit 9f49f6d
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions wiki/Simpe-uConsole-keyboard-flashing-tool.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Simple uConsole keyboard flashing tool

[uconsole_keyboard_flash.tar.gz](https://github.com/clockworkpi/uConsole/blob/master/Bin/uconsole_keyboard_flash.tar.gz "uconsole_keyboard_flash.tar.gz")

This tar.gz contains a auto flash tool for quick flashing Arduino IDE compiled bin file to the uConsole keyboard while the keyboard is plugged in the PC or uConsole and uConsole is running some linux system.

***DO NOT*** confused the bin file in the tar.gz with other uconsole.kbd.***.bin files, they are not the same thing.

So do not use uconsole.kbd.***.bin with this flashing tool.

Here's how you can flash the firmware on uConsole(A06 or CM4) or a PC running Ubuntu 22.04+:

1. Download the [uconsole_keyboard_flash.tar.gz](https://github.com/clockworkpi/uConsole/blob/master/Bin/uconsole_keyboard_flash.tar.gz "uconsole_keyboard_flash.tar.gz") file.
2. Extract the contents of the archive: `tar zxvf uconsole_keyboard_flash.tar.gz`.
3. Install the required package using the following command: `sudo apt install -y dfu-util`.
4. Navigate to the extracted directory: `cd uconsole_keyboard_flash`.
5. Execute the flash script with root privileges: `sudo ./flash.sh`.
6. If everything goes well, you will see a progress bar indicating the flashing process.
7. If any issues occur or the keyboard loses control (which is unlikely), simply reboot uConsole to resolve it.
8. Rest assured that this flash program will not brick your keyboard.

0 comments on commit 9f49f6d

Please sign in to comment.