Peter M. Groen / EasyOpenTherm

Commit 37895a70bda3147b4323d9864a6d3931f72879ee

Authored by Jeroen88
1 parent 58f8807f

Some textual changes

Inline Side-by-side
Showing 4 changed files with 26 additions and 19 deletions
examples/Advanced_Thermostat/Advanced_Thermostat.ino
  View file @37895a7
... ... @@ -22,7 +22,7 @@
22 22 * You should have received a copy of the GNU General Public License
23 23 * along with this program. If not, see <https://www.gnu.org/licenses/>.
24 24 *
25   - * You need an OpenTherm controller that you can buy at my Tindie store,
  25 + * You need an OpenTherm controller that you can buy at my Tindie store, see <https://www.tindie.com/products/jeroen88/opentherm-controller/>
26 26 * Connect the two boiler wires to the OpenTherm controller pins marked OT. The order of the wires is not important.
27 27 * Connect the OpenTherm controller to your microcontroller's power (3v3) and ground (GND) pins.
28 28 * Connect the OpenTherm TXD pin to the microcontroller's pin defined by #define OT_RX_PIN.
... ...
examples/Basic_Thermostat_Commands/Basic_Thermostat_Commands.ino
  View file @37895a7
... ... @@ -18,7 +18,7 @@
18 18 * You should have received a copy of the GNU General Public License
19 19 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 20 *
21   - * You need an OpenTherm controller that you can buy at my Tindie store,
  21 + * You need an OpenTherm controller that you can buy at my Tindie store, see <https://www.tindie.com/products/jeroen88/opentherm-controller/>
22 22 * Connect the two boiler wires to the OpenTherm controller pins marked OT. The order of the wires is not important.
23 23 * Connect the OpenTherm controller to your microcontroller's power (3v3) and ground (GND) pins.
24 24 * Connect the OpenTherm TXD pin to the microcontroller's pin defined by #define OT_RX_PIN.
... ...
examples/MQTT_Advanced_Thermostat/MQTT_Advanced_Thermostat.ino
  View file @37895a7
... ... @@ -36,42 +36,49 @@
36 36 * Define the room temperature setpoint (desired room temperature) using #define ROOM_TEMPERATURE_SETPOINT. In a real application this should be settable.
37 37 * Eventually define the maximum central heating boiler temperature setpoint using #define CH_MAX_SETPOINT.
38 38 *
39   - * Compile and upload the program as normal. If the temperature measured by your sensor is lower than the ROOM_TEMPERATURE_SETPOINT this thermostat program will actually begin to heat up your room
  39 + * Compile and upload the program as normal. If the temperature measured by your sensor is lower than the ROOM_TEMPERATURE_SETPOINT this thermostat program
  40 + * will actually begin to heat up your room
40 41 */
41 42  
42 43 /* IMPORTANT NOTICES
43 44 * You have to do a lot of configuration to get this running! It is not difficult, but you have to be diligent.
44   - * This example uses a certificate to autenticate the MQTT server and to ecnrypt the connection using TLS (Transport Layer Security) with a WiFiClientSecure. If you do not want to use this feature,
45   - * because e.g. your MQTT broker does not support it, you have to adapt this program:
  45 + * This example uses a certificate to autenticate the MQTT server and to ecnrypt the connection using TLS (Transport Layer Security) with a WiFiClientSecure.
  46 + * If you do not want to use this feature, because e.g. your MQTT broker does not support it, you have to adapt this program:
46 47 * - Use a WiFiClient instead of a WiFiClientSecure
47 48 * - Do not define const char CACertificate[] (remove it from the program or leave it 'as is')
48 49 * - Do not call wiFiClient.setCACert(CACertificate);
49 50 *
50   - * You SHOULD provide your #define TIME_ZONE, otherwise the time displayed will be different than your timezone. The value provided for in the example is Central Europe Time with Daylight Saving
  51 + * You SHOULD provide your #define TIME_ZONE, otherwise the time displayed will be different than your timezone. The value provided for in the example is
  52 + * Central Europe Time with Daylight Saving
51 53 *
52 54 * You MUST provide the GPIO pins the OpenTherm controller is connected to (#define OT_RX_PIN and #define OT_TX_PIN)
53 55 *
54   - * You MUST use a BME280 temperature sensor board and provide the I2C address of your sensor and the GPIO pins it is connected to (#define BME_ADDRESS, #define I2C_SDA_PIN and I2C_SCL_PIN)
  56 + * You MUST use a BME280 temperature sensor board and provide the I2C address of your sensor and the GPIO pins it is connected to (#define BME_ADDRESS,
  57 + * #define I2C_SDA_PIN and I2C_SCL_PIN)
55 58 * You MAY use a completely different sensor, e.g a BME680 or even a Dallas temperature sensor) but then you MUST adapt the program accordingly
56 59 *
57 60 * You MUST provide your WiFi credentials (const char * ssid and const char * password)
58 61 *
59   - * You MUST provide your MQTT server, MQTT user name and MQTT password (const char * mqtt_server, const char * mqtt_user = "CloudMQTT" and const char * mqtt_password)
  62 + * You MUST provide your MQTT server, MQTT user name and MQTT password (const char * mqtt_server, const char * mqtt_user = "CloudMQTT" and
  63 + * const char * mqtt_password)
60 64 * This thermostat publishes the corrected measured room temperature to the MQTT broker in topic 'temperature'
61   - * It subscribes to topic 'room_temperature_setpoint' to receive the room temperature setpoint. This temperature is not persistant. If you restart the program, you have to resend it.
  65 + * It subscribes to topic 'room_temperature_setpoint' to receive the room temperature setpoint. This temperature is not persistant. If you restart the
  66 + * program, you have to resend it.
62 67 *
63 68 * You MUST provide the CA certificate of your MQTT server (unless you use an insecure connection, see above, const char CACertificate[])
64 69 *
65   - * You SHOULD calibrate your sensor by measuring a low temperature (e.g. 15 *C, not very critical) and a high temperature (e.g. 20 *C, again not critical) with both the temperature sensor and a
66   - * calibrated thermomter. Store the results into #define LOWER_MEASURED_TEMPERATURE, LOWER_CALIBRATED_TEMPERATURE, HIGHER_MEASURED_TEMPERATURE and HIGHER_CALIBRATED_TEMPERATURE)
  70 + * You SHOULD calibrate your sensor by measuring a low temperature (e.g. 15 *C, not very critical) and a high temperature (e.g. 20 *C, again not critical)
  71 + * with both the temperature sensor and a calibrated thermomter. Store the results into #define LOWER_MEASURED_TEMPERATURE, LOWER_CALIBRATED_TEMPERATURE,
  72 + * HIGHER_MEASURED_TEMPERATURE and HIGHER_CALIBRATED_TEMPERATURE)
67 73 *
68   - * You MAY want to change the minimum and maximum room temperature using #define ROOM_TEMPERATURE_MIN_SETPOINT and ROOM_TEMPERATURE_MAX_SETPOINT. On startup the thermostat is set to
69   - * ROOM_TEMPERATURE_MIN_SETPOINT. In this example these values are set to 12.0 and 25.0 *C
  74 + * You MAY want to change the minimum and maximum room temperature using #define ROOM_TEMPERATURE_MIN_SETPOINT and ROOM_TEMPERATURE_MAX_SETPOINT. On startup
  75 + * the thermostat is set to ROOM_TEMPERATURE_MIN_SETPOINT. In this example these values are set to 12.0 and 25.0 *C
70 76 *
71   - * You MAY want to change the minimum and maximum Central Heating boiler water temperatures using #define CH_MIN_SETPOINT and #define CH_MAX_SETPOINT. In this example these values are set to
72   - * 10.0 and 60.0 *C. Remember: lowering the maximum will reduce the power of your central heating, thus increasing the time to heaten up your room and lowering the gas usage per hour. A good
73   - * practise seems to lower this temperature for a well insulated house and/or using low temperature radiators e.g to 40.0 *C. If it takes too long to warm your house on a very cold winter day,
74   - * increase to 60.0 *C or even higher in a badly insulated house. Check your boiler manual for the right maximum temperature.
  77 + * You MAY want to change the minimum and maximum Central Heating boiler water temperatures using #define CH_MIN_SETPOINT and #define CH_MAX_SETPOINT. In
  78 + * this example these values are set to 10.0 and 60.0 *C. Remember: lowering the maximum will reduce the power of your central heating, thus increasing
  79 + * the time to heaten up your room and lowering the gas usage per hour. A good practise seems to lower this temperature for a well insulated house and/or
  80 + * using low temperature radiators e.g to 40.0 *C. If it takes too long to warm your house on a very cold winter day, increase to 60.0 *C or even higher
  81 + * in a badly insulated house. Check your boiler manual for the right maximum temperature.
75 82 *
76 83 * I hope you enjoy working with this library, pPlease share ideas in the Github Discussions sessions of this library.
77 84 */
... ... @@ -137,7 +144,7 @@
137 144  
138 145  
139 146 // Update these with values suitable for your network.
140   -const char * ssid = "[YOUR WIFI SSID]";
  147 +const char * ssid = "YOUR WIFI SSID";
141 148 const char * password = "YOUR WIFI PASSWORD";
142 149  
143 150  
... ...
examples/Test_Boiler_Communication/Test_Boiler_Communication.ino
  View file @37895a7
... ... @@ -18,7 +18,7 @@
18 18 * You should have received a copy of the GNU General Public License
19 19 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 20 *
21   - * You need an OpenTherm controller that you can buy at my Tindie store,
  21 + * You need an OpenTherm controller that you can buy at my Tindie store, see <https://www.tindie.com/products/jeroen88/opentherm-controller/>
22 22 * Connect the two boiler wires to the OpenTherm controller pins marked OT. The order is not important.
23 23 * Connect the OpenTherm controller to your microcontroller's power (3v3) and ground (GND) pins.
24 24 * Connect the OpenTherm TXD pin to the microcontroller's pin defined by #define OT_RX_PIN.
... ...