Initial commit

doc/de/README.md

@@ -0,0 +1,125 @@
+![Logo](media/mihome.png)
+# yunkong2 Mi Home Adapter
+Mit dem Mi Home Adapter wird ein Mi Control Hub (Gateway) in ein yunkong2 System  
+eingebunden und ermöglicht so die Kommunikation verschiedener Xiaomi Sensoren,  
+Schalter etc. mit yunkong2.
+
+Über yunkong2 kann z.B. die Beleuchtung und der Lautsprecher des Gateways gesteuert  
+werden.
+
+## Voraussetzungen
+* Mi Home App auf Android oder iOS Gerät und frei geschaltete lokale Netzwerk Funktion
+* Angeschlossenes Mi Home Gateway
+* Betriebsbereites yunkong2 System
+
+### Installation der Mi Home App und freischalten der lokalen Netzwerk Funktion
+
+#### Android
+* [Android Mi Home App][Android App] auf einem Android Gerät herunterladen, installieren, öffnen und  
+den Geschäftsbedingungen zustimmen.
+* Als Land `Festland-China` auswählen 
+* Über `Anmelden` ein Konto erstellen
+* Nach der erfolgreichen Anmeldung über `+` ein Gerät hinzufügen
+* Unter `Haushaltssicherheit` den `MI Control Hub` auswählen und den Anweisungen   
+folgen
+* Nach erfolgreichem einbinden des Gateways die 3 Punkte am oberen rechten Bildschirm   
+und danach `About` betätigen
+* Den Text `Plug-in version` unten 10mal tippen
+* Nun ist der Entwickler Modus eingeschaltet und es sollten nach einer gewissen Zeit   
+2 weitere Menüpunkte erscheinen   
+>Falls nicht, wiederholt versuchen
+* Den Menüpunkt `Wireless communication protocol` auswählen
+* Den Schiebeschalter oben einschalten, das Passwort notieren und mit `OK` bestätigen.  
+>Das Passwort wird später bei der yunkong2 Installation benötigt.
+
+Nun können weitere Geräte über das `+` Zeichen angelernt werden.
+
+#### iOS
+* [iOS Mi Home App][ios App] auf einem iOS Gerät herunterladen, installieren, öffnen und der  
+Datenschutzerklärung zustimmen
+* Über Profil/Einstellungen/Ländereinstellungen das Land `Festland` auswählen. 
+* Über `Anmelden` ein Konto erstellen
+* Nach der erfolgreichen Anmeldung über `+` ein Gerät hinzufügen
+* Unter `Haushalt Sicherheit` den `MI Control Hub` auswählen und den Anweisungen   
+folgen
+* Nach erfolgreichem einbinden des Gateways die 3 Punkte am oberen rechten Bildschirm   
+betätigen und `About` betätigen
+* Wiederholt im leeren unteren Bereich tippen 
+* Nun ist der Entwickler Modus eingeschaltet und es sollten nach einer gewissen Zeit   
+weitere Menüpunkte erscheinen   
+> Falls es nicht gleich klappt, die Schritte wiederholen
+* Den 4. Menüpunkt auswählen
+* Den Schiebeschalter oben einschalten, das Passwort notieren und mit `OK` bestätigen.  
+>Das Passwort wird später bei der yunkong2 Installation benötigt.
+
+Nun können weitere Geräte über das `+` Zeichen angelernt werden.
+
+### Einstellung am Router
+Unter About/Hub info kann im Text nach _localip_ die vom Gateway verwendete IP Adresse   
+des Gateways ermittelt werden. Im verwendeten Router sollte diese IP dem Gateway fest   
+zugewiesen werden.  
+Falls die Bedienung der angelernten Geräte über die App nicht mehr gewollt ist, kann nach   
+dem anlernen aller Geräte im Router auch der Internet Zugriff des Gateways abgeschaltet   
+werden.
+
+
+### Unterstützte Geräte
+Die folgende Aufstellung erhebt keinen Anspruch auf Vollständigkeit:
+- gateway -           Xiaomi RGB Gateway
+- sensor_ht -         Xiaomi Temperature/Humidity
+- weather.v1 -        Xiaomi Temperature/Humidity/Pressure
+- switch -            Xiaomi Wireless Switch
+- sensor_switch.aq2 - Xiaomi Aqara Wireless Switch Sensor
+- sensor_switch.aq3 - Xiaomi Aqara Wireless Switch Sensor
+- plug -              Xiaomi Smart Plug
+- 86plug -            Xiaomi Smart Wall Plug
+- 86sw2 -             Xiaomi Wireless Dual Wall Switch
+- 86sw1 -             Xiaomi Wireless Single Wall Switch
+- natgas -            Xiaomi Mijia Honeywell Gas Alarm Detector
+- smoke -             Xiaomi Mijia Honeywell Fire Alarm Detector
+- ctrl_ln1 -          Xiaomi Aqara 86 Fire Wall Switch One Button
+- ctrl_ln1.aq1 -      Xiaomi Aqara Wall Switch LN
+- ctrl_ln2 -          Xiaomi 86 zero fire wall switch double key
+- ctrl_ln2.aq1 -      Xiaomi Aqara Wall Switch LN double key
+- ctrl_neutral2 -     Xiaomi Wired Dual Wall Switch
+- ctrl_neutral1 -     Xiaomi Wired Single Wall Switch
+- cube -              Xiaomi Cube
+- sensor_cube.aqgl01 - Xiaomi Cube
+- magnet -            Xiaomi Door Sensor
+- sensor_magnet.aq2 - Xiaomi Aqara Door Sensor
+- curtain -           Xiaomi Aqara Smart Curtain
+- motion -            Xiaomi Motion Sensor
+- sensor_motion.aq2 - Xiaomi Aqara Motion Sensor
+- sensor_wleak.aq1 -  Xiaomi Aqara water sensor
+- ctrl_ln2.aq1 -      Xiaomi Aqara Wall Switch LN (Double)
+- remote.b286acn01 -  Xiaomi Aqara Wireless Remote Switch (Double Rocker)
+- remote.b1acn01 -    Xiaomi Aqara Wireless Remote Switch
+- vibration -         Xiaomi vibration Sensor
+- wleak1 -            Xiaomi Aqara Water Sensor
+- lock_aq1 -          Xiaomi Lock
+
+## yunkong2 Mi Home Adapter Installation
+Weitere Einstellungen erfolgen nur noch über die yunkong2 Admin-Oberfläche.  
+Den Adapter im Bereich `Adapter` suchen und über das `+` Zeichen installieren.
+
+![Logo](media/Adapter.png)
+
+Es öffnet sich dann folgendes Konfigurationsfenster:
+
+![Logo](media/Adapterconfig1.PNG)
+
+Unter `Default Gateway Key` das oben ermittelte Passwort eintragen und mit `speichern`  
+`und schließen` das Fenster schließen. Der laufende Adapter sollte danach unter   
+`Instanzen` grün angezeigt werden:
+
+![Logo](media/Instanz.PNG)
+
+Unter `Objekte` wird nun das Gateway und seine angelernten Geräte angezeigt:
+
+![Logo](media/Objekte.PNG)
+
+Die Anleitung wurde nach besten Wissen und Gewissen erstellt. 
+
+[Android App]:(https://play.google.com/store/apps/details?id=com.xiaomi.smarthome)
+
+[iOS App]:(https://itunes.apple.com/de/app/mi-home-xiaomi-smarthome/id957323480?mt=8)

doc/en/Readme.md

@@ -0,0 +1,114 @@
+![Logo](media/mihome.png)
+# yunkong2 Mi Home Adapter
+The Mi Home Adapter integrates a Mi Control Hub (Gateway) into an yunkong2 system  
+and enables the communication of various Xiaomi sensors, switches etc. with yunkong2.
+
+Via yunkong2, e.g. the lighting and the speaker of the gateway are controlled.
+## Requirements
+* Mi Home App on Android or iOS device and free local network function
+* Connected Mi Home Gateway
+* Ready to use yunkong2 system
+### Mi Home App installation and local network feature unlocking
+#### Android 
+* Download, install and open [Android Mi Home App][Android App] on an Android device
+* Choose `Mainland China` and set language `English`
+* Setup an Account with `Sign in`
+* After successfully logging in add a device via `+`
+* Choose `MI Control Hub` under `Household security` and follow the instructions 
+* After successfully integration of the Gateway in Mi Home tip the 3 dots at the top  
+right of the screen and click `About`
+* Tap the text `Plug*in version` number at the bottom of the screen 10 times
+* There should be now 2 extra options listed until the developer mode is enabled.   
+[ if not try all steps again!]
+* Choose the option `Wireless communication protocol`
+* Then tap the first toggle switch to enable LAN functions. Note down the password.
+> Password is required later in the yunkong2 installation.
+* Make sure to hit the OK button to save changes.
+* If you change here something, you lose your password!
+
+Now further devices can be trained via the `+` sign.
+
+#### iOS
+* Download, install and open [iOS Mi Home App][ios App] on a iOS device
+* Select the country setting `mainland China` via Profile/Settings/Country .
+* Setup an Account with `Sign in`
+* After successfully logging in add a device via `+`
+* Choose `MI Control Hub` under `Household security` and follow the instructions 
+* After successfully integration of the Gateway in Mi Home tip the 3 dots at the top  
+right of the screen and click `About`* 
+* There should be now more extra options listed until the developer mode is enabled.   
+[ if not try all steps again!]
+* Choose the option No. 4
+* Then tap the first toggle switch to enable LAN functions. Note down the password.
+> Password is required later in the yunkong2 installation.
+* Make sure to hit the OK button to save changes.
+* If you change here something, you lose your password!
+
+Now further devices can be trained via the `+` sign.
+
+## Router Setup
+The Gateway IP address can be determined within the text after _localip_ under About/Hub  
+info. In the used router used, this IP should be assigned fix to the gateway.  
+If the operation of the learned devices via the App is no longer wanted, after learning  
+all devices the Internet access of the gateway can be switched off in the router.
+
+### Supported devices
+The following list does not claim to be complete:
+* gateway *           Xiaomi RGB Gateway
+* sensor_ht *         Xiaomi Temperature/Humidity
+* weather.v1 *        Xiaomi Temperature/Humidity/Pressure
+* switch *            Xiaomi Wireless Switch
+* sensor_switch.aq2 * Xiaomi Aqara Wireless Switch Sensor
+* sensor_switch.aq3 * Xiaomi Aqara Wireless Switch Sensor
+* plug *              Xiaomi Smart Plug
+* 86plug *            Xiaomi Smart Wall Plug
+* 86sw2 *             Xiaomi Wireless Dual Wall Switch
+* 86sw1 *             Xiaomi Wireless Single Wall Switch
+* natgas *            Xiaomi Mijia Honeywell Gas Alarm Detector
+* smoke *             Xiaomi Mijia Honeywell Fire Alarm Detector
+* ctrl_ln1 *          Xiaomi Aqara 86 Fire Wall Switch One Button
+* ctrl_ln1.aq1 *      Xiaomi Aqara Wall Switch LN
+* ctrl_ln2 *          Xiaomi 86 zero fire wall switch double key
+* ctrl_ln2.aq1 *      Xiaomi Aqara Wall Switch LN double key
+* ctrl_neutral2 *     Xiaomi Wired Dual Wall Switch
+* ctrl_neutral1 *     Xiaomi Wired Single Wall Switch
+* cube *              Xiaomi Cube
+* sensor_cube.aqgl01 * Xiaomi Cube
+* magnet *            Xiaomi Door Sensor
+* sensor_magnet.aq2 * Xiaomi Aqara Door Sensor
+* curtain *           Xiaomi Aqara Smart Curtain
+* motion *            Xiaomi Motion Sensor
+* sensor_motion.aq2 * Xiaomi Aqara Motion Sensor
+* sensor_wleak.aq1 *  Xiaomi Aqara water sensor
+* ctrl_ln2.aq1 *      Xiaomi Aqara Wall Switch LN (Double)
+* remote.b286acn01 *  Xiaomi Aqara Wireless Remote Switch (Double Rocker)
+* remote.b1acn01 *    Xiaomi Aqara Wireless Remote Switch
+* vibration *         Xiaomi vibration Sensor
+* wleak1 *            Xiaomi Aqara Water Sensor
+* lock_aq1 *          Xiaomi Lock
+
+## yunkong2 Mi Home Adapter installation
+Further settings are only made via the yunkong2 Admin * interface.  
+Find the adapter in the `Adapter` area and install it using the `+` sign. 
+
+![Logo](media/Adapter.png)
+
+The following configuration window then opens:
+
+![Logo](media/Adapterconfig1.PNG)
+
+Enter the password determined above under `Default Gateway Key` and close the window  
+with `save and close`.   
+The current adapter should then be displayed green under `Instances`:
+
+![Logo](media/Instanz.PNG)
+
+Under `Objects` now the gateway and its learned devices are displayed:
+
+![Logo](media/Objekte.PNG)
+
+The manual was created to the best of my knowledge and belief. 
+
+[Android App]:(https://play.google.com/store/apps/details?id=com.xiaomi.smarthome)
+
+[iOS App]:(https://itunes.apple.com/de/app/mi*home*xiaomi*smarthome/id957323480?mt=8)