Skip to content

Commit 953cd9b

Browse files
committed
try fix CI; finish docs about pinout
1 parent 2f418b2 commit 953cd9b

File tree

2 files changed

+17
-11
lines changed

2 files changed

+17
-11
lines changed

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# floor-heating-controller
22

3-
This is an [ESPHome](https://esphome.io/) project to present to [HomeAssistant](https://www.home-assistant.io/) a floor heating controller, i.e. a board
4-
that can turn on or off the flow of warm water in under-floor heating pipes.
3+
This is an [ESPHome](https://esphome.io/) project to present to [HomeAssistant](https://www.home-assistant.io/) a floor heating controller, i.e. a board that can turn on or off the flow of warm water in under-floor heating pipes.
4+
5+
In particular this project provides an [ESPHome package](https://esphome.io/components/packages/) that is easy to reference
6+
from an ESPHome configuration. Keep reading for more details.
57

68
## Highlights
79

@@ -49,26 +51,29 @@ So if you have e.g. 5 rooms on your floor and you want to control heating indepe
4951
* cable the thermal actuator of each room to each relay available on this ESPHome project (see below ESP32 board details)
5052
* define a Generic Thermostat for each room
5153
54+
Please note that instead of writing YAML code in your HomeAssistant `configuration.yaml` file you probably
55+
want to use the HomeAssistant UI: look for Helpers and choose `Generic Thermostat` from the list.
56+
5257

5358
## Bill Of Material
5459

55-
* ESP32 relay board [bought on Aliexpress](https://it.aliexpress.com/item/1005007027676026.html?spm=a2g0o.order_list.order_list_main.31.42f53696cth4st&gatewayAdapt=glo2ita) (17.5€ in Oct 2025)
56-
Main characteristics are:
60+
* ESP32 relay board [bought on Aliexpress](https://it.aliexpress.com/item/1005007027676026.html?spm=a2g0o.order_list.order_list_main.31.42f53696cth4st&gatewayAdapt=glo2ita) (17.5€ in Oct 2025).
61+
Its main characteristics are:
5762

58-
* ESP32-WROOM-32E module
63+
* Sports an [ESP32-WROOM-32E module](./datasheets/esp32-wroom-32e_esp32-wroom-32ue_datasheet_en.pdf)
5964
* 5V DC power supply terminal
6065
* 8 relay channels, both NC and NO contacts available
6166

62-
* 220V to 5V power adapter (5W), bought on Aliexpress (4€ in Oct 2025)
67+
* 220V to 5V power adapter (5W), [bought on Aliexpress](https://it.aliexpress.com/item/1005006981553550.html?spm=a2g0o.order_list.order_list_main.47.45de36964bR8Kp&gatewayAdapt=glo2ita) (4€ in Oct 2025)
6368

6469
* Temperature sensors, bought on Aliexpress (few € in Oct 2025)
6570

66-
* MAX6675 + thermocouple for reading pipe temperature,
71+
* `MAX6675` and a K-type thermocouple for reading pipe temperature,
6772
see https://esphome.io/components/sensor/max6675/
68-
* DHT11: Digital Temperature Humidity Sensor,
73+
* `DHT11`: Digital Temperature Humidity Sensor,
6974
see https://esphome.io/components/sensor/dht/
7075

71-
## ESP32 Board Pinout
76+
## ESP32 Relay Board Pinout
7277

7378
The ESP32 relay board currently being used has the following pinout:
7479

@@ -88,7 +93,8 @@ See https://esphome.io/guides/faq.html#why-am-i-getting-a-warning-about-strappin
8893

8994
In addition to these, the following GPIOs are used for the temperature sensors:
9095

91-
TODO
96+
* GPIO5: `DHT11` sensor
97+
* GPIO16 (MISO), GPIO17 (CLK) and GPIO15 (CS): for the SPI bus to read the `MAX6675` sensor
9298

9399

94100
## Full ESPHome configuration

example-instance.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ packages:
44
files:
55
- path: main.yaml
66
vars:
7-
encryption_key: "ZGVhZGJlZWY=ZGVhZGJlZWY="
7+
encryption_key: "MqLWuv12+mOVDxRI7E0dK8Vx0+xy1gnRHEkzhXMBCac="
88
wifi_ssid: "Some-SSID"
99
wifi_password: "supersecretpassword"
1010
wifi_ap_password: "deadbeefdead"

0 commit comments

Comments
 (0)