readme update

HeishaMon/HeishaOT.cpp

@@ -58,9 +58,9 @@ void processOTRequest(unsigned long request, OpenThermResponseStatus status) {
   char log_msg[512];
   {
     //only for debugging OT messages
-    char str[200];
-    sprintf_P(str, PSTR("%#010x"), request);
-    mqttPublish((char*)mqtt_topic_opentherm_write, _F("raw"), str, false);
+    //char str[200];
+    //sprintf_P(str, PSTR("%#010x"), request);
+    //mqttPublish((char*)mqtt_topic_opentherm_write, _F("raw"), str, false);
   }
   switch (ot.getDataID(request)) {
     case OpenThermMessageID::Status: { //mandatory

HeishaMon/version.h

@@ -1 +1 @@
-static const char* heishamon_version = "3.2.4-beta";
+static const char* heishamon_version = "3.2.4-beta-OTupdates";

README.md

@@ -309,6 +309,27 @@ All the [libs we use](LIBSUSED.md) necessary for compiling.
 ## DS18b20 1-wire support
 The software also supports ds18b20 1-wire temperature sensors reading. A proper 1-wire configuration (with 4.7kohm pull-up resistor) connected to GPIO4 will be read each configured secs (minimal 5) and send at the panasonic_heat_pump/1wire/"sensor-hex-address" topic. On the pre-made boards this 4.7kohm resistor is already installed.
 
+## Opentherm support
+If your heishamon board supports opentherm the software can also be used to bridge opentherm information from a compatible thermostat to your home automation over MQTT or JSON and as mentioned above it can also be connected directly in the rules to connect opentherm information to the heatpump and back, for example to display the outside temperature from the heatpump on your opentherm thermostat. If you enable opentherm support in settings there will be a new tab visible in the web page. On that tab you will see opentherm values. Some are of type R(ead) and some are W(rite), and some are both. Read means that the thermostat can read that information from the heishamon. You provide that information over MQTT (or using the rules) by updating this value on the mqtt 'opentherm/read' topic, for example 'panasonic_heat_pump/opentherm/read/outsideTemp'. The write values are information from the thermostat, like 'roomTemp'. These are available on mqtt topic 'opentherm/write'. You can use these values to change the heatpump behaviour in anyway you want using your home automation and mqtt set-commands to heishamon on using the internal rules.
+
+The available opentherm variables are: \
+-chEnable which is a boolean showing if central heating shoud be enabled. This is often used when the thermostat wants to heat up your house.
+-dhwEnable which is a boolean showing if the dhw heating should be enabled. Often used as a user option on the thermostat to disable DHW heating during vacation
+-roomTemp is the floating point value of the measured room temp by thermostat
+-roomTempSet is the floating point value of the requested room temp setpoint on the thermostat
+-chSetpoint is the floating point value of the calculated water setpoint by thermostat. Opentherm thermostats try to set this chSetpoint to not overshoot the room setpoint
+READ AND WRITE values
+-dhwSetpoint is the floating point value which is the current DHW setpoint by thermostat, but can also be set by heishamon to override it. Not all thermostat support this though.
+-maxTSet is the floating point value which defines the maximum water setpoin. The user can set this on the thermostat or can also set from heishamon.
+READ values
+-chPressure is the floating point value which defines measured water pressure of central heating provided by heishamon
+-outsideTemp is the floating point value which defines measured outside temperature of central heating provided by heishamon
+-inletTemp is the floating point value which defines measured water inlet temperature of central heating provided by heishamon
+-outletTemp is the floating point value which defines measured water outlet temperature of central heating provided by heishamon
+-dhwTemp is the floating point value which defines measured dhw temperature of central heating provided by heishamon
+-flameState is a boolean value which defines if the central heating is providing heat central
+-chState is a boolean value which defines if the heatpump is on room/central heating mode (for example 3-way valve on room)
+-dhwState is a boolean value which defines if the heatpump is on DHW mode (for example 3-way valve on dhw)
 
 ## Protocol byte decrypt info:
 [Current list of documented bytes decrypted can be found here](ProtocolByteDecrypt.md)