From e52bb30f193e3854eafd9e42c9feaff76865e0a4 Mon Sep 17 00:00:00 2001 From: Simeon Wallrath Date: Tue, 15 Jul 2025 09:21:21 +0200 Subject: [PATCH] Added SDA/SCL Buildflags, Init Manual --- Firmware/WLEDv15/platformio.ini | 4 +- Manual/SetupGuide/manual.typ | 76 +++++++++++++++++++++++++++++++++ 2 files changed, 78 insertions(+), 2 deletions(-) create mode 100644 Manual/SetupGuide/manual.typ diff --git a/Firmware/WLEDv15/platformio.ini b/Firmware/WLEDv15/platformio.ini index a3aeb72..f4319e5 100644 --- a/Firmware/WLEDv15/platformio.ini +++ b/Firmware/WLEDv15/platformio.ini @@ -361,10 +361,10 @@ board_build.ldscript = ${common.ldscript_4m1m} build_unflags = ${common.build_unflags} build_flags = ${common.build_flags} ${esp8266.build_flags} -D WLED_RELEASE_NAME=\"ESP8266\" #-DWLED_DISABLE_2D -D WLED_DISABLE_PARTICLESYSTEM2D - -D LEDPIN=14 -D DATA_PINS=14 -D DEFAULT_LED_COUNT=15 + -D LEDPIN=14 -D DATA_PINS=14 -D DEFAULT_LED_COUNT=15 -D HW_PIN_SDA=4 -D HW_PIN_SCL=5 lib_deps = ${esp8266.lib_deps} monitor_filters = esp8266_exception_decoder -custom_usermods = audioreactive BME280_v2 PIR_sensor_switch +custom_usermods = BME280_v2 PIR_sensor_switch [env:nodemcuv2_compat] diff --git a/Manual/SetupGuide/manual.typ b/Manual/SetupGuide/manual.typ new file mode 100644 index 0000000..d989638 --- /dev/null +++ b/Manual/SetupGuide/manual.typ @@ -0,0 +1,76 @@ +#import "@preview/mantys:1.0.2": * + +#show: mantys( + name: "mantys", + version: "1.0.0", + authors: ( + "Written by Waldo and Mona", + ), + license: "MIT", + description: "Setup Guide for the Blahaj Pentgramm Badge", + repository: "https://github.com/jneug/typst-mantys", + + /// Uncomment one of the following lines to load the above + /// package information directly from the typst.toml file + // ..toml("../typst.toml"), + // ..toml("typst.toml"), + + title: "Blahaj Pentagramm Badge", + // subtitle: "Tagline", + date: datetime.today(), + + // url: "", + + abstract: [ + The Blahaj Pentragram Badge is a... + ], + + // examples-scope: ( + // scope: (:), + // imports: (:) + // ) + +theme: themes.modern +) + += Flashing the Firmware + +The Blahaj Pentagramm Badge (BPB) is powered by WLED. As we use Usermods to support the PIR and the BME280, it's necessary to build WLED from source. This involves the folowing steps: + +- Clone the latest Version from Github +- Replace the Platform.io by the one in the Firmware folder of BPB-Repository +- Connect the BPB via USB to your Computer +- Open the WLED-Folder in VSCode +- Hit Compile and Upload + + + += Configuring WLED + +After flashing, the 15 LEDs should light up instantly. The following values are preconfigured and should not be edited: +#v(0.5cm) + +#figure( +table( + columns: (auto, auto), + stroke: 0.04em, + inset: 6pt, + align: left, + [SDA], [4], + [SCL], [5], + [LEDPIN], [14], + [LEDCOUNT], [15] +) +) + + + +/// Helper for Tidy-Support +/// Uncomment, if you are using Tidy for documentation +// #let show-module(name, scope: (:), outlined: true) = tidy-module( +// read(name + ".typ"), +// name: name, +// show-outline: outlined, +// include-examples-scope: true, +// extract-headings: 3, +// )