diff --git a/Manual/SetupGuide/Images/CaseScrew.png b/Manual/SetupGuide/Images/CaseScrew.png index 24a3112..4e7b11b 100644 Binary files a/Manual/SetupGuide/Images/CaseScrew.png and b/Manual/SetupGuide/Images/CaseScrew.png differ diff --git a/Manual/SetupGuide/Images/Real/BottomView.jpeg b/Manual/SetupGuide/Images/Real/BottomView.jpeg new file mode 100644 index 0000000..a35e3a7 Binary files /dev/null and b/Manual/SetupGuide/Images/Real/BottomView.jpeg differ diff --git a/Manual/SetupGuide/Images/Real/Clamp.jpeg b/Manual/SetupGuide/Images/Real/Clamp.jpeg new file mode 100644 index 0000000..f90177c Binary files /dev/null and b/Manual/SetupGuide/Images/Real/Clamp.jpeg differ diff --git a/Manual/SetupGuide/Images/Real/Clamp2.jpeg b/Manual/SetupGuide/Images/Real/Clamp2.jpeg new file mode 100644 index 0000000..eadae89 Binary files /dev/null and b/Manual/SetupGuide/Images/Real/Clamp2.jpeg differ diff --git a/Manual/SetupGuide/Images/Real/PartsOverview.jpeg b/Manual/SetupGuide/Images/Real/PartsOverview.jpeg new file mode 100644 index 0000000..e261cbd Binary files /dev/null and b/Manual/SetupGuide/Images/Real/PartsOverview.jpeg differ diff --git a/Manual/SetupGuide/Images/Real/Paste.jpeg b/Manual/SetupGuide/Images/Real/Paste.jpeg new file mode 100644 index 0000000..ff88f5e Binary files /dev/null and b/Manual/SetupGuide/Images/Real/Paste.jpeg differ diff --git a/Manual/SetupGuide/Images/Real/Paste2.jpeg b/Manual/SetupGuide/Images/Real/Paste2.jpeg new file mode 100644 index 0000000..1e32f43 Binary files /dev/null and b/Manual/SetupGuide/Images/Real/Paste2.jpeg differ diff --git a/Manual/SetupGuide/Images/Real/TopView.jpeg b/Manual/SetupGuide/Images/Real/TopView.jpeg new file mode 100644 index 0000000..a05d96b Binary files /dev/null and b/Manual/SetupGuide/Images/Real/TopView.jpeg differ diff --git a/Manual/SetupGuide/Images/Real/signal-2025-08-25-165027_014.jpeg b/Manual/SetupGuide/Images/Real/signal-2025-08-25-165027_014.jpeg new file mode 100644 index 0000000..91f57df Binary files /dev/null and b/Manual/SetupGuide/Images/Real/signal-2025-08-25-165027_014.jpeg differ diff --git a/Manual/SetupGuide/Images/Real/signal-2025-08-25-165027_018.jpeg b/Manual/SetupGuide/Images/Real/signal-2025-08-25-165027_018.jpeg new file mode 100644 index 0000000..954d8d9 Binary files /dev/null and b/Manual/SetupGuide/Images/Real/signal-2025-08-25-165027_018.jpeg differ diff --git a/Manual/SetupGuide/Images/SensorScrewToCase.png b/Manual/SetupGuide/Images/SensorScrewToCase.png index 80ec536..05ee30f 100644 Binary files a/Manual/SetupGuide/Images/SensorScrewToCase.png and b/Manual/SetupGuide/Images/SensorScrewToCase.png differ diff --git a/Manual/SetupGuide/SetupGuide.pdf b/Manual/SetupGuide/SetupGuide.pdf index ef67ab9..a1c8a16 100644 Binary files a/Manual/SetupGuide/SetupGuide.pdf and b/Manual/SetupGuide/SetupGuide.pdf differ diff --git a/Manual/SetupGuide/SetupGuide.typ b/Manual/SetupGuide/SetupGuide.typ index 8f07a7f..3a7f221 100644 --- a/Manual/SetupGuide/SetupGuide.typ +++ b/Manual/SetupGuide/SetupGuide.typ @@ -2,10 +2,6 @@ #import "@preview/subpar:0.2.2" #import "Theme/modernCustom.typ": modernCustom - - - - #show: mantys( name: "mantys", @@ -16,6 +12,7 @@ license: "MIT", description: "Setup Guide for the Shorktagram Badge", repository: "https://github.com/Waldehyd/Blahaj_Pentagramm_Badge", + show-index: false, /// Uncomment one of the following lines to load the above /// package information directly from the typst.toml file @@ -28,7 +25,7 @@ cover: figure(image("/images/Front.png", width: 78%)), abstract: [ - The Shorktagram-Bade features a beautiful PCB Frontplate backed with 15 individually controllable LEDs, Temperature and Humidity Sensor as well as an optional Motion Sensor. This setup makes it ideal to be used as an air sensor by day and a nightlight by uh... night. + The Shorktagram-Badge features a beautiful PCB-Frontplate backed with 15 individually controllable LEDs, Temperature and Humidity Sensor as well as an optional Motion Sensor. This setup makes it ideal to be used as an air sensor by day and a nightlight by uh... night. ], // examples-scope: ( @@ -47,39 +44,65 @@ theme: modernCustom = Assembly Part 1: PCB + Take the parts out of the bag. You only need the PCB which will contain the electronics for now. + + #subpar.grid( + figure(image("/Images/Real/PartsOverview.jpeg", width: 90%)), + columns: (1fr), + ) + + Either apply solderpaste yourself or get help from the soldering team. + #subpar.grid( + figure(image("/Images/Real/Clamp.jpeg", width: 100%)), + figure(image("/Images/Real/Clamp2.jpeg", width: 100%)), + figure(image("/Images/Real/Paste.jpeg", width: 100%)), + figure(image("/Images/Real/Paste2.jpeg", width: 100%)), + columns: 2, + ) + + Open the IBOM of the repo (PCB/PCB_Back/bom/ibom.html) and start placing the parts with a pair of tweezers. The parts in the box are sorted in the order in which they are needed. + When you are done with the first side, put the PCB in the oven and bake it for the first time. + #subpar.grid( + figure(image("/Images/Real/BottomView.jpeg", width: 72%)), + columns: (1fr), + ) + Wait until the PCB has cooled of and continue placing the parts on the other side. Please skip the hand-solder parts for now. + #subpar.grid( + figure(image("/Images/Real/TopView.jpeg", width: 72%)), + columns: (1fr), + ) + Bake the other side of the PCB. -+ Take a look at the PCB and search for shorts and errors on the placed parts. Remediate these errors before you continue. If needed, get help from your local shorktagram-dealer. -+ Hand-solder the last two parts onto the PCB. Solder on the USB-C connector legs. DO THIS BEFORE YOU PLUG IN A USB CABLE. -+ Connect your PCB to your computer and see if the ESP shows up. If so: Congratulation, you are done with the hardest part. Please return your empty tray to the workshop-hosts. If you want, they can also flash your Shorktagram-Badge ++ Take a look at the PCB and search for shorts and errors on the placed parts. Remediate these errors before you continue. If needed, get help from your local Shorktagram dealer. ++ Hand-solder the last two parts onto the PCB. Solder on the USB-C connector legs. DO THIS BEFORE YOU PLUG IN A USB CABLE. + + + + ++ Connect your PCB to your computer and see if the ESP shows up. If so: Congratulation, you are done with the hardest part. Please return your empty tray to the workshop-hosts. If you want, they can also flash your Shorktagram-Badge. + = Assembly Part 2: Case -+ Take the little bag with the screws and the standoffs. Screw the Faceplate onto the PCB with the standoffs in between. ++ Take the little bag with the screws and the standoffs. Screw the faceplate onto the PCB with the standoffs in between. #subpar.grid( - figure(image("/Images/Standoffs.png", width: 80%)), + figure(image("/Images/Standoffs.png", width: 65%)), columns: (1fr), ) - -+ Next you will need the battery and the velcro-tape. If you are planning on using the battery, apply one of the sides of the velcro to the battery-box-area on the pcb and the other side to the battery. ++ Next you will need the battery and the velcro-tape. If you are planning on using the battery, apply one of the sides of the velcro to the battery-box-area on the PCB and the other side to the battery. #subpar.grid( - figure(image("/Images/Velcro.png", width: 90%)), + figure(image("/Images/Velcro.png", width: 70%)), columns: (1fr), ) + Attach and plug in the Battery. #subpar.grid( - figure(image("/Images/AttachLipo.png", width: 80%)), + figure(image("/Images/AttachLipo.png", width: 65%)), columns: (1fr), ) @@ -87,11 +110,10 @@ theme: modernCustom + Take the case-shell and place the PCB in the correct orientation inside. #subpar.grid( - figure(image("/Images/Fullcase.png", width: 90%)), + figure(image("/Images/Fullcase.png", width: 100%)), columns: (1fr), ) - + Close the case with the three screws on the sides. #subpar.grid( @@ -111,7 +133,7 @@ theme: modernCustom #subpar.grid( - figure(image("/Images/SensorScrewToCase.png", width: 100%)), + figure(image("/Images/SensorScrewToCase.png", width: 72%)), columns: (1fr), ) @@ -129,7 +151,7 @@ theme: modernCustom = Flashing the Firmware -Prerequisites: A computer running VSCode with the Platform.io extension installed. +#strong[Prerequisites]: A computer running VSCode with the Platform.io extension installed. The Shorktagram-Badge 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 following steps: @@ -137,20 +159,19 @@ The Shorktagram-Badge is powered by WLED. As we use Usermods to support the PIR + Clone or Download the latest Version of WLED from Github (https://github.com/wled/WLED) -+ Replace the platformio.ini by the one in the /Firmware folder of Shorktagram-Badge Repository ++ Replace the platformio.ini by the one in the /Firmware folder of the Shorktagram-Badge Repository (https://github.com/Waldehyd/Blahaj_Pentagramm_Badge) + Connect the Badge to your computer via USB (if it's not recognized as a serial device, it's likely a soldering problem) + Open the WLED-Folder in VSCode -+ Choose the correct serial port of your Badge (if multiple devices are connected) and then hit Upload! ++ Choose the correct serial port of your Badge (if multiple devices are connected) and then hit upload! = Configuring WLED == Default Values After flashing, the 15 LEDs should light up instantly. The following values should be preconfigured and (if correct) should not be edited: - #figure( table( columns: (auto, auto), - stroke: 0.04em, + stroke: 0.04em, inset: 6pt, align: left, [SDA], [4], @@ -158,13 +179,12 @@ table( [PIRPIN], [13], [LEDPIN], [14], [LEDCOUNT], [15], - -) + ) ) == Wifi-Setup -By default, WLED opens up a Wifi-AP to access the Webinterface. The default password is "wled1234". To integrate your Badge into your local Wifi, hit "WiFi Setup" and enter your credentials. You can also change the password of the accesspoint from there as well. +By default, WLED opens up a Wifi-AP to access the Webinterface. The default password is "wled1234". To integrate your Badge into your local Wifi, hit "WiFi Setup" and enter your credentials. You can also change the password of the AP from there as well (we recommend this to avoid mix-ups, i.e. connecting to the wrong device). #block({ subpar.grid( @@ -211,13 +231,11 @@ If you want access the values without using Home Assistant, head over to the LED After the Badge was added to your Wifi, it's usually autodiscovered by HA and can be configured via the WLED-Integration. If not, manually install the integration manually and enter the local IP of your Badge.\ To access the values from the BME280 and the PIR, it's necessary to configure MQTT in WLED as well. If you use Home Assistant, you probably have the Mosquitto MQTT Broker installed already. Head over to "Sync Interfaces", scroll down to "MQTT" and enter the Broker IP (likely your Home Assistant IP) as well as Username and Password. Afterwards, restart WLED and you should find the published values in a MQTT-Device called "WLED". - - #subpar.grid( figure(image("/Images/HA_MQTT_WLED.png", width: 100%)), columns: (1fr), ) - +#pagebreak() /// Helper for Tidy-Support /// Uncomment, if you are using Tidy for documentation // #let show-module(name, scope: (:), outlined: true) = tidy-module(