Update readme.md

This commit is contained in:
Ser Ko 2020-01-18 17:26:06 -05:00
parent 43e0186efe
commit 57c0b408e5

View File

@ -1,22 +1,22 @@
# Almost universal controller board for outdoor applications # Almost universal controller board for outdoor applications
This usermod is using ideas from @mrVanboy and @400killer This usermod is using ideas from @mrVanboy and @400killer
## Features ## Features
- SSD1306 128x32 and 128x64 I2C OLED display * SSD1306 128x32 and 128x64 I2C OLED display
- On screen IP address, SSID and controller status (e.g. ON or OFF, recent effect) * On screen IP address, SSID and controller status (e.g. ON or OFF, recent effect)
- Auto display shutoff for saving display lifetime * Auto display shutoff for saving display lifetime
- Dallas temperature sensor * Dallas temperature sensor
- Reporting temperature to MQTT broker * Reporting temperature to MQTT broker
## Hardware ## Hardware
![Hardware connection](assets/controller.jpg) ![Hardware connection](assets/controller.jpg)
## Functionality checked with: ## Functionality checked with:
- ESP-07S * ESP-07S
- PlatformIO * PlatformIO
- SSD1306 128x32 I2C OLED display * SSD1306 128x32 I2C OLED display
- DS18B20 (temperature sensor) * DS18B20 (temperature sensor)
- KY-022 (infrared receiver) * KY-022 (infrared receiver)
- Push button (N.O. momentary switch) * Push button (N.O. momentary switch)
### Platformio requirements ### Platformio requirements
Uncomment `U8g2@~2.27.3`,`DallasTemperature@~3.8.0`,`OneWire@~2.3.5 under` `[common]` section in `platformio.ini`: Uncomment `U8g2@~2.27.3`,`DallasTemperature@~3.8.0`,`OneWire@~2.3.5 under` `[common]` section in `platformio.ini`:
@ -33,4 +33,4 @@ lib_deps_external =
DallasTemperature@~3.8.0 DallasTemperature@~3.8.0
OneWire@~2.3.5 OneWire@~2.3.5
... ...
``` ```