diff --git a/bundles/org.openhab.binding.miio/README.base.md b/bundles/org.openhab.binding.miio/README.base.md index 7cde488e60f66..1171656d94dc1 100644 --- a/bundles/org.openhab.binding.miio/README.base.md +++ b/bundles/org.openhab.binding.miio/README.base.md @@ -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 diff --git a/bundles/org.openhab.binding.miio/README.md b/bundles/org.openhab.binding.miio/README.md index 21d711a5d3729..d7f875f9ed390 100644 --- a/bundles/org.openhab.binding.miio/README.md +++ b/bundles/org.openhab.binding.miio/README.md @@ -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 diff --git a/bundles/org.openhab.binding.miio/pom.xml b/bundles/org.openhab.binding.miio/pom.xml index 0efd79fbc4ebb..1cd8342be88b2 100644 --- a/bundles/org.openhab.binding.miio/pom.xml +++ b/bundles/org.openhab.binding.miio/pom.xml @@ -8,5 +8,5 @@ 3.2.0-SNAPSHOT org.openhab.binding.miio - openHAB Add-ons :: Bundles :: Xiaomi Mi IO Binding + openHAB Add-ons :: Bundles :: Xiaomi Wifi devices (Mi IO) Binding diff --git a/bundles/org.openhab.binding.miio/src/main/feature/feature.xml b/bundles/org.openhab.binding.miio/src/main/feature/feature.xml index 1ab32f26fa245..e730cb7abb5af 100644 --- a/bundles/org.openhab.binding.miio/src/main/feature/feature.xml +++ b/bundles/org.openhab.binding.miio/src/main/feature/feature.xml @@ -2,7 +2,7 @@ mvn:org.openhab.core.features.karaf/org.openhab.core.features.karaf.openhab-core/${ohc.version}/xml/features - + openhab-runtime-base openhab-transport-mdns mvn:org.openhab.addons.bundles/org.openhab.binding.miio/${project.version} diff --git a/bundles/org.openhab.binding.miio/src/main/resources/OH-INF/binding/binding.xml b/bundles/org.openhab.binding.miio/src/main/resources/OH-INF/binding/binding.xml index 4dc76012096cf..899afad15bdbe 100644 --- a/bundles/org.openhab.binding.miio/src/main/resources/OH-INF/binding/binding.xml +++ b/bundles/org.openhab.binding.miio/src/main/resources/OH-INF/binding/binding.xml @@ -2,8 +2,9 @@ - Xiaomi Mi IO Binding - Binding for Xiaomi Mi IO (Wifi) devices like Mi Robot Vacuum, Yeelights, Humidifiers, Fans etc. + Xiaomi Wifi devices (Mi IO) Binding + Binding for Xiaomi wifi devices (Mi IO protocol) which are normally controlled by the mihome app like Mi + Robot Vacuums, Yeelights, Humidifiers, Fans etc. diff --git a/bundles/org.openhab.binding.miio/src/main/resources/OH-INF/i18n/miio.properties b/bundles/org.openhab.binding.miio/src/main/resources/OH-INF/i18n/miio.properties index cebf94f06556b..6386ec4497477 100644 --- a/bundles/org.openhab.binding.miio/src/main/resources/OH-INF/i18n/miio.properties +++ b/bundles/org.openhab.binding.miio/src/main/resources/OH-INF/i18n/miio.properties @@ -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