Skip to content

Commit b63a9e8

Browse files
andrewfgandrewfg
committed
adopt reviewer suggestions
Signed-off-by: Andrew Fiddian-Green <[email protected]>
1 parent 02d1b5a commit b63a9e8

File tree

1 file changed

+44
-44
lines changed

1 file changed

+44
-44
lines changed

‎bundles/org.openhab.binding.tado/README.md

+44-44
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ There are two ways to authenticate it as follows:
2020
Note: after March 15th, 2025 online authentication is the tado° preferred method.
2121
It is possible that the `username` and `password` method may cease to work some time after this date.
2222

23-
Parameter | Required | Description
24-
-|-|-
25-
`username` | yes | Username used to log in at [my.tado](https://my.tado.com)
26-
`password` | yes | Password of the username
23+
| Parameter | Required | Description |
24+
|------------|----------|-----------------------------------------------------------|
25+
| `username` | yes | Username used to log in at [my.tado](https://my.tado.com) |
26+
| `password` | yes | Password of the username |
2727

2828
Example `tado.things`
2929

@@ -35,21 +35,21 @@ Once the `home` thing is online, the binding will discover all its respective zo
3535

3636
### Channels
3737

38-
Name | Type | Description | Read/Write
39-
-|-|-|-
40-
`homePresence` | String | Current presence value of the tado home. `HOME` and `AWAY` can be set | RW
38+
| Name | Type | Description | Read/Write |
39+
|----------------|--------|-----------------------------------------------------------------------|------------|
40+
| `homePresence` | String | Current presence value of the tado home. `HOME` and `AWAY` can be set | RW |
4141

4242
## `zone` Thing
4343

4444
A _zone_ is an area/room of your home.
4545
You have defined them during installation.
4646
One zone relates to one page in the tado° mobile- or webapp.
4747

48-
Parameter | Required | Description | Default
49-
-|-|-|-
50-
`id` | yes | Zone Id | -
51-
`refreshInterval` | no | Refresh interval of state updates in seconds | 30
52-
`hvacChangeDebounce` | no | Duration in seconds to combine multiple HVAC changes into one | 5
48+
| Parameter | Required | Description | Default |
49+
|----------------------|----------|---------------------------------------------------------------|---------|
50+
| `id` | yes | Zone Id | - |
51+
| `refreshInterval` | no | Refresh interval of state updates in seconds | 30 |
52+
| `hvacChangeDebounce` | no | Duration in seconds to combine multiple HVAC changes into one | 5 |
5353

5454
Zones can either be added through discovery or manually. Following up on the above example, a zone configuration could look like this:
5555

@@ -71,26 +71,26 @@ A zone is either of type `HEATING`, `AC` or `DHW` (domestic hot water).
7171
The availability of items as well as their allowed values depend on type and capabilities of the HVAC setup.
7272
If you are unsure, have a look at the tado° app and see if the functionality is available and what values are supported.
7373

74-
Name | Type | Description | Read/Write | Zone type
75-
-|-|-|-|-
76-
`currentTemperature` | Number:Temperature | Current inside temperature | R | `HEATING`, `AC`
77-
`humidity` | Number:Dimensionless | Current relative inside humidity in percent | R | `HEATING`, `AC`
78-
`hvacMode` | String | Active mode, one of `OFF`, `HEAT`, `COOL`, `DRY`, `FAN`, `AUTO` | RW | `HEATING` and `DHW` support `OFF` and `HEAT`, `AC` can support more
79-
`targetTemperature` | Number:Temperature | Set point | RW | `HEATING`, `AC`, `DHW`
80-
`operationMode` | String | Operation mode the zone is currently in. One of `SCHEDULE` (follow smart schedule), `MANUAL` (override until ended manually), `TIMER` (override for a given time), `UNTIL_CHANGE` (active until next smart schedule block or until AWAY mode becomes active) | RW | `HEATING`, `AC`, `DHW`
81-
`overlayExpiry` | DateTime | End date and time of a timer | R | `HEATING`, `AC`, `DHW`
82-
`timerDuration` | Number | Timer duration in minutes | RW | `HEATING`, `AC`, `DHW`
83-
`heatingPower` | Number:Dimensionless | Amount of heating power currently present | R | `HEATING`
84-
`acPower` | Switch | Indicates if the Air-Conditioning is Off or On | R | `AC`
85-
`fanspeed`<sup>1)</sup> | String | Fan speed, one of `AUTO`, `LOW`, `MIDDLE`, `HIGH` | RW | `AC`
86-
`fanLevel`<sup>1)</sup> | String | Fan speed, one of <sup>3)</sup> `AUTO`, `SILENT`, `LEVEL1`, `LEVEL2`, `LEVEL3`, `LEVEL4`, `LEVEL5` | RW | `AC`
87-
`swing`<sup>2)</sup> | Switch | Swing on/off | RW | `AC`
88-
`verticalSwing`<sup>2)</sup> | String | Vertical swing state, one of <sup>3)</sup> `OFF`, `ON`, `UP`, `MID_UP`, `MID`, `MID_DOWN`, `DOWN`, `AUTO` | RW | `AC`
89-
`horizontalSwing`<sup>2)</sup> | String | Horizontal swing state, one of <sup>3)</sup> `OFF`, `ON`, `LEFT`, `MID_LEFT`, `MID`, `MID_RIGHT`, `RIGHT`, `AUTO` | RW | `AC`
90-
`batteryLowAlarm` | Switch | A control device in the Zone has a low battery | R | Any Zone
91-
`openWindowDetected` | Switch | An open window has been detected in the Zone | R | `HEATING`, `AC`
92-
`openWindowRemainingTime` | Number:Time | The remaining Open Window heating/cooling Override time in the Zone | R | `HEATING`, `AC`
93-
`light` | Switch | State (`ON`, `OFF`) of the control panel light | RW | `AC`
74+
| Name | Type | Description | Read/Write | Zone type |
75+
|--------------------------------|----------------------|-------------------------------------------------------------------------------------------------------------------|------------|------------------------|
76+
| `currentTemperature` | Number:Temperature | Current inside temperature | R | `HEATING`, `AC` |
77+
| `humidity` | Number:Dimensionless | Current relative inside humidity in percent | R | `HEATING`, `AC` |
78+
| `hvacMode` | String | Active mode, one of `OFF`, `HEAT`, `COOL`, `DRY`, `FAN`, `AUTO` | RW | `HEATING` and `DHW` support `OFF` and `HEAT`, `AC` can support more |
79+
| `targetTemperature` | Number:Temperature | Set point | RW | `HEATING`, `AC`, `DHW` |
80+
| `operationMode` | String | Operation mode the zone is currently in. One of `SCHEDULE` (follow smart schedule), `MANUAL` (override until ended manually), `TIMER` (override for a given time), `UNTIL_CHANGE` (active until next smart schedule block or until AWAY mode becomes active) | RW | `HEATING`, `AC`, `DHW` |
81+
| `overlayExpiry` | DateTime | End date and time of a timer | R | `HEATING`, `AC`, `DHW` |
82+
| `timerDuration` | Number | Timer duration in minutes | RW | `HEATING`, `AC`, `DHW` |
83+
| `heatingPower` | Number:Dimensionless | Amount of heating power currently present | R | `HEATING` |
84+
| `acPower` | Switch | Indicates if the Air-Conditioning is Off or On | R | `AC` |
85+
| `fanspeed`<sup>1)</sup> | String | Fan speed, one of `AUTO`, `LOW`, `MIDDLE`, `HIGH` | RW | `AC` |
86+
| `fanLevel`<sup>1)</sup> | String | Fan speed, one of <sup>3)</sup> `AUTO`, `SILENT`, `LEVEL1`, `LEVEL2`, `LEVEL3`, `LEVEL4`, `LEVEL5` | RW | `AC` |
87+
| `swing`<sup>2)</sup> | Switch | Swing on/off | RW | `AC` |
88+
| `verticalSwing`<sup>2)</sup> | String | Vertical swing state, one of <sup>3)</sup> `OFF`, `ON`, `UP`, `MID_UP`, `MID`, `MID_DOWN`, `DOWN`, `AUTO` | RW | `AC` |
89+
| `horizontalSwing`<sup>2)</sup> | String | Horizontal swing state, one of <sup>3)</sup> `OFF`, `ON`, `LEFT`, `MID_LEFT`, `MID`, `MID_RIGHT`, `RIGHT`, `AUTO` | RW | `AC` |
90+
| `batteryLowAlarm` | Switch | A control device in the Zone has a low battery | R | Any Zone |
91+
| `openWindowDetected` | Switch | An open window has been detected in the Zone | R | `HEATING`, `AC` |
92+
| `openWindowRemainingTime` | Number:Time | The remaining Open Window heating/cooling Override time in the Zone | R | `HEATING`, `AC` |
93+
| `light` | Switch | State (`ON`, `OFF`) of the control panel light | RW | `AC` |
9494

9595
You will see some of the above mentioned Channels only if your tado° device supports the respective function.
9696

@@ -138,10 +138,10 @@ In case the zone is currently in smart-schedule mode and thus doesn't have a ter
138138

139139
The `mobiledevice` thing represents a smart phone that is configured for tado°. It provides access to the geotracking functionality.
140140

141-
Parameter | Required | Description | Default
142-
-|-|-|-
143-
`id` | yes | Mobile Device Id | -
144-
`refreshInterval` | no | Refresh interval of state updates in seconds | 60
141+
| Parameter | Required | Description | Default |
142+
|-------------------|----------|----------------------------------------------|---------|
143+
| `id` | yes | Mobile Device Id | - |
144+
| `refreshInterval` | no | Refresh interval of state updates in seconds | 60 |
145145

146146
Mobile devices are part of discovery, but can also be configured manually.
147147
It is again easiest to refer to discovery in order to find the `id`.
@@ -156,15 +156,15 @@ Bridge tado:home:demo [ username="[email protected]", password="secret" ] {
156156

157157
### Items
158158

159-
Name | Type | Description | Read/Write
160-
-|-|-|-
161-
`atHome` | Switch | ON if mobile device is in HOME mode, OFF if AWAY | R
159+
| Name | Type | Description | Read/Write |
160+
|----------|--------|--------------------------------------------------|------------|
161+
| `atHome` | Switch | ON if mobile device is in HOME mode, OFF if AWAY | R |
162162

163163
Group `OR` can be used to define an item for _'is any device at home'_.
164164

165165
# Full Example
166166

167-
## tado.things
167+
## `tado.things` Example
168168

169169
```java
170170
Bridge tado:home:demo [ username="[email protected]", password="secret" ] {
@@ -176,10 +176,10 @@ Bridge tado:home:demo [ username="[email protected]", password="secret" ] {
176176
}
177177
```
178178

179-
## tado.items
179+
## `tado.items` Example
180180

181181
```java
182-
Switch TADO_PRESENCE_home "Tado Presence: [MAP(presence.map):%s]" { channel="tado:home:demo:homePresence" }
182+
Switch TADO_PRESENCE_home "Tado Presence: [MAP(presence.map):%s]" { channel="tado:home:demo:homePresence" }
183183
Number:Temperature HEAT_inside_temperature "Inside Temperature" { channel="tado:zone:demo:heating:currentTemperature" }
184184
Number HEAT_humidity "Humidity" { channel="tado:zone:demo:heating:humidity" }
185185
Number HEAT_heating_power "Heating Power" { channel="tado:zone:demo:heating:heatingPower" }
@@ -211,7 +211,7 @@ Switch Battery_Low_Alarm "Battery Low Alarm" { channe
211211
Switch Phone_atHome "Phone location [MAP(presence.map):%s]" { channel="tado:mobiledevice:demo:phone:atHome" }
212212
```
213213

214-
## tado.sitemap
214+
## `tado.sitemap` Example
215215

216216
```perl
217217
sitemap tado label="Tado"
@@ -263,7 +263,7 @@ sitemap tado label="Tado"
263263
}
264264
```
265265

266-
## presence.map
266+
## `presence.map` Example
267267

268268
```text
269269
ON=at home

0 commit comments

Comments
 (0)