From 693104e046c3529bfd5a169dd90f6b1463c2ea4c Mon Sep 17 00:00:00 2001 From: Sadeep Madurange Date: Wed, 21 Jun 2023 11:01:36 +0800 Subject: Updated readme. --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) (limited to 'README.md') 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. -- cgit v1.2.3