Merge pull request #116 from bessman/doc/readme-bootloader
Clarify bootloader instructions
This commit is contained in:
20
README.md
20
README.md
@@ -4,7 +4,6 @@ Hardware details and information to build an open firmware for Bluetooth LED bad
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### Unix
|
|
||||||
Install [wchisp](https://github.com/ch32-rs/wchisp?tab=readme-ov-file#installing).
|
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).
|
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,13 @@ the boot pin is pulled down in one of two ways:
|
|||||||
- Alternatively, connect the USB, press and hold KEY2, then short and release
|
- Alternatively, connect the USB, press and hold KEY2, then short and release
|
||||||
the C3 capacitor.
|
the C3 capacitor.
|
||||||
|
|
||||||
Then check `dmesg` if the chip has entered the ISP mode with idVendor=4348 and
|
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.
|
||||||
idProduct=55e0.
|
|
||||||
|
On Linux, you can also check `dmesg` if the chip has entered the ISP mode with idVendor=4348 and idProduct=55e0.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
Then run:
|
With the badge in ISP mode, run:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
wchisp config reset
|
wchisp config reset
|
||||||
@@ -30,8 +30,8 @@ wchisp flash badgemagic-ch582.bin
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Windows
|
### Windows
|
||||||
Install and run [wchisp studio](https://www.wch-ic.com/downloads/WCHISPTool_Setup_exe.html)
|
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.
|
Connect the badge via USB and enter bootloader mode, per the instructions above.
|
||||||
|
|
||||||
The device will automatically appear in the UI.
|
The device will automatically appear in the UI.
|
||||||
|
|
||||||
@@ -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
|
Where badgemagic-ch582.bin is the binary downloaded above, the .elf file also
|
||||||
works.
|
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
|
## Usage
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user