Skip to content

Commit

Permalink
updated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
cctweaker committed Nov 26, 2020
1 parent c70de14 commit 1ecf3bd
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://github.com/cctweaker/ESPGW-Now">ESP-Now Gateway</a> to receive its output.
It needs a <a href="https://github.com/cctweaker/ESPGW-Now">ESP-Now Gateway</a> 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)

Expand All @@ -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: <code>{"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}</code>
ESPsensor sends a message with the following format: <code>{"t":"ESPsensor","v":2.01,"ID":"abcdef","vcc":3482,"tmp":27.02,"hum":54.74,"dew":17.14,"prs":998.08,"prn":1008.54}</code>
- 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
Expand All @@ -44,7 +44,7 @@ ESPsensor sends a message with the following format: <code>{"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.
Expand Down

0 comments on commit 1ecf3bd

Please sign in to comment.