Skip to content

Commit aaa50f2

Browse files
lsiepellsiepel
authored
Merge branch 'openhab:main' into worlfown-markdownlinter
2 parents 071bbb6 + 45709e0 commit aaa50f2

22 files changed

Lines changed: 150 additions & 114 deletions

File tree

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ If you plan things mainly for user interaction the "Schema API Page" might be be
4545

4646
## Discovery
4747

48-
Autodiscovering is not supported.
48+
Autodiscovering is not supported.
4949
You have to define the things manually.
5050

5151
## Schema API
@@ -223,7 +223,7 @@ The known measure types are:
223223
| 14 | el. Current | mA | |
224224
| 15 | Time | hours | |
225225
| 16 | dimensionless | [none] | use for multiplexers, etc |
226-
| 17.. | repeating again from 1, e.g 17==1, 18==2, ... |
226+
| 17.. | repeating | again | from 1, e.g 17==1, 18==2, ... |
227227

228228
## Full Example (CoE/Schema API)
229229

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The following Tapo-Devices are supported. For precise channel-description look a
2525
| Smart Temperature Sensor (RF) | T310 | Temperature and Humidity Sensor |
2626
| | T315 | Temperature and Humidity Sensor with Display |
2727
| Smart Switch (RF) | S210 | Wall switch with 1 contact |
28-
| Smart Switch (RF) | S220 | Wall switch with 2 contacts |
28+
| Smart Switch (RF) | S220 | Wall switch with 2 contacts |
2929

3030
## Prerequisites
3131

@@ -40,15 +40,15 @@ To satisfy this requirement while keeping the device isolated, your router shoul
4040

4141
For Wi-Fi-Devices, discovery is done by connecting to the Tapo-Cloud-Service or use local udp-discovery.
4242
If enabled, all devices stored in your cloud account will be detected even if they are not in your local network.
43-
From cloud you can get more informations such as "Device-Alias" as from udp-discovery.
43+
From cloud you can get more information such as "Device-Alias" as from udp-discovery.
4444
But you need to know the IP-Adress of your device. This must be set manually in the thing configuration.
4545

46-
UDP-Discovery can find only devices which are online in your local network and get less informations as from cloud.
47-
But therefore it set's device-ip and protocol automaticly.
46+
UDP-Discovery can find only devices which are online in your local network and get less information as from the cloud.
47+
But therefore it set's device-ip and protocol automatically.
4848
If you have problems with udp-discovery, try to set the advanced setting 'broadcastAddress' to your local subnet ('e.g. 192.168.0.255').
4949
Default is '255.255.255.255'
5050

51-
You can combine both discovery methods to get any informations from local devices.
51+
You can combine both discovery methods to get any information from local devices.
5252
If you enable setting 'onlyLocalOnlineDevices' results will only generated for local online devices but with the combined data of cloud discovery.
5353
RF-Devices will be discovered by the hub they are connected to.
5454
You can discover them manually or use ´backgroundDiscovery´
@@ -68,7 +68,7 @@ The thing has the following configuration parameters:
6868
| password | Password of your Tapo-Cloud |
6969
| cloudDiscovery | Use Cloud Discovery-Service to get all in Tapo-App registered devices. Includes DeviceName. IP-Address and Encryption has to set manually |
7070
| udpDiscovery | Use UDP Discovery-Service to discover online devices in the local network. Includes Encryption and IP-Address. Results will be merged with cloud discovery |
71-
| onlyLocalOnlineDevices | [advanced] Uses Cloud and UPD-Discovery to get more informations but will only discover online devices via UDP |
71+
| onlyLocalOnlineDevices | [advanced] Uses Cloud and UPD-Discovery to get more information but will only discover online devices via UDP |
7272
| broadcastAddress | [advanced] Set broadcast address to your local subnet if you have problems with default address |
7373
| discoveryInterval | [advanced] Interval in minutes when a background device scan should be executed. Default is 60 |
7474

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ All of these 433 MHz devices is one-way, so some versions of the Tellstick monit
88

99
The latest versions have also implemented Z-Wave as transmission protocol which open up for more robust transmission due two-ways communication.
1010

11-
![](doc/tellstick_duo.jpg)
11+
![Tellstick Duo device](doc/tellstick_duo.jpg)
1212

13-
![](doc/znet.jpeg)
13+
![Tellstick ZNet device](doc/znet.jpeg)
1414

1515
## Supported Things
1616

@@ -87,7 +87,7 @@ Bridge tellstick:telldus-core:1 "Tellstick Duo" [resendInterval=200,libraryPath=
8787

8888
Optional:
8989

90-
- **libraryPath:** The path to tellduscore.dll/so semicolon seperated list of folders.
90+
- **libraryPath:** The path to tellduscore.dll/so semicolon separated list of folders.
9191
- **resendInterval:** The interval between each transmission of command in ms, default 100ms.
9292

9393
#### Telldus Live Bridge

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ The binding does not support auto discovery.
1919
| password | N/A | Yes | No | the password of the local account on the Powerwall that the installer provided |
2020
| refresh | 10 | No | Yes | The frequency with which to refresh information from the Powerwall (in seconds) |
2121

22-
2322
## Channels
2423

2524
| channel id | type | description |

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Teslascope Binding
22

3-
This binding integrates [Tesla Electrical Vehicles](https://www.tesla.com).
3+
This binding integrates [Tesla Electric Vehicles](https://www.tesla.com).
44
The integration happens through the [Teslascope](https://www.teslascope.com) API.
55

66
## Supported Things
@@ -14,11 +14,12 @@ After (manually) adding a Teslascope Account bridge, registered vehicles will be
1414

1515
## `account` Bridge Configuration
1616

17-
Account configuration is necessary.
18-
The easiest way to do this is from the UI.
17+
Account configuration is necessary.
18+
The easiest way to do this is from the UI.
1919
Just add a new thing, select the Teslascope binding, then Teslascope Account Binding Thing, and enter the apiKey from the Teslascope website.
2020

2121
As a minimum, the apiKey is needed:
22+
2223
| Thing Parameter | Default Value | Required | Advanced | Description |
2324
|-----------------|---------------|----------|----------|--------------------------------------------------------------------------------------|
2425
| apiKey | N/A | Yes | No | apiKey provided by Teslascope |
@@ -27,6 +28,7 @@ As a minimum, the apiKey is needed:
2728
## `vehicle` Thing Configuration
2829

2930
As a minimum, the publicID is needed:
31+
3032
| Thing Parameter | Default Value | Required | Advanced | Description |
3133
|-----------------|---------------|----------|----------|--------------------------------------------------------------------------------------|
3234
| publicID | N/A | Yes | No | Vehicle Public ID listed in Teslascope |
@@ -41,7 +43,7 @@ All vehicles support a huge number of channels - the following list shows the st
4143
| auto-conditioning | Switch | Auto Conditioning | Turns on auto-conditioning (a/c or heating) |
4244
| battery-level | Number:Dimensionless | Battery Level | State of the battery in % |
4345
| charging-state | String | Charging State | “Starting”, “Complete”, “Charging”, “Disconnected”, “Stopped”, “NoPower” |
44-
| charge-port | Switch | Charge Port | Open the Charge Port (ON) or indicates the state of the Charge Port (ON/OFF if Open/Closed) |
46+
| charge-port | Switch | Charge Port | Open the Charge Port (ON) or indicates the state of the Charge Port (ON/OFF if Open/Closed) |
4547
| climate | Switch | Climate | Climate status indicator |
4648
| door-lock | Switch | Door Lock | Lock or unlock the car |
4749
| inside-temp | Number:Temperature | Inside Temperature | Indicates the inside temperature of the vehicle |
@@ -65,7 +67,7 @@ Additionally, these advanced channels are available (not all are available on al
6567
| charge | Switch | Charge | Start (ON) or stop (OFF) charging |
6668
| charge-amps | Number:ElectricCurrent | Charger Current | Current actually delivered by the charger |
6769
| charge-current-request | Number:ElectricCurrent | Charger Current Requested | Current requested from the charger |
68-
| charge-current-request-max | Number:ElectricCurrent | Max Charger Current Supported | Maximuum current supported by the charger |
70+
| charge-current-request-max | Number:ElectricCurrent | Max Charger Current Supported | Maximum current supported by the charger |
6971
| charge-energy-added | Number:Energy | Charge Energy Added | Energy added, in kWh, during the last charging session |
7072
| charge-limit-soc | Number:Dimensionless | Charge Limit SOC | Current charging limit of the vehicle, in % |
7173
| charge-limit-soc-min | Number:Dimensionless | Charge Limit SOC Min | Minimum charging limit of the vehicle, in % |
@@ -128,7 +130,7 @@ Additionally, these advanced channels are available (not all are available on al
128130
| tpms-soft-warning-rr | Switch | Tyre Pressure Soft Warning RR | Tyre Pressure Soft Warning Rear Right |
129131
| usable-battery-level | Number | Usable Battery Level | Indicates the % of battery that can be used for vehicle functions like driving |
130132
| valet-mode | Switch | Valet Mode | Enable or disable Valet Mode |
131-
| wiper-blade-heater | Switch | Wiperblade Heater | Indicates if the wiperblade heater is switched on |
133+
| wiper-blade-heater | Switch | Wiper Blade Heater | Indicates if the wiper blade heater is switched on |
132134

133135
## Full Example
134136

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

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@
33
The Tibber Binding retrieves `prices` from [Tibber API](https://developer.tibber.com).
44
Users equipped with Tibber Pulse hardware can connect in addition to [live group](#live-group) and [statistics group](#statistics-group).
55

6-
76
## Supported Things
87

9-
| Type | ID | Description |
8+
| Type | ID | Description |
109
|-----------|-----------|---------------------------|
1110
| Thing | tibberapi | Connection to Tibber API |
1211

@@ -96,7 +95,7 @@ All values read-only.
9695

9796
### `statistics` group
9897

99-
Statistic information about total, daily and last hour energy consumption and production.
98+
Statistic information about total, daily and last hour energy consumption and production.
10099
All values read-only.
101100

102101
| Channel ID | Type | Description |
@@ -111,27 +110,27 @@ All values read-only.
111110

112111
## Thing Actions
113112

114-
Thing actions can be used to perform calculations on the current available price information cached by the binding.
113+
Thing actions can be used to perform calculations on the current available price information cached by the binding.
115114
Cache contains energy prices from today and after reaching the `updateHour` also for tomorrow.
116-
This is for planning when and for what cost a specific electric consumer can be started.
115+
This is for planning when and for what cost a specific electric consumer can be started.
117116

118117
Performing a calcuation a `parameters` object is needed containing e.g. your boundaries for the calculation.
119118
Parameter object allow 2 types: Java `Map` or JSON `String`.
120119
The result is returned as JSON encoded `String`.
121120
Refer below sections how the result looks like.
122121
If the action cannot be performed, a warning will be logged and an empty `String` will be returned.
123-
Some real life scenarios are schown in [Action Examples](#action-examples) section.
122+
Some real life scenarios are schown in [Thing Actions](#thing-actions) section.
124123

125124
### `priceInfoStart`
126125

127-
Returns starting point as `Instant` of first available energy price.
126+
Returns starting point as `Instant` of first available energy price.
128127
It's not allowed to start calculations before this timestamp.
129128

130129
In case of error `Instant.MAX` is returned.
131130

132131
### `priceInfoEnd`
133132

134-
Returns end point as `Instant` of the last available energy price.
133+
Returns end point as `Instant` of the last available energy price.
135134
It's not allowed to exceed calculations after this timestamp.
136135

137136
In case of error `Instant.MIN` is returned.
@@ -173,9 +172,9 @@ then
173172
end
174173
```
175174

176-
**Console output**
175+
## Console output
177176

178-
```
177+
```text
179178
2025-05-29 15:52:31.345 [INFO ] [ab.core.model.script.TibberPriceList] - PriceInfo 0 : 0.1829 Starts at : 2025-05-30T13:00+02:00[Europe/Berlin]
180179
2025-05-29 15:52:31.349 [INFO ] [ab.core.model.script.TibberPriceList] - PriceInfo 1 : 0.183 Starts at : 2025-05-30T14:00+02:00[Europe/Berlin]
181180
2025-05-29 15:52:31.352 [INFO ] [ab.core.model.script.TibberPriceList] - PriceInfo 2 : 0.1842 Starts at : 2025-05-29T15:52:31.341193101+02:00[Europe/Berlin]
@@ -185,15 +184,15 @@ end
185184
### Result
186185

187186
JSON encoded `String` result with keys
188-
189-
| Key | Type | Description |
187+
188+
| Key | Type | Description |
190189
|---------------|-----------|---------------------------------------|
191190
| size | int | Size of price list |
192191
| priceList | JsonArray | Array of `priceInfo` entries |
193192

194193
JSON Object `priceInfo`
195194

196-
| Key | Type | Description |
195+
| Key | Type | Description |
197196
|---------------|-----------|---------------------------------------|
198197
| startsAt | String | String encoded Instant |
199198
| duration | int | Price duration in seconds |
@@ -248,14 +247,14 @@ For use cases like dishwasher or laundry.
248247
| duration | String | Duration as String with units `h`,`m` or `s` | N/A | true |
249248
| curve | JsonArray | Array with `curveEntry` elements | N/A | no |
250249

251-
Provide either
250+
Provide either
252251

253252
- `power` and `duration` for constant consumption _or_
254253
- `curve` for sophisticated use cases like a recorded laundry power timeseries
255254

256255
JSON Object `curveEntry`
257256

258-
| Key | Type | Description |
257+
| Key | Type | Description |
259258
|---------------|-----------|---------------------------------------|
260259
| timestamp | String | String encoded Instant |
261260
| power | int | Power in watts |
@@ -298,7 +297,7 @@ end
298297

299298
Console output:
300299

301-
```
300+
```text
302301
2025-05-29 16:07:40.858 [TRACE] [.internal.calculator.PriceCalculator] - Calculation time 2 ms for 1819 iterations
303302
2025-05-29 16:07:40.860 [INFO ] [ab.core.model.script.TibberBestPrice] - {"cheapestStart":"2025-05-30T11:00:40.856950656Z","mostExpensiveStart":"2025-05-30T18:25:40.856950656Z"}
304303
2025-05-29 16:07:40.861 [TRACE] [.internal.calculator.PriceCalculator] - Calculation time 0 ms for 26 iterations
@@ -309,16 +308,16 @@ Console output:
309308
#### Result
310309

311310
JSON encoded `String` result with keys
312-
313-
| Key | Type | Description |
311+
312+
| Key | Type | Description |
314313
|-----------------------|-----------|---------------------------------------|
315314
| cheapestStart | String | Timestamp of cheapest start |
316315
| lowestPrice | double | Price of the cheapest period |
317316
| mostExpensiveStart | String | Timestamp of most expensive start |
318317
| highestPrice | double | Price of the most expensive period |
319318
| averagePrice | double | Average price within the period |
320319

321-
#### Example
320+
#### Result Example
322321

323322
```json
324323
{
@@ -374,7 +373,7 @@ end
374373

375374
Console output
376375

377-
```
376+
```text
378377
2025-05-29 19:42:38.223 [INFO ] [hab.core.model.script.TibberSchedule] - {"cost":17.004625,"size":2,"schedule":[{"start":"2025-05-30T08:00:00Z","stop":"2025-05-30T16:00:00Z","duration":28800,"cost":16.407600000000002},{"start":"2025-05-29T23:00:00Z","stop":"2025-05-29T23:15:00Z","duration":900,"cost":0.5970249999999999}]}
379378
2025-05-29 19:42:38.225 [INFO ] [hab.core.model.script.TibberSchedule] - Cost : 17.004625 Number of schedules : 2
380379
2025-05-29 19:42:38.227 [INFO ] [hab.core.model.script.TibberSchedule] - Schedule 0: {start=2025-05-30T08:00:00Z, stop=2025-05-30T16:00:00Z, duration=28800, cost=16.407600000000002}
@@ -386,26 +385,26 @@ Console output
386385
#### Result
387386

388387
JSON encoded `String` result with keys
389-
390-
| Key | Type | Description |
388+
389+
| Key | Type | Description |
391390
|---------------|-----------|---------------------------------------|
392391
| size | int | Number of schedules |
393392
| schedule | JsonArray | Array of `scheduleEntry` elements |
394393

395394
JSON Object `scheduleEntry`
396395

397-
| Key | Type | Description |
396+
| Key | Type | Description |
398397
|---------------|-----------|---------------------------------------|
399398
| timestamp | String | String encoded Instant |
400399
| duration | int | Price duration in seconds |
401400
| price | double | Price in your currency |
402401

403-
Provide either
402+
Provide either
404403

405404
- `timestamp` - duration will be calculated automatically _or_
406405
- `duration` if you already know it
407406

408-
#### Example
407+
#### Result Example
409408

410409
```json
411410
{

0 commit comments

Comments
 (0)