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 125)

pull/1325/head
openHAB Build Server 2020-12-13 18:47:15 +00:00
parent 386c1b3aff
commit 670544f71d
12 changed files with 41 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
_addons_bindings/deconz/readme.md
View File

@ -103,6 +103,10 @@ The transition time is the time to move between two states and is configured in
The resolution provided is 1/10s.
If no value is provided, the default value of the device is used.
`extendedcolorlight` and `colorlight` have different modes for setting the color.
Some devices accept only XY, others HSB, others both modes and the binding tries to autodetect the correct mode.
If this fails, the advanced `colormode` parameter can be set to `xy` or `hs`.
### Textual Thing Configuration - Retrieving an API Key
If you use the textual configuration, the thing file without an API key will look like this, for example:

2
_addons_bindings/digitalstrom/readme.md
View File

@ -94,7 +94,7 @@ The discovery also will discover all called scenes, if they aren't automatically
Temperature control scenes, like *eco* will be ignored, so they cannot be discovered.
If you only want to discover one of the thing types, you can start a discovery scan on the thing type you want to have discovered.
You can use the command line command, e.g.: ``smarthome:discovery start digitalstrom:namedScene`` to start the scan.
You can use the command line command, e.g.: ``openhab:discovery start digitalstrom:namedScene`` to start the scan.
Which thing types this binding supports, please have a look at **Supported Things**.
## Thing Configuration and Properties

12
_addons_bindings/gardena/readme.md
View File

@ -110,16 +110,16 @@ Number WC_Valve_cmd_Duration "Command Duration [%d min]" { channel=
Switch WC_Valve_cmd_OpenWithDuration "Watering Timer [%d min]" { channel="gardena:water_control:home:myWateringComputer:valve_commands#start_seconds_to_override" }
Switch WC_Valve_cmd_CloseValve "Stop Switch" { channel="gardena:water_control:home:myWateringComputer:valve_commands#stop_until_next_task" }
smarthome:status WC_Valve_Duration // returns the duration of the last watering request if still active, or 0
smarthome:status WC_Valve_Activity // returns the current valve activity (CLOSED|MANUAL_WATERING|SCHEDULED_WATERING)
openhab:status WC_Valve_Duration // returns the duration of the last watering request if still active, or 0
openhab:status WC_Valve_Activity // returns the current valve activity (CLOSED|MANUAL_WATERING|SCHEDULED_WATERING)
```
All channels are read-only, except the command group and the lastUpdate timestamp
```
smarthome:send WC_Valve_cmd_Duration.sendCommand(10) // set the duration for the command to 10min
smarthome:send WC_Valve_cmd_OpenWithDuration.sendCommand(ON) // start watering
smarthome:send WC_Valve_cmd_CloseValve.sendCommand(ON) // stop any active watering
openhab:send WC_Valve_cmd_Duration.sendCommand(10) // set the duration for the command to 10min
openhab:send WC_Valve_cmd_OpenWithDuration.sendCommand(ON) // start watering
openhab:send WC_Valve_cmd_CloseValve.sendCommand(ON) // stop any active watering
```
If you send a REFRESH command to the last update timestamp (no matter which thing), **ALL** items from **ALL** things are updated
@ -127,7 +127,7 @@ If you send a REFRESH command to the last update timestamp (no matter which thin
DateTime LastUpdate "LastUpdate [%1$td.%1$tm.%1$tY %1$tH:%1$tM]" { channel="gardena:water_control:home:myWateringComputer:common#lastUpdate_timestamp" }
// refresh ALL items
smarthome:send LastUpdate REFRESH
openhab:send LastUpdate REFRESH
```
### Debugging and Tracing

4
_addons_bindings/homematic/readme.md
View File

@ -536,7 +536,7 @@ Display_CombinedParam.sendCommand("{DDBC=WHITE,DDTC=BLACK,DDI=0,DDA=CENTER,DDS=J
If you want to use the combined parameter in the console, you have to use ' instead of ", to prevent evaluation of curly braces:
```shell
smarthome:send Display_CombinedParam '{DDBC=WHITE,DDTC=BLACK,DDI=0,DDA=CENTER,DDS=Just a test,DDID=3,DDC=true}'
openhab:send Display_CombinedParam '{DDBC=WHITE,DDTC=BLACK,DDI=0,DDA=CENTER,DDS=Just a test,DDID=3,DDC=true}'
```
**Key translation:**
@ -677,7 +677,7 @@ E.g you have an item linked to a variable with the name `Var_1`.
In the console:
```shell
smarthome:send Var_1 REFRESH
openhab:send Var_1 REFRESH
```
In scripts:

25
_addons_bindings/insteon/readme.md
View File

@ -257,22 +257,23 @@ Dimmer dimmer { channel="insteon:device:home:238D93:dimmer" }
## Console Commands
The binding provides commands you can use to help with troubleshooting.
Enter `smarthome:insteon` in the console and you will get a list of available commands.
Enter `openhab:insteon` or `insteon` in the console and you will get a list of available commands.
The `openhab:` prefix is optional:
```
openhab> smarthome:insteon
Usage: smarthome:insteon display_devices - display devices that are online, along with available channels
Usage: smarthome:insteon display_channels - display channels that are linked, along with configuration information
Usage: smarthome:insteon display_local_database - display Insteon PLM or hub database details
Usage: smarthome:insteon display_monitored - display monitored device(s)
Usage: smarthome:insteon start_monitoring all|address - start displaying messages received from device(s)
Usage: smarthome:insteon stop_monitoring all|address - stop displaying messages received from device(s)
Usage: smarthome:insteon send_standard_message address flags cmd1 cmd2 - send standard message to a device
Usage: smarthome:insteon send_extended_message address flags cmd1 cmd2 [up to 13 bytes] - send extended message to a device
Usage: smarthome:insteon send_extended_message_2 address flags cmd1 cmd2 [up to 12 bytes] - send extended message with a two byte crc to a device
openhab> openhab:insteon
Usage: openhab:insteon display_devices - display devices that are online, along with available channels
Usage: openhab:insteon display_channels - display channels that are linked, along with configuration information
Usage: openhab:insteon display_local_database - display Insteon PLM or hub database details
Usage: openhab:insteon display_monitored - display monitored device(s)
Usage: openhab:insteon start_monitoring all|address - start displaying messages received from device(s)
Usage: openhab:insteon stop_monitoring all|address - stop displaying messages received from device(s)
Usage: openhab:insteon send_standard_message address flags cmd1 cmd2 - send standard message to a device
Usage: openhab:insteon send_extended_message address flags cmd1 cmd2 [up to 13 bytes] - send extended message to a device
Usage: openhab:insteon send_extended_message_2 address flags cmd1 cmd2 [up to 12 bytes] - send extended message with a two byte crc to a device
```
Here is an example of command: `smarthome:insteon display_local_database`.
Here is an example of command: `insteon display_local_database`.
When monitoring devices, the output will be displayed where openHAB was started.
You may need to redirect the output to a log file to see the messages.

2
_addons_bindings/magentatv/readme.md
View File

@ -99,7 +99,7 @@ There are different ways to setup the User ID:
Run the following command on the console and provide your Telekom account credentials:
```
openhab> smarthome:magentatv login
openhab> openhab:magentatv login
Username (email): mail@example.com
Password: topsecret

2
_addons_bindings/miio/readme.md
View File

@ -462,7 +462,7 @@ All devices have available the following channels (marked as advanced) besides t
| actions#rpc | String | send commands via cloud. see below |
note: the ADVANCED `actions#commands` and `actions#rpc` channels can be used to send commands that are not automated via the binding. This is available for all devices
e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would enable a pre-configured timer. See https://github.com/marcelrv/XiaomiRobotVacuumProtocol for all known available commands.
e.g. `openhab:send actionCommand 'upd_timer["1498595904821", "on"]'` would enable a pre-configured timer. See https://github.com/marcelrv/XiaomiRobotVacuumProtocol for all known available commands.
### Mi PM2.5 Air Quality Monitor (<a name="zhimi-airmonitor-v1">zhimi.airmonitor.v1</a>) Channels

5
_addons_bindings/remoteopenhab/readme.md
View File

@ -91,7 +91,10 @@ Only basic groups (with no state) from the remote server are ignored.
The channel ID of the created channel corresponds to the name of the item on the remote server.
For example, if your remote item is named `MyDate`, the channel UID of the channel created by the binding will be `remoteopenhab:server:xxx:MyDate`.
On the `thing` thing, if the `buildTriggerChannels` parameter is set to true, a channel is created automatically for each trigger channel defined in the remote thing.
On the `thing` thing, you will not find all channels from your remote thing.
Only trigger channels from your remote thing will be created.
**All state channels from your remote thing will be ignored** (use the `server` thing to link a local item to a remote (item).
if the `buildTriggerChannels` parameter is set to true, a channel is created automatically for each trigger channel defined in the remote thing.
For example, if your remote thing provides a trigger channel with this UID `astro:sun:local:night#event`, the channel UID of the channel created by the binding will be `remoteopenhab:thing:xxx:astro_sun_local_night_event`.
## Limitations

2
_addons_bindings/tesla/readme.md
View File

@ -49,7 +49,7 @@ There are two different ways of obtaining the token:
Run the following command on the console and provide your Tesla account credentials (the same that you use in the official Tesla app):
```
openhab> smarthome:tesla login
openhab> openhab:tesla login
Username (email): mail@example.com
Password: topsecret
Attempting login...Attempting login...

6
_addons_ios/homekit/readme.md
View File

@ -589,7 +589,7 @@ If you register an IP address that isn't reachable from your phone (such as `loc
HomeKit allows only a single pairing to be established with the bridge.
This pairing is normally shared across devices via iCloud.
If you need to establish a new pairing, you will need to clear the existing pairings.
To do this, you can issue the command `smarthome:homekit clearPairings` from the [OSGi console](https://www.openhab.org/docs/administration/console.html).
To do this, you can issue the command `openhab:homekit clearPairings` from the [OSGi console](https://www.openhab.org/docs/administration/console.html).
After doing this, you may need to remove the file `$OPENHAB_USERDATA/jsondb/homekit.json` and restart openHAB.
HomeKit requires a unique identifier for each accessory advertised by the bridge.
@ -612,7 +612,7 @@ openhab> log:tail io.github.hapjava
## Console commands
`smarthome:homekit list` - list all HomeKit accessories currently advertised to the HomeKit clients.
`openhab:homekit list` - list all HomeKit accessories currently advertised to the HomeKit clients.
`smarthome:homekit show <accessory_id | name>` - print additional details of the accessories which partially match provided ID or name.
`openhab:homekit show <accessory_id | name>` - print additional details of the accessories which partially match provided ID or name.

4
_thing_types/org.openhab.binding.deconz/src/main/resources/OH-INF/thing/light-thing-types.xml
View File

@ -97,7 +97,7 @@
<representation-property>uid</representation-property>
<config-description-ref uri="thing-type:deconz:light"/>
<config-description-ref uri="thing-type:deconz:colorlight"/>
</thing-type>
<thing-type id="extendedcolorlight">
@ -114,7 +114,7 @@
<representation-property>uid</representation-property>
<config-description-ref uri="thing-type:deconz:light"/>
<config-description-ref uri="thing-type:deconz:colorlight"/>
</thing-type>
<thing-type id="doorlock">

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

@ -6,7 +6,7 @@
<bridge-type id="server">
<label>Remote openHAB Server</label>
<description>A remote openHAB server.</description>
<description>A remote openHAB server. You will find one channel for each item defined in the remote server.</description>
<representation-property>host</representation-property>
@ -77,7 +77,8 @@
</supported-bridge-type-refs>
<label>Remote Thing</label>
<description>A thing from the remote openHAB server.</description>
<description>A thing from the remote openHAB server. You will find one channel for each trigger channel from the
remote thing (state channels from the remote thing will be ignored).</description>
<representation-property>thingUID</representation-property>