Peter M. Groen / EasyOpenTherm

Commit 49efc5760a81d824839527624681a5c5f6f1ae17

Authored by Jeroen88
1 parent 4866e2e8

First README.md draft

Inline Side-by-side
Showing 1 changed file with 67 additions and 0 deletions
examples/README.md 0 → 100644
  View file @49efc57
  1 +# Examples for OpenTherm Arduino ESP32/ESP8266 Library
  2 +
  3 +Several examples are given, all fully functional, from very basic to advanced. The first thing you should always do is to run Test_Boiler_Communication.ino or Test_HVAC_Communication.ino, to make sure your [OpenTherm controller](https://www.tindie.com/products/jeroen88/opentherm-controller/) is correctly wired, the right GPIO pins are configured and the secondary boiler or HVAC is responding to the requests of the primary thermostat.
  4 +
  5 +## Test_Boiler_Communication.ino and Test_HVAC_Communication.ino
  6 +Basic test of your setup.
  7 +
  8 +## OpenTherm_Show_DATA-IDs.ino
  9 +Sends all known DATA-IDs to the secondary and shows it's response. Can be used for both boilers and HVACs, although the boiler information is more extensive. Also the data types for the HVAC calls may not be correct.
  10 +
  11 +Sample output of this program for a Remeha Avanta shows the following:
  12 +```
  13 +Started
  14 +Request secondary services using status command:
  15 ++ Enable Domestic Hot Water (DHW)
  16 ++ Enable Central Heating (CH)
  17 ++ Enable cooling
  18 ++ Enable Outside Temperature Compensation by default
  19 +
  20 +Request services from the boiler and check it's status...
  21 +Status flags is 0x00
  22 +> Flame is off
  23 +
  24 +Checking each read DATA-ID. This may take some time, especially if the boiler does not respond to a DATA-ID because then the thermostat waits for a timeout of about a second for each of such a DATA-ID.
  25 +Fault flags:
  26 +> No faults;
  27 +> OEM specific fault code is 0xff
  28 +Secondary configuration:
  29 +> Domestic Hot Water (DHW) present
  30 +> Control type modulating
  31 +> Cooling NOT supported
  32 +> Domestic Hot Water (DHW) instantaneous or not-specified
  33 +> Primary low-off & pump control function allowed
  34 +> 2nd Central heating NOT present
  35 +> Remaining unknown flags 0x40
  36 +> Secondary Member ID is 11 (0x0b)
  37 +Secondary OpenTherm Version: 3.00
  38 +Secondary Product Version: 5, 20
  39 +Relative Modulation level: 0.00
  40 +Boiler water temperature (from boiler): 29.19 °C
  41 +Return water temperature (to boiler): 28.50 °C
  42 +Burner starts: unavailable
  43 +Central Heating pump starts: unavailable
  44 +Domestic Hot water (DHW) pump/valve starts: unavailable
  45 +Burner starts in Domestic Hot water (DHW) mode: unavailable
  46 +Burner operating hours: 16998 hours
  47 +Central Heating pump operating hours: 19894 hours
  48 +Domestic Hot Water (DHW) pump has been running or DHW valve has been opened for: 4304 hours
  49 +Domestic Hot Water (DHW) burner operating hours: 4583 hours
  50 +Remote parameters:
  51 +> Domestic Hot Water (DHW) setpoint transfer: enabled
  52 +> Max Central Heating (CH) setpoint transfer: enabled
  53 +> Domestic Hot Water (DHW) setpoint: read/write
  54 +> Max Central Heating (CH) setpoint: read/write
  55 +Domestic Hot Water (DHW) setpoint bounds between 40 and 50 °C
  56 +Central Heating (CH) setpoint bounds between 20 and 60 °C
  57 +Domestic Hot Water (DHW) temperature setpoint (remote parameter 1): 50.00 °C
  58 +Maximum allowable Central Heating (CH) water temperature setpoint (remote parameter 2): 60.00 °C
  59 +Number of unsuccessful burner starts: 1
  60 +Number of times flame signal was too low: 13
  61 +```
  62 +
  63 +## Basic_Thermostat_Commands.ino
  64 +Shows the most basic commands that can be sent from a thermostat (primary) to a boiler (secondary) and may also be used as inspiration for a HVAC thermostat. It sets the room temperature setpoint to a fixed value, which is not reasonable for a real thermostat. But it will start your boiler and heat up your house! You need a temperature sensor connected to the microcontroller. The program used a BME280 sensor, but any sensor can be used, as long as you adapt the program accordingly.
  65 +
  66 +## MQTT_Advanced_Thermostat.ino
  67 +A fully functional thermostat sending measured room temerature to a MQTT broker and receiving the room temperature setpoint by subscribing to a MQTT topic. This program may also be used as inspiration for a HVAC thermostat. Again this program needs a temperature sensor connected.
... ...