You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[uponor_smatrix] Use combined 32 bit addresses instead of separate 16 bit system and device addresses (#5452)
* [uponor_smatrix] Use combined 32 bit addresses instead of separate 16 bit system and device addresses
* Remove blank line
---------
Co-authored-by: J. Nick Koston <[email protected]>
Copy file name to clipboardExpand all lines: content/components/uponor_smatrix.md
+22-20Lines changed: 22 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ The [UART Component](#uart) must be configured with a baud rate of 19200, 8 data
22
22
23
23
## Getting started
24
24
25
-
The controller and the thermostats have unique addresses used for communication that are not displayed anywhere but can only be found when scanning the bus.
25
+
The thermostats have unique addresses used for communication that are not displayed anywhere but can only be found when scanning the bus.
26
26
Start with a basic configuration that just contains the UART and Uponor hub components. Make sure that the UART pins are configured according to your wiring and the baud rate is set to 19200.
27
27
28
28
```yaml
@@ -32,28 +32,32 @@ uponor_smatrix:
32
32
When you upload this configuration to your ESPHome device and connect it to the Uponor Smatrix bus, it will print a list of detected addresses to the log output.
33
33
34
34
```text
35
-
[00:00:00][C][uponor_smatrix:019]: Uponor Smatrix
36
-
[00:00:00][C][uponor_smatrix:020]: System address: 0x110B
With that you can then add `climate` or `sensor` components for the detected devices. Optionally, you can also statically add the detected system address to your `uponor_smatrix` configuration.
44
+
With that you can then add `climate` or `sensor` components for the detected devices.
46
45
47
46
```yaml
48
47
uponor_smatrix:
49
-
address: 0x110B
50
48
51
49
climate:
52
50
- platform: uponor_smatrix
53
-
address: 0xDE13
51
+
address: 0x110BDE13
54
52
name: Thermostat Living Room
55
53
```
56
54
55
+
> [!IMPORTANT]
56
+
> Previous versions of the component used a 16 bit system address in addition to 16 bit device addresses.
57
+
> This has now been combined into 32 bit device addresses.
58
+
> Please update your configuration by prepending the old system address to your device addresses.
59
+
> **Example:** The system address 0x110B and device address 0xDE13 should now become 0x110BDE13.
60
+
57
61
## Component/Hub
58
62
59
63
The main `uponor_smatrix` component is responsible for the communication with the controller and thermostats and distributes data to the climate and sensor components described below.
@@ -62,35 +66,33 @@ It is also able to synchronize the date and time of the thermostats with a time
62
66
63
67
```yaml
64
68
uponor_smatrix:
65
-
address: 0x110B
66
69
uart_id: my_uart
67
70
time_id: my_time
68
71
```
69
72
70
73
### Configuration variables
71
74
72
-
- **address** (*Optional*, int): The 16 bit system/controller address. This will be automatically detected from the bus if not specified. See [Getting started](#uponor-gettingstarted) on how to find the address.
73
75
- **uart_id** (*Optional*, [ID](#config-id)): Manually specify the ID of the [UART Component](#uart) if you want to use multiple UART buses.
74
76
- **time_id** (*Optional*, [ID](#config-id)): Specify the ID of the {{< docref "time/index" "Time Component" >}} to use as the time source if you want ESPHome to automatically synchronize the date and time of the thermostats.
75
-
- **time_device_address** (*Optional*, int): The 16 bit device address of the thermostat that keeps the system time. This will be automatically detected from the bus if not specified.
77
+
- **time_device_address** (*Optional*, int): The 32 bit device address of the thermostat that keeps the system time. This will be automatically detected from the bus if not specified.
76
78
It needs to be the device address of the first thermostat that was paired to the controller, and the one where you can manually change the date and time via the buttons on the thermostat.
77
79
78
80
> [!NOTE]
79
-
> The system address and the address of the thermostat keeping the time will be automatically detected from the bus if not specified in the configuration!
80
-
> You can safely leave out those parameters in almost all cases.
81
+
> The address of the thermostat keeping the time will be automatically detected from the bus if not specified in the configuration!
82
+
> You can safely leave it out in almost all cases. Time synchronization should work automatically as long as you add any time component to your configuration.
81
83
82
84
## Climate
83
85
84
86
```yaml
85
87
climate:
86
88
- platform: uponor_smatrix
87
-
address: 0xDE13
89
+
address: 0x110BDE13
88
90
name: Thermostat Living Room
89
91
```
90
92
91
93
### Configuration variables
92
94
93
-
- **address** (**Required**, int): The 16 bit device address of the thermostat. See [Getting started](#uponor-gettingstarted) on how to find the address.
95
+
- **address** (**Required**, int): The 32 bit device address of the thermostat. See [Getting started](#uponor-gettingstarted) on how to find the address.
94
96
- **uponor_smatrix_id** (*Optional*, [ID](#config-id)): Manually specify the ID of the `uponor_smatrix` hub component if you want to use multiple hub components on one ESPHome device.
95
97
- All options from [Climate](#config-climate).
96
98
@@ -99,7 +101,7 @@ climate:
99
101
```yaml
100
102
sensor:
101
103
- platform: uponor_smatrix
102
-
address: 0xDE13
104
+
address: 0x110BDE13
103
105
humidity:
104
106
name: Humidity Living Room
105
107
temperature:
@@ -112,7 +114,7 @@ sensor:
112
114
113
115
### Configuration variables
114
116
115
-
- **address** (**Required**, int): The 16 bit device address of the thermostat. See [Getting started](#uponor-gettingstarted) on how to find the address.
117
+
- **address** (**Required**, int): The 32 bit device address of the thermostat. See [Getting started](#uponor-gettingstarted) on how to find the address.
116
118
- **uponor_smatrix_id** (*Optional*, [ID](#config-id)): Manually specify the ID of the `uponor_smatrix` hub component if you want to use multiple hub components on one ESPHome device.
117
119
- **humidity** (*Optional*): A sensor reading the current humidity the thermostat reports.
0 commit comments