Add docs, pictures and firmware

hexaedron · Aug 20, 2024 · 852f353 · 852f353
1 parent ffcdbe0
commit 852f353
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 0 deletions.
diff --git a/Firmware/firmware.bin b/Firmware/firmware.bin
diff --git a/PCB/BOM_PressureTempMon_2024-08-19.csv b/PCB/BOM_PressureTempMon_2024-08-19.csv
diff --git a/Pictures/back.jpg b/Pictures/back.jpg
diff --git a/Pictures/pic1.jpg b/Pictures/pic1.jpg
diff --git a/Pictures/pic2.jpg b/Pictures/pic2.jpg
diff --git a/Pictures/pic3.jpg b/Pictures/pic3.jpg
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+# home_bme280
+
+A small 3-in-one thermometer, barometer and gigrometer for indoor use.
+Built with ch32v003 MCU, BME280 sensor and vk16k33 i2c 14-segment display modules.
+
+## Usage
+When powered on, the device starts cycling through 3 screens: Temperature in Celsius, Humidity and air pressure in mm Hg.
+* To set the brightness, rotate the encoder.
+* To set the screen change interval, press and hold the encoder for 2+ seconds, set the desired interval and then click it again.
+* To force the immediate screen change, click the encoder.
+
+## Assembly
+Assembly is pretty straightforward. You should just note that PCB is a little bit redundant. A first my idea was to add an LDR resistor, but i've abandoned that idea later. So you can omit R_LDR and J_LDR. The firmware doesn't use them.
+I've also made some extra pins availiable as J_EXT. Feel free to use them to extend functionality if you want.
+
+## Build
+You will need [ch32v00fun](https://github.com/cnlohr/ch32v003fun/) and [funny_libs](https://github.com/hexaedron/funny_libs) to build it. I prefer using official WCH toolchain. If you prefer using vanilla risc-v GCC, then remove `#define WCH_FAST_INTERRUPT_ENABLED` from `funny_defs.h`.
+
+![photo](/Pictures/pic1.jpg)
+![photo](/Pictures/pic2.jpg)
+![photo](/Pictures/pic3.jpg)
+![photo](/Pictures/back.jpg)