Skip to content

Commit e5e002a

Browse files
committed
readme updated
1 parent 3bac1e4 commit e5e002a

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,17 @@
1-
# smarthome-fw-esp8266mcu11-mq4-gas-sensor
2-
Firmware for my board named ESP8266MCU11, based on ESP8266 microcontroller. This device use a MQ-4 gas sensor and use MQTT protocol to send data to OpenHAB Smart Home Automation System.
1+
# Smarthome firmware for ESP8266 - MQ-4 Gas Sensor
2+
Firmware for my board named **ESP8266MCU11**, based on **ESP8266 microcontroller**.
3+
4+
This device use a **MQ-4 gas sensor** and use **MQTT protocol** to send data to **OpenHAB Smart Home Automation System**.
5+
6+
Built with **platformio** (https://platformio.org) and **visual studio code** (https://code.visualstudio.com)
7+
8+
Depends on the following *dd libraries*:
9+
10+
- ddcommon
11+
- ddwifi
12+
- ddmqtt
13+
- ddmq4
14+
15+
To build your firmware bin file, rename file *src/user-config-template.h* in *src/user-config.h* and set your **WIFI** and **MQTT** settings.
16+
17+
Firmware file will be in ***.pio/build/esp12e/firmware.bin***

0 commit comments

Comments
 (0)