aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFrancois Cartegnie <francois@fossasia>2024-01-14 13:47:30 +0100
committerFrancois Cartegnie <francois@fossasia>2024-01-14 13:47:30 +0100
commitcf739dc50ad02a66bcc29878f9738242982f6d85 (patch)
treef7764c09aa2a6d20d1c080f2207166dfee1a07ed /README.md
parent40aa527ec236e0767c3751c4fe150d6523ace182 (diff)
update documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
index f37f0f7..6a558db 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,27 @@
# badgemagic-firmware
Hardware details and information to build an open firmware for LED badge
+
+## Hardware Information
+
+BadgeMagic target hardware features a custom 11x44 LED matrix display,
+Bluetooth LE and low power consumption.
+
+### Chipset
+
+The design relies on a single MCU.
+MCU type has changed depending on manufacturer batches.
+
+* ARM M0 variant based on MM32W062
+* RISC-V variant based on CH582
+
+### Display
+
+The custom 11x44 LED dot matrix is using persistence of vision.
+(assets/dotmatrix.png)
+
+## Firmware
+
+### Functionalities
+
+The badge stores bitmaps in
+