Skip to content
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 22 additions & 20 deletions content/components/uponor_smatrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The [UART Component](#uart) must be configured with a baud rate of 19200, 8 data

## Getting started

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.
The thermostats have unique addresses used for communication that are not displayed anywhere but can only be found when scanning the bus.
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.

```yaml
Expand All @@ -32,28 +32,32 @@ uponor_smatrix:
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.

```text
[00:00:00][C][uponor_smatrix:019]: Uponor Smatrix
[00:00:00][C][uponor_smatrix:020]: System address: 0x110B
[00:00:00][C][uponor_smatrix:020]: Uponor Smatrix
[00:00:00][C][uponor_smatrix:031]: Detected unknown device addresses:
[00:00:00][C][uponor_smatrix:033]: 0xDE62
[00:00:00][C][uponor_smatrix:033]: 0xDDFF
[00:00:00][C][uponor_smatrix:033]: 0xDE72
[00:00:00][C][uponor_smatrix:033]: 0xDE4A
[00:00:00][C][uponor_smatrix:033]: 0xDE13
[00:00:00][C][uponor_smatrix:033]: 0x110BDE62
[00:00:00][C][uponor_smatrix:033]: 0x110BDDFF
[00:00:00][C][uponor_smatrix:033]: 0x110BDE72
[00:00:00][C][uponor_smatrix:033]: 0x110BDE4A
[00:00:00][C][uponor_smatrix:033]: 0x110BDE13
```

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.
With that you can then add `climate` or `sensor` components for the detected devices.

```yaml
uponor_smatrix:
address: 0x110B

climate:
- platform: uponor_smatrix
address: 0xDE13
address: 0x110BDE13
name: Thermostat Living Room
```

> [!IMPORTANT]
> Previous versions of the component used a 16 bit system address in addition to 16 bit device addresses.
> This has now been combined into 32 bit device addresses.
> Please update your configuration by prepending the old system address to your device addresses.
> **Example:** The system address 0x110B and device address 0xDE13 should now become 0x110BDE13.

## Component/Hub

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.
Expand All @@ -62,35 +66,33 @@ It is also able to synchronize the date and time of the thermostats with a time

```yaml
uponor_smatrix:
address: 0x110B
uart_id: my_uart
time_id: my_time
```

### Configuration variables

- **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.
- **uart_id** (*Optional*, [ID](#config-id)): Manually specify the ID of the [UART Component](#uart) if you want to use multiple UART buses.
- **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.
- **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.
- **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.
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.

> [!NOTE]
> 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!
> You can safely leave out those parameters in almost all cases.
> The address of the thermostat keeping the time will be automatically detected from the bus if not specified in the configuration!
> 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.

## Climate

```yaml
climate:
- platform: uponor_smatrix
address: 0xDE13
address: 0x110BDE13
name: Thermostat Living Room
```

### Configuration variables

- **address** (**Required**, int): The 16 bit device address of the thermostat. See [Getting started](#uponor-gettingstarted) on how to find the address.
- **address** (**Required**, int): The 32 bit device address of the thermostat. See [Getting started](#uponor-gettingstarted) on how to find the address.
- **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.
- All options from [Climate](#config-climate).

Expand All @@ -99,7 +101,7 @@ climate:
```yaml
sensor:
- platform: uponor_smatrix
address: 0xDE13
address: 0x110BDE13
humidity:
name: Humidity Living Room
temperature:
Expand All @@ -112,7 +114,7 @@ sensor:

### Configuration variables

- **address** (**Required**, int): The 16 bit device address of the thermostat. See [Getting started](#uponor-gettingstarted) on how to find the address.
- **address** (**Required**, int): The 32 bit device address of the thermostat. See [Getting started](#uponor-gettingstarted) on how to find the address.
- **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.
- **humidity** (*Optional*): A sensor reading the current humidity the thermostat reports.
All options from [Sensor](#config-sensor).
Expand Down