From 6093e588f30e50488c01e7390b467f0ba701c016 Mon Sep 17 00:00:00 2001 From: Alexander Bessman Date: Sun, 28 Dec 2025 12:49:39 +0100 Subject: [PATCH 1/4] Clarify bootloader instructions --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6c50ed9..14bbb38 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ Hardware details and information to build an open firmware for Bluetooth LED bad ## Installation -### Unix Install [wchisp](https://github.com/ch32-rs/wchisp?tab=readme-ov-file#installing). Download prebuilt binaries from [release](https://github.com/fossasia/badgemagic-firmware/releases) or [the latest development builds](https://github.com/fossasia/badgemagic-firmware/tree/bin). @@ -17,12 +16,14 @@ the boot pin is pulled down in one of two ways: - Alternatively, connect the USB, press and hold KEY2, then short and release the C3 capacitor. -Then check `dmesg` if the chip has entered the ISP mode with idVendor=4348 and +If the badge has succesfully entered ISP mode, a single pixel roughly in the middle of the display will be lit. The badge will stay in ISP mode for approximately ten seconds before rebooting into normal mode. + +You can also check `dmesg` if the chip has entered the ISP mode with idVendor=4348 and idProduct=55e0. ![c3](assets/burn-badge.svg) -Then run: +With the badge in ISP mode, run: ```sh wchisp config reset @@ -30,8 +31,8 @@ wchisp flash badgemagic-ch582.bin ``` ### Windows -Install and run [wchisp studio](https://www.wch-ic.com/downloads/WCHISPTool_Setup_exe.html) -Connect the badge via USB and enter bootloader mode. +On Windows, you have the option to install and run [wchisp studio](https://www.wch-ic.com/downloads/WCHISPTool_Setup_exe.html) instead of the wchisp CLI tool. +Connect the badge via USB and enter bootloader mode, per the instructions above. The device will automatically appear in the UI. From d8606ef0d967f4e1db9158cc53b9e25c2d1038f8 Mon Sep 17 00:00:00 2001 From: Alexander Bessman Date: Sun, 28 Dec 2025 12:51:44 +0100 Subject: [PATCH 2/4] Fix typo in README about ISP mode --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 14bbb38..83853ef 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ the boot pin is pulled down in one of two ways: - Alternatively, connect the USB, press and hold KEY2, then short and release the C3 capacitor. -If the badge has succesfully entered ISP mode, a single pixel roughly in the middle of the display will be lit. The badge will stay in ISP mode for approximately ten seconds before rebooting into normal mode. +If the badge has successfully entered ISP mode, a single pixel roughly in the middle of the display will be lit. The badge will stay in ISP mode for approximately ten seconds before rebooting into normal mode. You can also check `dmesg` if the chip has entered the ISP mode with idVendor=4348 and idProduct=55e0. From 11c0e31f3fcdf4b996f5f1d3799f0263366e80b7 Mon Sep 17 00:00:00 2001 From: Alexander Bessman Date: Sun, 28 Dec 2025 12:55:33 +0100 Subject: [PATCH 3/4] Fix README.md for clarity on dmesg command --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 83853ef..88b87a7 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,7 @@ the boot pin is pulled down in one of two ways: If the badge has successfully entered ISP mode, a single pixel roughly in the middle of the display will be lit. The badge will stay in ISP mode for approximately ten seconds before rebooting into normal mode. -You can also check `dmesg` if the chip has entered the ISP mode with idVendor=4348 and -idProduct=55e0. +On Linux, you can also check `dmesg` if the chip has entered the ISP mode with idVendor=4348 and idProduct=55e0. ![c3](assets/burn-badge.svg) From 72b33108519de689da63386769d2208ca3b0c002 Mon Sep 17 00:00:00 2001 From: Alexander Bessman Date: Sun, 28 Dec 2025 12:58:04 +0100 Subject: [PATCH 4/4] Add firmware update instructions to README Added instructions for updating firmware without battery removal. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 88b87a7..ee2a75d 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,14 @@ Select the `badgemagic-ch582.bin` file and click 'Download'. Where badgemagic-ch582.bin is the binary downloaded above, the .elf file also works. +### Updating + +Once the open source firmware is installed, there is no further need to remove the battery or short-circuit C3 to enter ISP mode. Simply long-press KEY2 to enter ISP mode. Then, flash updated firmware with + +```sh +wchisp config reset +wchisp flash badgemagic-ch582.bin +``` ## Usage