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

pull/1325/head
openHAB Build Server 2020-11-15 10:47:58 +00:00
parent 0cbe63d185
commit b64e395df0
7 changed files with 218 additions and 37 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

48
_addons_bindings/miio/readme.md
View File

@ -166,6 +166,8 @@ or in case of unknown models include the model information of a similar device t
| Mr Bond M1 Pro Smart Clothes Dryer | miio:basic | [mrbond.airer.m1pro](#mrbond-airer-m1pro) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mr Bond M1 Smart Clothes Dryer | miio:basic | [mrbond.airer.m1s](#mrbond-airer-m1s) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mr Bond M1 Super Smart Clothes Dryer | miio:basic | [mrbond.airer.m1super](#mrbond-airer-m1super) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Xiaomi Scishare smart capsule coffee machine | miio:basic | [scishare.coffee.s1102](#scishare-coffee-s1102) | Yes | This device does not allow for regular querying for the status. Hence the status is not updated for the action channels. Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Xiaomi Scishare smart capsule coffee machine | miio:basic | [scishare.coffee.s1301](#scishare-coffee-s1301) | Yes | This device does not allow for regular querying for the status. Hence the status is not updated for the action channels. Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Xiaomi Philips Eyecare Smart Lamp 2 | miio:basic | [philips.light.sread1](#philips-light-sread1) | Yes | |
| Xiaomi Philips Eyecare Smart Lamp 2 | miio:basic | [philips.light.sread2](#philips-light-sread2) | Yes | |
| Xiaomi Philips LED Ceiling Lamp | miio:basic | [philips.light.ceiling](#philips-light-ceiling) | Yes | |
@ -1327,6 +1329,26 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| disinfect | Switch | disinfect | |
| distime | Number | Disinfect Time | |
### Xiaomi Scishare smart capsule coffee machine (<a name="scishare-coffee-s1102">scishare.coffee.s1102</a>) Channels
| Channel | Type | Description | Comment |
|------------------|---------|-------------------------------------|------------|
| power | Switch | Power | |
| Status | String | status | |
| expresso | Number | Brew Expresso | Value is the amount of coffee in ml. 2nd parameter in the json db is the water temperature |
| expresso | Number | Brew Americano | Value is the amount of coffee in ml. parameters in json are cupAmount: [set by OH], coffee: 40,water: 80, temp: 90 |
| boil | Number | Boil water | Value is the amount of water (ml) to heat. 2nd parameter in the json db is the water temperature |
### Xiaomi Scishare smart capsule coffee machine (<a name="scishare-coffee-s1301">scishare.coffee.s1301</a>) Channels
| Channel | Type | Description | Comment |
|------------------|---------|-------------------------------------|------------|
| power | Switch | Power | |
| Status | String | status | |
| expresso | Number | Brew Expresso | Value is the amount of coffee in ml. 2nd parameter in the json db is the water temperature |
| expresso | Number | Brew Americano | Value is the amount of coffee in ml. parameters in json are cupAmount: [set by OH], coffee: 40,water: 80, temp: 90 |
| boil | Number | Boil water | Value is the amount of water (ml) to heat. 2nd parameter in the json db is the water temperature |
### Xiaomi Philips Eyecare Smart Lamp 2 (<a name="philips-light-sread1">philips.light.sread1</a>) Channels
| Channel | Type | Description | Comment |
@ -4262,6 +4284,32 @@ Switch disinfect "disinfect" (G_airer) {channel="miio:basic:airer:disinfect"}
Number distime "Disinfect Time" (G_airer) {channel="miio:basic:airer:distime"}
```
### Xiaomi Scishare smart capsule coffee machine (scishare.coffee.s1102) item file lines
note: Autogenerated example. Replace the id (coffee) in the channel with your own. Replace `basic` with `generic` in the thing UID depending on how your thing was discovered.
```java
Group G_coffee "Xiaomi Scishare smart capsule coffee machine" <status>
Switch power "Power" (G_coffee) {channel="miio:basic:coffee:power"}
String Status "status" (G_coffee) {channel="miio:basic:coffee:Status"}
Number expresso "Brew Expresso" (G_coffee) {channel="miio:basic:coffee:expresso"}
Number expresso "Brew Americano" (G_coffee) {channel="miio:basic:coffee:expresso"}
Number boil "Boil water" (G_coffee) {channel="miio:basic:coffee:boil"}
```
### Xiaomi Scishare smart capsule coffee machine (scishare.coffee.s1301) item file lines
note: Autogenerated example. Replace the id (coffee) in the channel with your own. Replace `basic` with `generic` in the thing UID depending on how your thing was discovered.
```java
Group G_coffee "Xiaomi Scishare smart capsule coffee machine" <status>
Switch power "Power" (G_coffee) {channel="miio:basic:coffee:power"}
String Status "status" (G_coffee) {channel="miio:basic:coffee:Status"}
Number expresso "Brew Expresso" (G_coffee) {channel="miio:basic:coffee:expresso"}
Number expresso "Brew Americano" (G_coffee) {channel="miio:basic:coffee:expresso"}
Number boil "Boil water" (G_coffee) {channel="miio:basic:coffee:boil"}
```
### Xiaomi Philips Eyecare Smart Lamp 2 (philips.light.sread1) item file lines
note: Autogenerated example. Replace the id (light) in the channel with your own. Replace `basic` with `generic` in the thing UID depending on how your thing was discovered.

72
_addons_bindings/remoteopenhab/readme.md
View File

@ -17,11 +17,13 @@ install: auto
The Remote openHAB binding allows to communicate with remote openHAB servers.
The communication is bidirectional.
The binding on the local server listens to any item state updates on the remote server and updates accordingly the linked channel on the local server.
It also transfers any item command from the local server to the remote server.
It transfers any item command from the local server to the remote server.
It can map any remote thing to a local thing.
Through this mapping, in your rules (local server), you can take actions based upon status updates or status changes generated by remote things and you can take actions based upon trigger events generated by the trigger channels defined in the remote thing.
One first usage is the distribution of your home automation system on a set of openHAB servers.
One use of this binding is to distribute your home automation system on multiple openHAB servers.
A second usage is for users having old openHAB v1 bindings running that were not migrated to openHAB v2 or openHAB v3.
Another use is for users to interact with older versions of openHAB that may support old openHAB v1 bindings that were not migrated to openHAB v2 or openHAB v3.
They can keep an openHAB v2 server to run their old openHAB v1 bindings and setup a new openHAB v3 server for everything else.
The Remote openHAB binding installed on the openHAB v3 server will then allow to use the openHAB v1 bindings through communication with the openHAB v2 server.
@ -29,7 +31,7 @@ A third usage is for users that would like to keep unchanged an existing openHAB
## Supported Things
There is one unique supported thing : the `server` bridge thing
There is two supported things : the `server` bridge thing representing a remote openHAB server and the `thing` thing representing a thing from the remote openHAB server.
## Discovery
@ -38,39 +40,75 @@ You will find in the inbox one discovery thing per remote server interface.
So if your remote server has one IPv4 address and one IPv6 address, you will discover two things in the inbox.
Just choose one of the two things.
Once a bridge thing representing a remote openHAB server is created, all things from this remote server will be discovered when you scan for new things.
## Binding Configuration
The binding has no configuration options, all configuration is done at Thing level.
## Thing Configuration
The thing has the following configuration parameters:
The `server` thing has the following configuration parameters:
| Parameter | Required | Description |
|-----------|-------------------------------------------------------------------------------------------------------------------|
| host | yes | The host name or IP address of the remote openHAB server. |
| port | yes | The HTTP port to be used to communicate with the remote openHAB server. Default is 8080. |
| restPath | yes | The subpath of the REST API on the remote openHAB server. Default is /rest |
| token | no | The token to use when the remote openHAB server is setup to require authorization to run its REST API. |
| Parameter | Required | Description |
|--------------------|----------|-----------------------------------------------------------------------------------------------------------|
| host | yes | The host name or IP address of the remote openHAB server. |
| useHttps | no | Set to true if you want to use HTTPS to communicate with the remote openHAB server. Default is false. |
| port | yes | The HTTP port to use to communicate with the remote openHAB server. Default is 8080. |
| trustedCertificate | no | Set to true if you want to use HTTPS even without a valid SSL certificate provided by your remote server. |
| restPath | yes | The subpath of the REST API on the remote openHAB server. Default is /rest |
| token | no | The token to use when the remote openHAB server is setup to require authorization to run its REST API. |
The `thing` thing has the following configuration parameters:
| Parameter | Required | Description |
|----------------------|----------|---------------------------------------------|
| thingUID | yes | The thing UID in the remote openHAB server. |
| buildTriggerChannels | no | If set to true, a trigger channel will be automatically created and linked to each trigger channel from the remote thing. Default is true. |
Please note that if your remote server is an openHAB v3 server, you will need to define a valid token on your bridge thing to have your things correctly initialized.
Setting the `buildTriggerChannels` parameter to false is for the main following advanced usages :
* you don't care about the trigger channels of this remote thing and you don't want the binding to create them locally,
* you want to define the trigger channels in your configuration file, and only the channels that you will finally need,
* you want to set a specific channel ID rather than using the channel ID created by the binding.
## Thing Status
The status of any `thing` thing is a mapping of the remote thing status.
A mapping is done only when the `server` bridge is ONLINE (meaning the local server is connected to the remote server).
Please note that every remote status other than UNKNOWN, ONLINE and OFFLINE will then be considered as OFFLINE on the local server.
## Channels
The channels are built dynamically and automatically by the binding.
One channel is created for each item from the remote server.
Only basic groups (with no state) are ignored.
The channel id of the built channel corresponds to the name of the item on the remote server.
Channels are built dynamically and automatically by the binding.
On the `server` thing, a channel is created automatically for each item defined in the remote server.
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.
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
* The binding will not try to communicate with an openHAB v1 server.
* The binding only uses the HTTP protocol for the communications with the remote server (not HTTPS).
## Example
### demo.things:
```
Bridge remoteopenhab:server:oh2 "OH2 server" [ host="192.168.0.100" ]
Bridge remoteopenhab:server:oh2 "OH2 server" [ host="192.168.0.100", port=8443, useHttps=true, trustedCertificate=true ] {
Thing thing tv "TV living room" [ thingUID="lgwebos:WebOSTV:tv" ]
Thing thing astroSun "Astro sun" [ thingUID="astro:sun:local", buildTriggerChannels=false ] {
Channels:
Type trigger : nightEvent "Night Event" [ channelUID="astro:sun:local:night#event" ]
}
Thing thing astroMoon "Astro moon" [ thingUID="astro:moon:local" ]
}
```
### demo.items:

14
_thing_types/org.openhab.binding.bluetooth.bluegiga/src/main/resources/OH-INF/thing/bluegiga.xml
View File

@ -42,40 +42,40 @@
<parameter name="passiveScanInterval" type="integer" min="4" max="16384">
<label>Passive Scan Interval</label>
<description>Passive scan interval defines the interval when scanning is re-started in units of 625us. Default is
4000ms.</description>
6400 units (4000ms).</description>
<advanced>true</advanced>
<default>6400</default>
</parameter>
<parameter name="passiveScanWindow" type="integer" min="4" max="16384">
<label>Passive Scan Window</label>
<description>Passive scan Window defines how long time the scanner will listen on a certain frequency and try to
pick up advertisement packets. Default is 4000ms.</description>
pick up advertisement packets. Default is 6400 units (4000ms).</description>
<advanced>true</advanced>
<default>6400</default>
</parameter>
<parameter name="activeScanInterval" type="integer" min="4" max="16384">
<label>Active Scan Interval</label>
<description>Active scan interval defines the interval when scanning is re-started in units of 625us. Default is
4000ms.</description>
6400 units (4000ms).</description>
<advanced>true</advanced>
<default>6400</default>
</parameter>
<parameter name="activeScanWindow" type="integer" min="4" max="16384">
<label>Active Scan Window</label>
<description>Active scan Window defines how long time the scanner will listen on a certain frequency and try to pick
up advertisement packets. Default is 4000ms.</description>
up advertisement packets. Default is 6400 units (4000ms).</description>
<advanced>true</advanced>
<default>6400</default>
</parameter>
<parameter name="connIntervalMin" type="integer" min="6" max="3200">
<label>Minimum Connection Interval</label>
<description>Minimum connection interval in units of 1.25ms. Default is 100ms.</description>
<description>Minimum connection interval in units of 1.25ms. Default is 80 units (100ms).</description>
<advanced>true</advanced>
<default>80</default>
</parameter>
<parameter name="connIntervalMax" type="integer" min="6" max="3200">
<label>Maximum Connection Interval</label>
<description>Maximum connection interval in units of 1.25ms. Default is 1000ms.</description>
<description>Maximum connection interval in units of 1.25ms. Default is 800 units (1000ms).</description>
<advanced>true</advanced>
<default>800</default>
</parameter>
@ -88,7 +88,7 @@
<parameter name="connTimeout" type="integer" min="10" max="3200">
<label>Connection Supervision Timeout</label>
<description>Connection supervision timeout in units of 10ms defines how long the devices can be out of range before
the connection is closed. Default is 10000ms.</description>
the connection is closed. Default is 1000 units (10000ms).</description>
<advanced>true</advanced>
<default>1000</default>
</parameter>

46
_thing_types/org.openhab.binding.miio/src/main/resources/OH-INF/thing/commonChannels.xml
View File

@ -14,6 +14,52 @@
</channels>
</channel-group-type>
<!-- Generic channels -->
<channel-type id="color">
<item-type>Color</item-type>
<label>Generic Color Channel</label>
</channel-type>
<channel-type id="contact">
<item-type>Contact</item-type>
<label>Generic Contact Channel</label>
</channel-type>
<channel-type id="datetime">
<item-type>DateTime</item-type>
<label>Generic DateTime Channel</label>
</channel-type>
<channel-type id="dimmer">
<item-type>Dimmer</item-type>
<label>Generic Dimmer Channel</label>
</channel-type>
<channel-type id="image">
<item-type>Image</item-type>
<label>Generic Image Channel</label>
</channel-type>
<channel-type id="location">
<item-type>Location</item-type>
<label>Generic Location Channel</label>
</channel-type>
<channel-type id="number">
<item-type>Number</item-type>
<label>Generic Number Channel</label>
</channel-type>
<channel-type id="player">
<item-type>Player</item-type>
<label>Generic Player Channel</label>
</channel-type>
<channel-type id="rollershutter">
<item-type>Rollershutter</item-type>
<label>Generic Rollershutter Channel</label>
</channel-type>
<channel-type id="string">
<item-type>String</item-type>
<label>Generic String Channel</label>
</channel-type>
<channel-type id="switch">
<item-type>Switch</item-type>
<label>Generic Switch Channel</label>
</channel-type>
<!-- Network channels -->
<channel-type id="ssid" advanced="true">
<item-type>String</item-type>

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

@ -11,25 +11,38 @@
<representation-property>host</representation-property>
<config-description>
<parameter name="host" type="text">
<parameter name="host" type="text" required="true">
<context>network-address</context>
<label>Server Address</label>
<description>The host name or IP address of the remote openHAB server.</description>
<required>true</required>
</parameter>
<parameter name="port" type="integer">
<parameter name="useHttps" type="boolean">
<label>Use HTTPS</label>
<description>Set it to true in case you want to use HTTPS to communicate with the remote openHAB server. Default is
false.</description>
<default>false</default>
<advanced>true</advanced>
</parameter>
<parameter name="port" type="integer" required="true">
<label>Server HTTP Port</label>
<description>The HTTP port to be used to communicate with the remote openHAB server.</description>
<required>true</required>
<description>The HTTP port to use to communicate with the remote openHAB server.</description>
<default>8080</default>
<advanced>true</advanced>
</parameter>
<parameter name="restPath" type="text">
<parameter name="trustedCertificate" type="boolean">
<label>Trust SSL Certificate</label>
<description>Set it to true in case you want to use HTTPS even without a valid SSL certificate provided by your
remote server.</description>
<default>false</default>
<advanced>true</advanced>
</parameter>
<parameter name="restPath" type="text" required="true">
<label>REST API Path</label>
<description>The subpath of the REST API on the remote openHAB server.</description>
<required>true</required>
<default>/rest</default>
<advanced>true</advanced>
</parameter>
@ -38,10 +51,46 @@
<context>password</context>
<label>Token</label>
<description>The token to use when the remote openHAB server is setup to require authorization to run its REST API.</description>
<required>false</required>
<advanced>true</advanced>
</parameter>
</config-description>
</bridge-type>
<thing-type id="thing">
<supported-bridge-type-refs>
<bridge-type-ref id="server"/>
</supported-bridge-type-refs>
<label>Remote Thing</label>
<description>A thing from the remote openHAB server.</description>
<representation-property>thingUID</representation-property>
<config-description>
<parameter name="thingUID" type="text" required="true">
<label>Remote Thing UID</label>
<description>The thing UID in the remote openHAB server.</description>
</parameter>
<parameter name="buildTriggerChannels" type="boolean">
<label>Automatic Trigger Channels Building</label>
<description>If set to true, a trigger channel will be automatically created and linked to each trigger channel from
the remote thing.</description>
<default>true</default>
<advanced>true</advanced>
</parameter>
</config-description>
</thing-type>
<channel-type id="trigger">
<kind>trigger</kind>
<label>Trigger Channel</label>
<config-description>
<parameter name="channelUID" type="text" required="true">
<label>Remote Channel UID</label>
<description>The channel UID in the remote openHAB server.</description>
</parameter>
</config-description>
</channel-type>
</thing:thing-descriptions>

8
installation/openhabian.md
View File

@ -227,16 +227,16 @@ Delayed rules load will also be enabled by default. This is renaming the rules f
## Setup notes
### On openHAB3
openHABian will install latest stable **openHAB2** by default. To ease upgrading, `openhabian-config` will migrate the openHABian environment and install openHAB3 for you.
openHABian will install latest stable **openHAB 2** by default. To ease upgrading, `openhabian-config` will migrate the openHABian environment and install openHAB3 for you.
There's big changes such as to install Java 11 (which is mandatory for openHAB3).
openHAB3 will use a separate file `/etc/default/openhab` and most directory names will change from `... /openhab2/ ...` to `... /openhab/ ...` (NOTE: not `openhab3`).
It's a number of places there'll be changes in, often subtle ones like the name of Samba export shares to change.
Note that this code is still in BETA so with some bad luck it might mess up your system. We kindly ask you to help and report any issues on Github, including simple ones like when a title hasn't been renamed.
Menu option 04 will do the upgrade.
Menu option 42 will do the upgrade.
Be aware that there is ONLY an openHAB upgrade path. You cannot downgrade from OH3 to OH2.
You can exchange the binary packages (which is what openHABian will do), but there is no help to change your configuration back to a OH2 compatible one.
So it is essential that you take a backup before you upgrade. You will have to restore your setup from that backup after a downgrade using menu option 51 or by manually using `openhab-cli restore <file>`.
Menu option 05 will do the inverse and change the environment. It'll NOT downgrade Java. openHAB2 is known to run with Java 11, though.
Menu option 05 will do the inverse and change the environment. It'll NOT downgrade Java. openHAB 2 is known to run with Java 11, though.
### `openhabian.conf`
You can actually set a number of parameters _before_ you run an unattended installation. This applies to the RPi image on an SD card as well as to a manual installation.
@ -326,7 +326,7 @@ You'll find all of these in the [openHABian Configuration Tool](#openhabian-conf
- Mi Flora MQTT demon
- [InfluxDB and Grafana](https://community.openhab.org/t/influxdb-grafana-persistence-and-graphing/13761/1) - persistence and graphing available from [http://openhab:3000](http://openhab:3000)
- [Eclipse Mosquitto](http://mosquitto.org) - Open Source MQTT v3.1/v3.1.1 Broker
- [Node-RED](https://nodered.org) - "Flow-based programming for the Internet of Things", with preinstalled [openHAB2](https://flows.nodered.org/node/node-red-contrib-openhab2) and [BigTimer](https://flows.nodered.org/node/node-red-contrib-bigtimer) add-ons. Accessible from [http://openhab:1880](http://openhab:1880)
- [Node-RED](https://nodered.org) - "Flow-based programming for the Internet of Things", with preinstalled [openHAB 2](https://flows.nodered.org/node/node-red-contrib-openhab2) and [BigTimer](https://flows.nodered.org/node/node-red-contrib-bigtimer) add-ons. Accessible from [http://openhab:1880](http://openhab:1880)
- [Homegear](https://www.homegear.eu/index.php/Main_Page) - Homematic control unit emulation
- [KNXd](http://michlstechblog.info/blog/raspberry-pi-eibknx-ip-gateway-and-router-with-knxd) - KNX daemon running at `224.0.23.12:3671/UDP`
- [OWServer](http://owfs.org/index.php?page=owserver_protocol) - 1wire control system