From 5cebe029c3ecc936dd9fb9a285585a6e155fe4ac Mon Sep 17 00:00:00 2001 From: Token <49812128+TokenRat@users.noreply.github.com> Date: Mon, 23 Sep 2024 20:46:32 +0200 Subject: [PATCH] Add manual and warning about LED brightness Add manual and warning about LED brightness to the README --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a2cc777..53343a5 100644 --- a/README.md +++ b/README.md @@ -36,14 +36,9 @@ You can find the full schematics and PCB files in the ![Technical drawing of the badge](docs/assets/techspecs.png) -# Usage +# Usage and features -TODO - - -## Default Firmware Features - -TODO +See this page: [How to use your badge](https://www.eurofurence.org/EF28/badge/manual) ## Serial Output / Logging @@ -61,6 +56,11 @@ You can also use your favorite serial monitor, for example [minicom](https://sal `minicom -D /dev/ttyACM0 -b 115200` +## Note on LED brightness + +You can configure the brightness of your badge, see the manual [How to use your badge](https://www.eurofurence.org/EF28/badge/manual). If you modify your firmware, do not push the LEDs too hard. We limited the brightness on purpose to around 45 of 255 since the 5V boot converter cannot handle more. If you use just one color channel, values up to 100/255 might work. But they are plenty bright at 45 of 255. Higher values cause the 5V rail to break down and the LEDs start flickering badly. + + # Building Your Own Firmware The badge firmware is built using [PlatformIO](https://platformio.org/), an