Browse Source

updated README.md

FloKra 5 years ago
parent
commit
d7057e19cd
1 changed files with 10 additions and 4 deletions
  1. 10 4
      README.md

+ 10 - 4
README.md

@@ -4,7 +4,7 @@ ESP8266 based, WiFi connected set-point thermostat designed as replacement for e
 
 ## Features
 * current temperature/humidity measurement using DHT22 sensor with value smoothing
-* thermostat with configurable hysteresis and 2 modes with different set-point temperatures (normal and reduction)
+* thermostat with configurable hysteresis and 3 modes with different set-point temperatures (normal, 2x reduction)
 * control unit with LCD and 3 pushbuttons
 * power unit with power supply and relais for heating control
 * telemetry via WiFi/MQTT (set temp, heating mode, heating on/off, PIR-sensor)
@@ -13,12 +13,19 @@ ESP8266 based, WiFi connected set-point thermostat designed as replacement for e
 * PIR movement sensor for room surveillance can be attached, status is pushed via MQTT
 * initial configuration via WiFi AP mode with captive portal
 * non blocking WiFi and MQTT connection
+* built-in support for Home Assistant home automation server via MQTT, supports:
+	* set heating target temperature
+	* set heating mode
+	* local or webIF changes sends updates to HASS
+	* current temperature/humidity is reported
+	* PIR sensor state changes (if connected) are reported
 * built-in 2-way support for [Domoticz](https://domoticz.com/) Home Automation controller over MQTT
 	* set point and mode can be controlled from Domoticz
 	* local changes sending updates to Domoticz
 	* current temperature/humidity is reported to Domoticz
 	* PIR sensor state changes (if connected) are pushed to Domoticz
 	* designed to use Domoticz as the "intelligent" controller for schedules etc.
+	* NOW NOT UNDER ACTIVE DEVELOPMENT ANY MORE as I switched to Home Assistant
 * value changes (set point and mode, both from local and remote) can be automatically saved to flash
 
 ## Hardware
@@ -46,7 +53,7 @@ consists of:
 
 ## Libraries
 
-### ESP8266 core for Arduino 2.4.0
+### ESP8266 core for Arduino 2.4.0 beta2 (as 2.4 release has connection bugs)
 * ESP8266WiFi.h
 * WiFiClient.h
 * ESP8266WebServer.h
@@ -77,10 +84,9 @@ Used with modification - added #define WIFI_HTM_PROGMEM to PersWiFiManager.cpp (
 
 https://github.com/r-downing/PersWiFiManager
 
-### knolleary PubSubClient 2.6
+### knolleary PubSubClient 2.7
 MQTT client for Arduino. Used with the following modified DEFINEs in PubSubClient.h: 
 * MQTT_MAX_PACKET_SIZE: increased to 512, needed for receiving/parsing domoticz/out topic
-* MQTT_SOCKET_TIMEOUT: decreased to 2, to improve non-blocking operation
 
 https://github.com/knolleary/pubsubclient