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

[miio] Improve binding description (#11690)

Browse Source 
* [miio] Improve binding description

Signed-off-by: Marcel Verpaalen <marcel@verpaalen.com>
This commit is contained in:
Marcel 2021-12-04 16:36:05 +01:00 committed by GitHub
parent 2a9e264075
commit 13bae622ac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,7 +1,8 @@
# Xiaomi Mi IO Binding
# Xiaomi Wifi devices (Mi IO) Binding
This binding is used to control Xiaomi products implementing the Mi IO protocol.
This is a set of wifi devices from Xiaomi that are part of the Mi Ecosystem which is branded as MiJia.
This protocol is used for most of Xiaomi Mi Ecosystem wifi devices which is branded as MiJia.
If your Xiaomi wifi device is controlled by the mihome app, most likely it communicates using the Mi IO protocol and can communicate with openHAB using this binding.
![MIIO logo](doc/miio.png)
@ -12,9 +13,9 @@ The following things types are available:
| ThingType | Description |
|------------------|--------------------------------------------------------------------------------------------------------------------------|
| miio:generic | Generic type for discovered devices. Once the token is available and the device model is determined, this ThingType will automatically change to the appropriate ThingType |
| miio:vacuum | For Xiaomi Robot Vacuum products |
| miio:basic | For several basic devices like yeelights, airpurifiers. Channels and commands are determined by database configuration |
| miio:unsupported | For experimenting with other devices which use the Mi IO protocol |
| miio:vacuum | For Xiaomi/RoboRock Robot Vacuum products |
| miio:basic | For most other devices like yeelights, airpurifiers. Channels and commands are determined by database configuration |
| miio:unsupported | For experimenting with other devices which use the Mi IO protocol or to build experimental support |
# Discovery

11
bundles/org.openhab.binding.miio/README.md
View File

@ -1,7 +1,8 @@
# Xiaomi Mi IO Binding
# Xiaomi Wifi devices (Mi IO) Binding
This binding is used to control Xiaomi products implementing the Mi IO protocol.
This is a set of wifi devices from Xiaomi that are part of the Mi Ecosystem which is branded as MiJia.
This protocol is used for most of Xiaomi Mi Ecosystem wifi devices which is branded as MiJia.
If your Xiaomi wifi device is controlled by the mihome app, most likely it communicates using the Mi IO protocol and can communicate with openHAB using this binding.
![MIIO logo](doc/miio.png)
@ -12,9 +13,9 @@ The following things types are available:
| ThingType | Description |
|------------------|--------------------------------------------------------------------------------------------------------------------------|
| miio:generic | Generic type for discovered devices. Once the token is available and the device model is determined, this ThingType will automatically change to the appropriate ThingType |
| miio:vacuum | For Xiaomi Robot Vacuum products |
| miio:basic | For several basic devices like yeelights, airpurifiers. Channels and commands are determined by database configuration |
| miio:unsupported | For experimenting with other devices which use the Mi IO protocol |
| miio:vacuum | For Xiaomi/RoboRock Robot Vacuum products |
| miio:basic | For most other devices like yeelights, airpurifiers. Channels and commands are determined by database configuration |
| miio:unsupported | For experimenting with other devices which use the Mi IO protocol or to build experimental support |
# Discovery

2
bundles/org.openhab.binding.miio/pom.xml
View File

@ -8,5 +8,5 @@
<version>3.2.0-SNAPSHOT</version>
</parent>
<artifactId>org.openhab.binding.miio</artifactId>
<name>openHAB Add-ons :: Bundles :: Xiaomi Mi IO Binding</name>
<name>openHAB Add-ons :: Bundles :: Xiaomi Wifi devices (Mi IO) Binding</name>
</project>

2
bundles/org.openhab.binding.miio/src/main/feature/feature.xml
View File

@ -2,7 +2,7 @@
<features name="org.openhab.binding.miio-${project.version}" xmlns="http://karaf.apache.org/xmlns/features/v1.4.0">
<repository>mvn:org.openhab.core.features.karaf/org.openhab.core.features.karaf.openhab-core/${ohc.version}/xml/features</repository>
<feature name="openhab-binding-miio" description="Xiaomi Mi IO Binding" version="${project.version}">
<feature name="openhab-binding-miio" description="Xiaomi Wifi devices (Mi IO) Binding" version="${project.version}">
<feature>openhab-runtime-base</feature>
<feature>openhab-transport-mdns</feature>
<bundle start-level="80">mvn:org.openhab.addons.bundles/org.openhab.binding.miio/${project.version}</bundle>

5
bundles/org.openhab.binding.miio/src/main/resources/OH-INF/binding/binding.xml
View File

@ -2,8 +2,9 @@
<binding:binding id="miio" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:binding="https://openhab.org/schemas/binding/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/binding/v1.0.0 https://openhab.org/schemas/binding-1.0.0.xsd">
<name>Xiaomi Mi IO Binding</name>
<description>Binding for Xiaomi Mi IO (Wifi) devices like Mi Robot Vacuum, Yeelights, Humidifiers, Fans etc.</description>
<name>Xiaomi Wifi devices (Mi IO) Binding</name>
<description>Binding for Xiaomi wifi devices (Mi IO protocol) which are normally controlled by the mihome app like Mi
Robot Vacuums, Yeelights, Humidifiers, Fans etc.</description>
<config-description>
<parameter name="username" type="text" required="false">

4
bundles/org.openhab.binding.miio/src/main/resources/OH-INF/i18n/miio.properties
View File

@ -1,7 +1,7 @@
# binding
binding.miio.name = Xiaomi Mi IO Binding
binding.miio.description = Binding for Xiaomi Mi IO (Wifi) devices like Mi Robot Vacuum, Yeelights, Humidifiers, Fans etc.
binding.miio.name = Xiaomi Wifi devices (Mi IO) Binding
binding.miio.description = Binding for Xiaomi wifi devices (Mi IO protocol) which are normally controlled by the mihome app like Mi Robot Vacuums, Yeelights, Humidifiers, Fans etc.
# binding config