OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated external content (Jenkins build 1232)

pull/1969/head
openHAB Build Server 2022-12-02 05:36:31 +00:00
parent a365af7d15
commit 53c06ce9a1
13 changed files with 60 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.vuepress/thing-types.json
View File

File diff suppressed because one or more lines are too long

2
_addons_bindings/ahawastecollection/readme.md
View File

@ -86,7 +86,7 @@ DateTime collectionDay_paper "Next paper collection" {channel="ahawastecollectio
```
Example for rule that sends an notification with collected waste types on day before collection
Example for rule that sends a notification with collected waste types on day before collection
```
triggers:

2
_addons_bindings/amazonechocontrol/readme.md
View File

@ -614,7 +614,7 @@ then
end
```
## Playing an alarm sound for 15 seconds with an openHAB rule if an door contact was opened:
## Playing an alarm sound for 15 seconds with an openHAB rule if a door contact was opened:
1) Do get the ID of your sound, follow the steps in "How To Get IDs"
2) Write down the text in the square brackets. e.g. ECHO:system_alerts_repetitive01 for the nightstand sound

2
_addons_bindings/bluetooth.bluegiga/readme.md
View File

@ -37,7 +37,7 @@ Additionally, the parameter `backgroundDiscovery` can be set to true/false. When
## Example
This is how an BlueGiga adapter can be configured textually in a *.things file:
This is how a BlueGiga adapter can be configured textually in a *.things file:
```
Bridge bluetooth:bluegiga:1 [ port="/dev/ttyS0", backgroundDiscovery=false ]

2
_addons_bindings/bluetooth.bluez/readme.md
View File

@ -72,7 +72,7 @@ Additionally, the parameter `backgroundDiscovery` can be set to true/false.When
## Example
This is how an BlueZ adapter can be configured textually in a *.things file:
This is how a BlueZ adapter can be configured textually in a *.things file:
```
Bridge bluetooth:bluez:hci0 [ address="12:34:56:78:90:AB", backgroundDiscovery=false ]

2
_addons_bindings/bluetooth.roaming/readme.md
View File

@ -49,7 +49,7 @@ The `backgroundDiscovery` parameter is true by default.
## Example
This is how an Roaming adapter can be configured textually in a *.things file:
This is how a Roaming adapter can be configured textually in a *.things file:
```
Bridge bluetooth:roaming:ctrl "BLE Roaming Adapter" [ backgroundDiscovery=true]

2
_addons_bindings/exec/readme.md
View File

@ -105,7 +105,7 @@ DateTime APCLastExecution {channel="exec:command:apc:lastexecution"}
## Full Example
Following is an example how to set up an exec command thing, pass it a parameter, debug it with a rule and set the returned string to an Number Item.
Following is an example how to set up an exec command thing, pass it a parameter, debug it with a rule and set the returned string to a Number Item.
**demo.things**

34
_addons_bindings/tplinksmarthome/readme.md
View File

@ -322,6 +322,12 @@ Switching, Brightness and Color is done using the `color` channel.
* LED On/Off
* Wi-Fi signal strength (RSSI)
### KP401 Kasa Smart WiFi Outdoor Plug
* Power On/Off
* LED On/Off
* Wi-Fi signal strength (RSSI)
### KP405 Kasa Smart Wi-Fi Outdoor Plug-In Dimmer
* Power On/Off
@ -392,19 +398,19 @@ Either `deviceId` or `ipAddress` must be set.
All devices support some of the following channels:
| Channel Type ID | Item Type | Description | Thing types supporting this channel |
|---------------------|--------------------------|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| switch | Switch | Power the device on or off. | EP10, EP40, HS100, HS103, HS105, HS107, HS110, HS200, HS210, HS300, KP100, KP105, KP115, KP200, KP303, KP400, KS230, RE270K, RE370K |
| brightness | Dimmer | Set the brightness of device or dimmer. | ES20M, HS220, KB100, KL50, KL60, KL110, KL120, KP405, LB100, LB110, LB120, LB200 |
| colorTemperature | Dimmer | Set the color temperature in percentage. | KB130, KL120, KL125, KL130, KL135, KL400, KL430, LB120, LB130, LB230 |
| colorTemperatureAbs | Number | Set the color temperature in Kelvin. | KB130, KL120, KL125, KL130, KL135, KL400, KL430, LB120, LB130, LB230 |
| color | Color | Set the color of the light. | KB130, KL125, KL130, KL135, KL400, KL430, LB130, LB230 |
| power | Number:Power | Actual energy usage in Watt. | HS110, HS300, KLxxx, KP115, KP125, LBxxx, |
| eneryUsage | Number:Energy | Energy Usage in kWh. | HS110, HS300, KP115, KP125 |
| current | Number:ElectricCurrent | Actual current usage in Ampere. | HS110, HS300, KP115, KP125 |
| voltage | Number:ElectricPotential | Actual voltage usage in Volt. | HS110, HS300, KP115, KP125 |
| led | Switch | Switch the status LED on the device on or off. | ES20M, EP10, EP40, HS100, HS103, HS105, HS107, HS110, HS200, HS210, HS220, HS300, KP100, KP105, KP115, KP125, KP303, KP200, KP400, KP405, KS230 |
| rssi | Number:Power | Wi-Fi signal strength indicator in dBm. | All |
| Channel Type ID | Item Type | Description | Thing types supporting this channel |
|---------------------|--------------------------|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| switch | Switch | Power the device on or off. | EP10, EP40, HS100, HS103, HS105, HS107, HS110, HS200, HS210, HS300, KP100, KP105, KP115, KP200, KP303, KP400, KP401, KS230, RE270K, RE370K |
| brightness | Dimmer | Set the brightness of device or dimmer. | ES20M, HS220, KB100, KL50, KL60, KL110, KL120, KP405, LB100, LB110, LB120, LB200 |
| colorTemperature | Dimmer | Set the color temperature in percentage. | KB130, KL120, KL125, KL130, KL135, KL400, KL430, LB120, LB130, LB230 |
| colorTemperatureAbs | Number | Set the color temperature in Kelvin. | KB130, KL120, KL125, KL130, KL135, KL400, KL430, LB120, LB130, LB230 |
| color | Color | Set the color of the light. | KB130, KL125, KL130, KL135, KL400, KL430, LB130, LB230 |
| power | Number:Power | Actual energy usage in Watt. | HS110, HS300, KLxxx, KP115, KP125, LBxxx, |
| eneryUsage | Number:Energy | Energy Usage in kWh. | HS110, HS300, KP115, KP125 |
| current | Number:ElectricCurrent | Actual current usage in Ampere. | HS110, HS300, KP115, KP125 |
| voltage | Number:ElectricPotential | Actual voltage usage in Volt. | HS110, HS300, KP115, KP125 |
| led | Switch | Switch the status LED on the device on or off. | ES20M, EP10, EP40, HS100, HS103, HS105, HS107, HS110, HS200, HS210, HS220, HS300, KP100, KP105, KP115, KP125, KP303, KP200, KP400, KP401, KP405, KS230 |
| rssi | Number:Power | Wi-Fi signal strength indicator in dBm. | All |
The outlet devices (EP40, HS107, HS300, KP200, KP400) have group channels.
This means the channel is prefixed with the group id.
@ -433,6 +439,7 @@ tplinksmarthome:hs100:tv "TV" [ deviceId="00000000000000000
tplinksmarthome:hs300:laptop "Laptop" [ deviceId="00000000000000000000000000000004", refresh=60 ]
tplinksmarthome:lb110:bulb1 "Living Room Bulb 1" [ deviceId="00000000000000000000000000000002", refresh=60, transitionPeriod=2500 ]
tplinksmarthome:lb130:bulb2 "Living Room Bulb 2" [ deviceId="00000000000000000000000000000003", refresh=60, transitionPeriod=2500 ]
tplinksmarthome:kp401:outlet "Outdoor Outlet" [ ipAddress="192.168.1.101" ]
```
### tplinksmarthome.items:
@ -445,4 +452,5 @@ Dimmer TP_LB_Bulb "Dimmer [%d %%]" <slider> { channel="tplink
Dimmer TP_LB_ColorT "Color Temperature [%d %%]" <slider> { channel="tplinksmarthome:lb130:bulb2:colorTemperature" }
Color TP_LB_Color "Color" <slider> { channel="tplinksmarthome:lb130:bulb2:color" }
Switch TP_LB_ColorS "Switch" { channel="tplinksmarthome:lb130:bulb2:color" }
Switch TP_O_OUTLET "Outdoor Outlet" { channel="tplinksmarthome:kp401:outlet:switch" }
```

9
_addons_bindings/wundergroundupdatereceiver/readme.md
View File

@ -20,7 +20,7 @@ This binding enables acting as a receiver of updates from devices that post meas
If the hostname is configurable - as on weather stations based on the Fine Offset Electronics WH2600-IP - this is simple, otherwise you have to set up dns such that it resolves the above hostname to your server, without preventing the server from resolving the proper ip if you want to forward the request.
The server thus listens at http(s)://<your-openHAB-server>:<openHAB-port>/weatherstation/updateweatherstation.php and the device needs to be pointed at this address.
If you can't configure the device itself to submit to an alternate hostname you would need to set up a dns server that resolves rtupdate.wunderground.com to the IP-address of your server and provide as dns to the device does DHCP.
If you can't configure the device itself to submit to an alternate hostname you would need to set up a dns server that resolves rtupdate.wunderground.com to the IP-address of your server and provide it as the DHCP dns-server to the device.
Make sure not to use this dns server instance for any other DHCP clients.
The request is in itself simple to parse, so by redirecting it to your openHAB server you can intercept the values and use them to control items in your home.
@ -33,6 +33,7 @@ It can also be used to submit the same measurements to multiple weather services
## Supported Things
Any device that sends weather measurement updates to the wunderground.com update URLs is supported.
Multiple devices submitting to the same wunderground account ID can be aggregated.
It is easiest to use with devices that have a configurable target address, but can be made to work with any internet-connected device, that gets its dns server via DHCP or where the DNS server can be set.
## Discovery
@ -56,7 +57,9 @@ If you don't plan on submitting measurements to wunderground.com, it can be any
Each measurement type the wunderground.com update service accepts has a channel.
The channels must be named exactly as the request parameter they receive.
I.e. the wind speed channel must be named `windspeedmph` as that is the request parameter name defined by Wunderground in their API.
The channel name set up in the binding should be considered an id with no semantic content other than pointing to the wounderground API.
Illegal channel id characters are converted to -.
For example, AqPM2.5 has a channel named `AqPM2-5`.
The channel name set up in the binding should be considered an id with no semantic content other than pointing to the wunderground API.
Additionally there is a receipt timestamp and a trigger channel.
### Request parameters are mapped to one of the following channel-types:
@ -191,7 +194,7 @@ The binding tries to post received values as the item types described in the cha
### Rule examples
You can use the trigger channel to create a rule to calculate additional values.
Create an new manual Item with a meaningful id, fx. WundergroundUpdateReceiverBinging_HeatIndex with a Number type.
Create a new manual Item with a meaningful id, fx. WundergroundUpdateReceiverBinging_HeatIndex with a Number type.
Create a rule that triggers when the trigger channel is updated and the following DSL:
```

4
_addons_persistences/jdbc/readme.md
View File

@ -29,9 +29,9 @@ The following databases are currently supported and tested:
| [HSQLDB](http://hsqldb.org/) | [hsqldb-2.3.3.jar](https://mvnrepository.com/artifact/org.hsqldb/hsqldb) |
| [MariaDB](https://mariadb.org/) | [mariadb-java-client-3.0.8.jar](https://mvnrepository.com/artifact/org.mariadb.jdbc/mariadb-java-client) |
| [MySQL](https://www.mysql.com/) | [mysql-connector-java-8.0.30.jar](https://mvnrepository.com/artifact/mysql/mysql-connector-java) |
| [PostgreSQL](https://www.postgresql.org/) | [postgresql-42.4.1.jar](https://mvnrepository.com/artifact/org.postgresql/postgresql) |
| [PostgreSQL](https://www.postgresql.org/) | [postgresql-42.4.3.jar](https://mvnrepository.com/artifact/org.postgresql/postgresql) |
| [SQLite](https://www.sqlite.org/) | [sqlite-jdbc-3.16.1.jar](https://mvnrepository.com/artifact/org.xerial/sqlite-jdbc) |
| [TimescaleDB](https://www.timescale.com/) | [postgresql-42.4.1.jar](https://mvnrepository.com/artifact/org.postgresql/postgresql) |
| [TimescaleDB](https://www.timescale.com/) | [postgresql-42.4.3.jar](https://mvnrepository.com/artifact/org.postgresql/postgresql) |
## Table of Contents

2
_addons_transformations/jinja/readme.md
View File

@ -49,7 +49,7 @@ extracts the string `4.7`.
#### Outgoing data
The JINJA transformation can be used to publish simple JSON strings through, for example, the HTTP Binding's `commandTransformation` parameter.
Say we have an String Item which holds the following value:
Say we have a String Item which holds the following value:
```
This is my string

2
_thing_types/org.openhab.binding.ahawastecollection/src/main/resources/OH-INF/thing/thing-types.xml
View File

@ -41,7 +41,7 @@
</config-description>
</thing-type>
<!-- Channel type that represents the collection time of an waste type. -->
<!-- Channel type that represents the collection time of a waste type. -->
<channel-type id="collectionDateGeneralWaste">
<item-type>DateTime</item-type>
<label>General Waste</label>

22
_thing_types/org.openhab.binding.tplinksmarthome/src/main/resources/OH-INF/thing/KP401.xml Normal file
View File

@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="tplinksmarthome"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<thing-type id="kp401">
<label>KP401</label>
<description>TP-Link KP401 Kasa Smart WiFi Outdoor Plug</description>
<category>PowerOutlet</category>
<channels>
<channel id="switch" typeId="system.power"/>
<channel id="led" typeId="led"/>
<channel id="rssi" typeId="rssi"/>
</channels>
<representation-property>deviceId</representation-property>
<config-description-ref uri="thing-type:tplinksmarthome:device-plug"/>
</thing-type>
</thing:thing-descriptions>