public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[miio] readme update (#9858)

Browse Source 
Update screenshots to OH3
Minor improvements readme
update device_names list to latest

Signed-off-by: Marcel Verpaalen <marcel@verpaalen.com>
This commit is contained in:
Marcel
2021-01-18 21:37:23 +01:00
committed by GitHub
parent 155e3b770d
commit 247afd48c8
4 changed files with 166 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
bundles/org.openhab.binding.miio/README.base.md
View File

@@ -32,6 +32,7 @@ Go to the binding config page and enter your cloud username and password.
The server(s) to which your devices are connected need to be entered as well.
Use the one of the regional servers: cn,de,i2,tw,ru,sg,us.
Multiple servers can be separated with comma, or leave blank to test all known servers.
See [binding configuration](#binding-configuration) for more details about the binding config.
## Tokens without cloud access
@@ -51,13 +52,19 @@ Note. The Xiaomi devices change the token when inclusion is done. Hence if you g
## Binding Configuration
No binding configuration is required. However to enable cloud functionality enter your Xiaomi username, password and server(s).
The list of the known countries and related severs is [here](#Country-Servers).
The list of the known countries and related severs is [here](#country-servers).
After successful Xiaomi cloud login, the binding will use the connection to retrieve the required device tokens from the cloud.
For Xiaomi vacuums the map can be visualized in openHAB using the cloud connection.
To enter your cloud details go to the bindings page, click the Xiaomi Mi IO binding and than configure.
![Binding Config](doc/miioBindingConfig.jpg)
In the configuration page, enter your userID /passwd and county(s) or leave the countries servers blank.
![Binding Config](doc/miioBindingConfig2.jpg)
The binding also supports the discovery of devices via the cloud. This may be useful if the device is on a separate subnet. (note, after accepting such a device on a different subnet, the communication needs to be set to cloud in order to have it working.)
## Thing Configuration
Each Xiaomi device (thing) needs the IP address and token configured to be able to communicate. See discovery for details.
@@ -115,8 +122,8 @@ After validation, please share the logfile and json files on the openHAB forum o
Things using the basic handler (miio:basic things) are driven by json 'database' files.
This instructs the binding which channels to create, which properties and actions are associated with the channels etc.
The conf/misc/miio (e.g. in Linux `/opt/openhab/conf/misc/miio/`) is scanned for database files and will be used for your devices.
During the start of the binding the exact path used in your system will be printed in the debug log.
Watch for a line containing `Started miio basic devices local databases watch service. Watching for database files at path: …`
During the start of the binding the exact path used in your system will be printed in the _debug_ log.
Watch for a line containing `Started miio basic devices local databases watch service. Watching for database files at path: …` (
If this folder is created after the start of the binding, you may need to restart the binding (or openHAB) to be able to use the local files.
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.
@@ -253,7 +260,7 @@ Additionally depending on the capabilities of your robot vacuum other channels m
!!!itemFileExamples
### <a name="Country-Servers">Country Servers</a>
### Country Servers
Known country Servers: cn, de, i2, ru, sg, us