Skip to content

Commit cf118e7

Browse files
docs: add supported hardware section to README
Adds a hardware identification section and flashing warning raised in #85. Clarifies that this firmware targets the CH582M with 11x44 LEDs specifically and warns that flashing unsupported look-alike badges bricks them permanently with no recovery path (OEM firmware is read-protected). References #59 as a real example. Intentionally omits clone board compatibility claims as pinouts are still TBD in CH582.md.
1 parent 6f813dc commit cf118e7

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,34 @@
22

33
Hardware details and information to build an open firmware for Bluetooth LED badges, compatible with [Badge Magic app](https://github.com/fossasia/badgemagic-app)
44

5+
## Supported Hardware
6+
7+
> **Warning: Flashing this firmware on an unsupported badge can brick it permanently.**
8+
> The OEM firmware is read-protected and cannot be dumped, so there is no recovery path once overwritten.
9+
> See [#59](https://github.com/fossasia/badgemagic-firmware/issues/59) for a real example of this happening.
10+
11+
This firmware targets **one specific badge variant**:
12+
13+
- **Chipset:** WCH CH582M (RISC-V)
14+
- **Display:** 11×44 LED matrix
15+
- **BLE name:** `LSLED`
16+
17+
### Am I using the right badge?
18+
19+
Many LED badges look identical on the outside and advertise the same BLE name (`LSLED`), but differ internally in chipset or LED grid size (e.g. 11×44 vs 11×55). **Identical appearance and BLE name do not guarantee compatibility.**
20+
21+
To verify your badge before flashing:
22+
23+
1. Open the badge and locate the chip marking on the PCB — it should read **CH582M**
24+
2. Count the LED columns — there should be **44** (not 48, 55 or any other number)
25+
3. If you are unsure, do **not** flash this firmware
26+
27+
For hardware photos and further identification help, see [CH582.md](./CH582.md).
28+
29+
> **Note:** Compatibility with other badge variants (e.g. LeSun B1144 or other
30+
> Alibaba sourced clones) is not established. Pinout reverse engineering for those
31+
> boards is still in progress.
32+
533
## Installation
634

735
Install [wchisp](https://github.com/ch32-rs/wchisp?tab=readme-ov-file#installing).

0 commit comments

Comments
 (0)