summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSadeep Madurange <sadeep@asciimx.com>2023-06-21 11:01:36 +0800
committerSadeep Madurange <sadeep@asciimx.com>2023-06-21 11:01:36 +0800
commit693104e046c3529bfd5a169dd90f6b1463c2ea4c (patch)
tree7f75a7eee86a2145b67b3cf4de41c7e5c0d51e1f
parentf3988cd231ff5200e95db82e4e203cb4188a68b4 (diff)
downloadesp8266-dht22-weather-station-693104e046c3529bfd5a169dd90f6b1463c2ea4c.tar.gz
Updated readme.
-rw-r--r--README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index dab3f21..4a60f98 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,15 @@
-# esp-8266-dht22-weather-station
-Stream temperature and humidity data from a DHT22 sensor to an MQTT broker in the cloud.
+# ESP8266-DHT22 Weather Station
+
+A pure C implementation of a weather station using an ESP-01 and a DHT22 sensor. Special thanks to [Fonger](https://github.com/Fonger/ESP8266-RTOS-DHT) for the DHT22 protocol implementation.
+
+## Prerequisites
+
+ - ESP-01 module (or any later versions of an ESP8266 module)
+ - [DHT22 sensor module](https://www.sparkfun.com/datasheets/Sensors/Temperature/DHT22.pdf)
+ - [ESP8266 RTOS SDK](https://github.com/espressif/ESP8266_RTOS_SDK)
+
+## Building the project
+
+ - Rename `Kconfig.projbuild.example` to `Kconfig.projbuild`.
+ - Update configuration settings for your WiFi AP and the MQTT broker in the `Kconfig.projbuild`.
+ - Run `make flash` to build and upload the program to ESP8266.