From 1ecf3bdd3a8380441e67208be8a52e1c8d88052b Mon Sep 17 00:00:00 2001
From: cctweaker <>
Date: Thu, 26 Nov 2020 11:38:36 +0200
Subject: [PATCH] updated doc
---
README.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 29f82b3..0be6032 100644
--- a/README.md
+++ b/README.md
@@ -2,17 +2,17 @@
is covering a need for low power, cheap, battery operated sensors that you can place throughout your house.
It is designed to use an ESP-01 / ESP-01S and a SI7021 temperature and humidity sensor. BME280 sensors are also supported and add air pressure readings (real and normalized).
Communication is done through ESP-Now protocol to save a huge amount of power compared to regular WiFi.
-It needs a ESP-Now Gateway to receive its output.
+It needs a ESP-Now Gateway to receive the data and forward it to MQTT.
# Sensors supported
-- SI7021 for temperature, humidity and dew point
+- SI7021 for temperature, humidity, dew point
- BME280 for temperature, humidity, dew point, pressure, normalized pressure
# Features
- perfect for infrequent small data transmissions
-- no need for full blown WiFi, connects and transmits data instantly (50 - 100ms on time)
-- much faster than other solutions that rely on Wifi (secure MQTT takes about 15-20 seconds)
-- much faster trasnfer speed compared to other 2.4GHz protocols
+- no need for full blown WiFi, connects and transmits data instantly (172ms total wake time)
+- much faster than other solutions that rely on Wifi (about 8-10 seconds, while secure MQTT takes about 15-20 seconds)
+- much faster transfer speed compared to other 2.4GHz protocols
- lower total power consumption, great for battery operated sensors/buttons
- uses a parallel network for IoT without hoarding your DHCP leases in WiFi (just the gateway is connected)
@@ -35,7 +35,7 @@ ESP-01 and ESP-01S do not have GPIO 16 available. To use them for deepsleep a sm
Pictures are available in the project's hardware folder.
# Message format
-ESPsensor sends a message with the following format: {"t":"ESPsensor","v":2.01,"ID":"abcdef","tmp":27.02,"hum":54.74,"dew":17.14,"prs":998.08,"prn":1008.54,"vin":3.31}
+ESPsensor sends a message with the following format: {"t":"ESPsensor","v":2.01,"ID":"abcdef","vcc":3482,"tmp":27.02,"hum":54.74,"dew":17.14,"prs":998.08,"prn":1008.54}
- t: device type, value can be sensor, switch or anything else, depending on firmware
- v: firmware version
- ID: ESPid, last 3 bytes of the ESP's mac address in hex format, unique per ESP chip
@@ -44,7 +44,7 @@ ESPsensor sends a message with the following format: {"t":"ESPsensor","v":
- dew: dew point estimation
- prs: air pressure reading (only for BME280 sensor)
- prn: normalized (sea level) air pressure reading as reported in North America (only for BME280 sensor)
-- vin: raw value of ESP voltage
+- vcc: raw value of ESP voltage
# Raw voltage
To show correct ESP voltage, measure voltage after the regulator (should be 3.29 - 3.31) and calculate the correction factor.