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

pull/1325/head
openHAB Build Server 2020-10-23 05:38:36 +00:00
parent db335ce692
commit 70c7bbfc12
4 changed files with 70 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
_addons_bindings/miio/readme.md
View File

@ -88,13 +88,13 @@ However, for devices that are unsupported, you may override the value and try to
### Example Thing file
`Thing miio:basic:light "My Light" [ host="192.168.x.x", token="put here your token", deviceId="0326xxxx" ]`
`Thing miio:basic:light "My Light" [ host="192.168.x.x", token="put here your token", deviceId="0326xxxx", model="philips.light.bulb" ]`
or in case of unknown models include the model information e.g.:
or in case of unknown models include the model information of a similar device that is supported:
`Thing miio:vacuum:s50 "vacuum" @ "livingroom" [ host="192.168.15.20", token="xxxxxxx", deviceId=“0470DDAA”, model="roborock.vacuum.s5" ]`
`Thing miio:vacuum:s50 "vacuum" @ "livingroom" [ host="192.168.15.20", token="xxxxxxx", deviceId=“0470DDAA”, model="roborock.vacuum.s4" ]`
## Mi IO Devices
# Mi IO Devices
| Device | ThingType | Device Model | Supported | Remark |
|------------------------------|------------------|------------------------|-----------|------------|
@ -341,6 +341,7 @@ The binding allows to try/test if your new device is working with database files
There are 2 ways to get unsupported devices working, by overriding the model with the model of a supported item or by test all known properties to see which are supported by your device.
## Substitute model for unsupported devices
Replace the model with the model which is already supported.
For this, first remove your unsupported thing. Manually add a miio:basic thing.
Besides the regular configuration (like ip address, token) the modelId needs to be provided.
@ -348,6 +349,7 @@ Normally the modelId is populated with the model of your device, however in this
Look at the openHAB forum, or the openHAB GitHub repository for the modelId of similar devices.
## Supported property test
The unsupported device has a test channel with switch. When switching on, all known properties are tested, this may take few minutes.
A test report will be shown in the log and is saved in the userdata/miio folder.
If supported properties are found, an experimental database file is saved to the conf/misc/miio folder (see below chapter).
@ -363,6 +365,43 @@ The conf/misc/miio (e.g. in Linux `/opt/openhab2/conf/misc/miio/`) is scanned fo
Note that local database files take preference over build-in ones, hence if a json file is local and in the database the local file will be used.
For format, please check the current database files in openHAB GitHub.
# FAQ.. what to do in case of problems
If your device is not getting online:
_Are you using text config?_
Make sure you define all the fields as per above example.
Or, better, try to get it going first without text config.
_The token is wrong_
The most common cause of non responding devices is a wrong token.
When you reset, or change wifi or update firmware, and possibly other cases as well, the token may change. You'll need to get a refreshed token.
_My token is coming from the cloud... how can it be wrong?_
Is not very likely but still can happen._
This can happen e.g. if your device is defined on multiple country servers.
The binding may pull the token from the wrong country server.
First try to get the token from all country servers by leave the county setting empty.
If that does not solve it, you define only the country that the device is on in the binding config page (where the cloud userid/pwd is entered) this should pull the right token.
_You have the same device added multiple times._
The communication each time send a sequential number.
If the device is twice defined, the numbers received by the device are no longer sequential and it will stop responding for some time.
_The connection is not too good, so you have timeouts etc._
Position your device closer to wifi / check in the mihome app if the wifi strength is good enough.
Alternatively as described above, double check for multiple connections for single device.
_Your device is on a different subnet?_
This is in most cases not working.
Firmware of the device don't accept commands coming from other subnets.
_Cloud connectivity is not working_
The most common problem is a wrong userId/password. Try to fix your userId/password.
If it still fails, you're bit out of luck. You may try to restart OpenHAB (not just the binding) to clean the cookies.
As the cloud logon process is still little understood, your only luck might be to enable trace logging and see if you can translate the Chinese error code that it returns.
# Channels
Depending on the device, different channels are available.
@ -1776,6 +1815,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
|------------------|---------|-------------------------------------|------------|
| power | Switch | Power | |
| usb | Switch | USB | |
| temperature | Number | Temperature | |
### Mi Power-plug v2 (<a name="chuangmi-plug-v2">chuangmi.plug.v2</a>) Channels
@ -4800,6 +4840,7 @@ note: Autogenerated example. Replace the id (plug) in the channel with your own.
Group G_plug "Mi Power-plug v1" <status>
Switch power "Power" (G_plug) {channel="miio:basic:plug:power"}
Switch usb "USB" (G_plug) {channel="miio:basic:plug:usb"}
Number temperature "Temperature" (G_plug) {channel="miio:basic:plug:temperature"}
```
### Mi Power-plug v2 (chuangmi.plug.v2) item file lines
@ -6393,10 +6434,10 @@ Number usedhours "Run Time" (G_heater) {channel="miio:basic:heater:usedhours"}
###(<a name="Country-Servers">Country Servers</a>)
### <a name="Country-Servers">Country Servers</a>
Known country Servers: cn, de, i2, ru, sg, us
Mapping of countries in mihome app to server
Mapping of countries in mihome app to server:
| Country | Country Code | Server |
|--------------------------|--------------|--------|

13
_addons_persistences/influxdb/readme.md
View File

@ -3,7 +3,7 @@ id: influxdb
label: InfluxDB (0.9 and newer)
title: InfluxDB (0.9 and newer) - Persistence Services
type: persistence
description: "This service allows you to persist and query states using the [InfluxDB](https://www.influxdata.com/products/influxdb-overview/) and [InfluxDB 2.0](https://v2.docs.influxdata.com/v2.0/) time series database. The persisted values can be queried from within openHAB. There also are nice tools on the web for visualizing InfluxDB time series, such as [Grafana](http://grafana.org/)."
description: "This service allows you to persist and query states using the [InfluxDB](https://www.influxdata.com/products/influxdb-overview/) and [InfluxDB 2.0](https://v2.docs.influxdata.com/v2.0/) time series database. The persisted values can be queried from within openHAB."
since: 3x
logo: images/addons/influxdb.png
install: auto
@ -15,15 +15,20 @@ install: auto
# InfluxDB (0.9 and newer) Persistence
This service allows you to persist and query states using the [InfluxDB](https://www.influxdata.com/products/influxdb-overview/) and [InfluxDB 2.0](https://v2.docs.influxdata.com/v2.0/) time series database. The persisted values can be queried from within openHAB. There also are nice tools on the web for visualizing InfluxDB time series, such as [Grafana](http://grafana.org/).
This service allows you to persist and query states using the [InfluxDB](https://www.influxdata.com/products/influxdb-overview/) and [InfluxDB 2.0](https://v2.docs.influxdata.com/v2.0/) time series database. The persisted values can be queried from within openHAB.
There also are nice tools on the web for visualizing InfluxDB time series, such as [Grafana](http://grafana.org/) and new Influx DB 2.0 version introduces [powerful data processing features.](https://docs.influxdata.com/influxdb/v2.0/process-data/get-started/)
## Database Structure
- This service allows you to persist and query states using the time series database.
- The states of an item are persisted in *measurements* points with names equal to the name of the item, or the alias, if one is provided. In both variants, a *tag* named "item" is added, containing the item name.
All values are stored in a *field* called "value" using integers or doubles if possible,`OnOffType` and `OpenClosedType` values are stored using 0 or 1.
- If configured extra tags for item category, label or type can be added fore each point.
All values are stored in a *field* called "value" using the following types:
- **float** for DecimalType and QuantityType
- **integer** for `OnOffType` and `OpenClosedType` (values are stored using 0 or 1) and `DateTimeType` (milliseconds since 1970-01-01T00:00:00Z)
- **string** for the rest of types
- If configured, extra tags for item category, label or type can be added fore each point.
Some example entries for an item with the name "speedtest" without any further configuration would look like this:

3
_thing_types/org.openhab.binding.hpprinter/src/main/resources/OH-INF/thing/thing-printer.xml
View File

@ -19,8 +19,9 @@
</channel-groups>
<properties>
<property name="vendor">HP</property>
<property name="uuid"></property>
</properties>
<representation-property>serialNumber</representation-property>
<representation-property>uuid</representation-property>
<config-description-ref uri="thing-type:hpprinter:config"/>
</thing-type>

14
installation/openhabian.md
View File

@ -39,11 +39,11 @@ The following features are provided by the openHABian image out of the box:
- Login information screen, powered by [FireMotD](https://github.com/OutsideIT/FireMotD)
- Customized Bash shell experience
- Customized settings and openHAB syntax highlighting for [vim](https://github.com/cyberkov/openhab-vim) and [nano](https://github.com/airix1/openhabnano)
- Frontail log viewer
- web based openHAB log viewer
- [Mosquitto](https://mosquitto.org) MQTT broker
- the [InfluxDB](https://www.influxdata.com/) database to store home automation data and [Grafana](https://grafana.com/) to visualize it
- FIND, the [Framework for Internal Navigation and Discovery](https://www.internalpositioning.com/)
- [WireGuard](https://www.wireguard.com/) for remote VPN access
- [Tailscale](https://tailscale.com/blog/how-tailscale-works/) VPN and [WireGuard](https://www.wireguard.com/) for remote VPN access
The included **openHABian Configuration Tool** [`openhabian-config`](#openhabian-configuration-tool) provides the following optional settings and components:
@ -202,6 +202,16 @@ Should you need to switch to run on backup, get a another new SD card to match t
Note most are not "exactly" 16 or 32 GB so your new one mustn't have less bytes than the old one.
Use menu option 54 to copy your active backup card back to the new one and switch back as soon as possible.
### Tailscale VPN network
Tailscale is a management toolset to establish a WireGuard based VPN between multiple systems if you want
to connect to openHAB(ian) instances outside your LAN over Internet.
It'll take care to detect and open ports when you and your peers are located behind firewalls.
[Download the client](https://tailscale.com/download) and eventually get the Solo service plan from Tailscale,
that's free for private use. This free service will automatically be selected when you fire up your first VPN node.
The Windows client has a link to the admin console where you can create pre-auth one-time keys. These you can put
as the `preauthkey` into `openhabian.conf` to automatically deploy remote openHABian nodes (unattended install)
and have them join the VPN.
## openHABian Configuration Tool
The following instructions target a Raspberry Pi openHABian setup but should be applicable to all openHABian environments.
Once connected to the command line console of your system, please execute the openHABian configuration tool by typing the following command.