[miio] Improve binding description (openhab#11690)

* [miio] Improve binding description Signed-off-by: Marcel Verpaalen <marcel@verpaalen.com> Signed-off-by: Michael Schmidt <mi.schmidt.83@gmail.com>
mischmidt83 · Jan 9, 2022 · 87b658b · 87b658b
1 parent 2a435f3
commit 87b658b
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 16 deletions.
diff --git 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
@@ -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
@@ -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>
diff --git 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 @@
 <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>

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
@@ -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">

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
@@ -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