From 1de7c71878701167d185b1467905660bafdb0637 Mon Sep 17 00:00:00 2001 From: Markus Eckl Date: Sun, 23 Apr 2023 23:58:46 +0200 Subject: [PATCH] Update README.md --- README.md | 38 ++++++++++++++++++++++++-------------- 1 file changed, 24 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index dd03ac1..5698cd5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # OilMeter -Measure the oil consumption via the burner status LED on a ESP8266 with a TCS34725 or APDS9960 color sensor. (HC-SR04 planned) -BOM is just ~10 Euro for all parts. +Measure oil consumption on a ESP8266 via TCS34725 or APDS9960 color sensors and the burner status-LED or +HC-SR04/JSN-SR04T distance-sensor (currently implementation phase). ## Oilmeter comes with the following features included: - First start as AccessPoint (OilMeter, PWD: OilMeter), after saving Wifi-Settings it will connect to default Wifi. @@ -12,16 +12,24 @@ BOM is just ~10 Euro for all parts. - Updates on the fly with direct Firmware Uploads (powered by ElegantOTA). - existing Sensor adapter plates can be 3D-Printed. +## Flashing +Please install Visual Studio code and inside visual studio code the PlatformIO Workbench. +Load the project folder and adapt your Com-Port in Platform.ini. Click Build and Upload. +for updates you can use the OTA-Feature and the .bin files included in this repository. +More installation Methods will follow (please help how to setup Chrome-Online Firmware flasher). + ## Notes If you have problems with ESP-restarts please consider that the burner needs a high voltage to start burning. -This high voltage can be transmitted via the wires and causes the ESP to restart. To avoid this you can take a foil -(or some tabac-box) to isolate the esp and network cables to isolate the sensor wires. Make sure you put the isolation material with -a extra-wire to any ground in your house. +(in the webinterface you can see the reboot-cause. 'exception' can be a hint for such a high-voltage reset). +This high voltage can be transmitted via the wires and causes the ESP to restart. To avoid restarts you should +use isolated wires for the power-switch and sensor cabling and a separate isolation (e.g. Tabac-Box) to shim the esp +itself. make sure the isolation is connected to some ground of your house. +Also make sure you use a stable power-supply. To make good measures you need to know the actual tank volume. You can do this by estimate based on the height of the oil in the tank or you start from scratch if the tank is filled up to its maximum. After the first refill you can adapt your values based on whats -really used vs. whats refilled. +really used vs. whats refilled via the adaption factor in the webinterface. ## Pictures @@ -30,15 +38,17 @@ really used vs. whats refilled. ![Webinterface](Pictures/Webinterface.png) ![Homeassistant](Pictures/HassIO.png) -# Connection diagram +# Connection diagram (3.3 or 5V based on your Sensor) -| ESP | GYP | TCS | -| ----- | --- | --- | -| 3V3 | VCC | VIN | -| GND | GND | GND | -| D6 | INT | LED | -| D2 | SDA | SDA | -| D1 | SCL | SCL | +| ESP | GYP | TCS | HC/JSN | +| ----- | --- | --- | ---- | +| 3V3/5V| VCC | VIN | VCC | +| GND | GND | GND | GND | +| D6 | INT | LED | ---- | +| D2 | SDA | SDA | ---- | +| D1 | SCL | SCL | ---- | +| D7 | | | TRIG | +| D8 | | | ECHO | #Todo