Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add manual and warning about LED brightness #40

Merged
merged 1 commit into from
Sep 24, 2024
Merged

Add manual and warning about LED brightness #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
Loading