Update README.md files

Jeroen88
1 parent 1f2f6b3f
Showing 2 changed files with 8 additions and 8 deletions
README.md
examples/README.md
@@ -5,25 +5,25 @@ Create your own thermostat with this library and save money on your energy bills
 The library complies with the OpenTherm specification. Control any (condensing) boiler or air conditioner (HVAC) that also meets the OpenTherm specification.
  
 The library can be easily installed in the Arduino IDE. It has been tested on an ESP32 microcontroller and may also work on an ESP8266.
-To connect the boiler, you will need an [OpenTherm controller](https://www.tindie.com/products/jeroen88/opentherm-controller/) or an [OpenTherm controller Shield](https://www.tindie.com/products/jeroen88/opentherm-controller-shield/).
+To connect the boiler, you will need an [OpenTherm controller](https://www.tindie.com/products/jeroen88/opentherm-controller/) or an [OpenTherm controller Shield](https://www.tindie.com/products/jeroen88/opentherm-shield/).
  
 ## Fully functioning Home Assistant Boiler Thermostat in examples
 ![Home Assistant logo](https://raw.githubusercontent.com/home-assistant/assets/master/logo/logo-small.png)
 ![MQTT logo](https://brands.home-assistant.io/_/mqtt/logo.png)\
  
-The Advanced_Thermostat example is specially designed for Home Assistant
+The Advanced_Thermostat.ino example is specially designed for [Home Assistant](https://www.home-assistant.io/)
 - Setup the MQTT integration in Home Assistant, if not already done
 - Set your WiFi network name and password in Advanced_Thermostat.ino
 - Set your MQTT broker hostname or IP address, MQTT user name and MQTT password in Advanced_Thermostat.ino
-- Compile and flash to an ESP32-S2 with an [OpenTherm controller Shield](https://www.tindie.com/products/jeroen88/opentherm-controller-shield/)
+- Compile and flash to an ESP32-S2 with an [OpenTherm controller Shield](https://www.tindie.com/products/jeroen88/opentherm-shield/)
 - Forward the temperature of a room thermometer to the Thermostat using a Home Assistant Automation
-The thermostat (Climate) integration is automatically added to Home Assistant, together with several sensors. More information in ==TO DO LINK TO README.md in EXAMPLE==
+The thermostat (Climate) integration is **automatically added to Home Assistant**, together with several sensors. More information in [the examples directory](https://github.com/Jeroen88/EasyOpenTherm/tree/main/examples).
  
 ## Installation
 - Install the EasyOpenTherm library directly using the Arduino IDE library manager
-- Connect the pins marked 'OT' of the [OpenTherm controller](https://www.tindie.com/products/jeroen88/opentherm-controller/) with two wires to the boiler. You can use the existing wires from your current thermostat. The order of the wires is not important, they are interchangeable
-- Connect the pins marked '3v3' and 'GND' to the ESP32 pins '3v3;  and 'GND'
-- Connect the pin marked 'RxD' to a pin supporting OUTPUT of the ESP32 and the pin marked 'TxD' to a pin supporting interrupts. The pins you use should be defined in the program (see below)
+- Connect the pins marked 'OT' of the [OpenTherm controller](https://www.tindie.com/products/jeroen88/opentherm-controller/) with two wires to the boiler or use the screw terminals on the [OpenTherm controller shield](https://www.tindie.com/products/jeroen88/opentherm-shield/). You can use the existing wires from your current thermostat. The order of the wires is not important, they are interchangeable
+- If using the _board_ connect the pins marked '3v3' and 'GND' to the ESP32 pins '3v3;  and 'GND'. For the _shield_ these pins are already connected
+- If using the _board_ connect the pin marked 'RxD' to a pin supporting OUTPUT of the ESP32 and the pin marked 'TxD' to a pin supporting interrupts. For the _shield_ these pins are already connected. The pins used you use should be defined in the program (see below). In Advanced_Thermostat.ino they default to the right pins for the shield and either an ESP32-S2 mini or an ESP32-C3 mini.
  
 ## Usage
 ```cpp
 # Examples for OpenTherm Arduino ESP32 Library
  
-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/) or [OpenTherm controller Shield](https://www.tindie.com/products/jeroen88/opentherm-controller-shield/) is correctly wired, the right GPIO pins are configured and the secondary boiler or HVAC is responding to the requests of the primary thermostat.
+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/) or [OpenTherm controller Shield](https://www.tindie.com/products/jeroen88/opentherm-shield/) is correctly wired, the right GPIO pins are configured and the secondary boiler or HVAC is responding to the requests of the primary thermostat.
  
 ## Test_Boiler_Communication.ino and Test_HVAC_Communication.ino
 Basic test of your setup. If everything is OK, you will see: