diff --git a/devices/protocols/Aqara/README.rst b/devices/protocols/Aqara/README.rst index 5fd80c7b2efae79e1dc8d7eee95b1669cd7a634e..4aaccf4a9d9775368d682ae4f1f5adf8f90c45e6 100644 --- a/devices/protocols/Aqara/README.rst +++ b/devices/protocols/Aqara/README.rst @@ -1,12 +1,15 @@ -xAAL Aqara Gateway -================== + +xaal.aqara +========== +This is a xAAL gateway for the Aqara Gateway (hub) from Xiaomi. +The gateway is able to discover and control most Aqara devices. + Install & Config ---------------- -- Install with python setup.py develop or install. - Enable local network on the Aqara Gateway with the Mi Home - Android or iOS app. You can follow this manual: + Android or iOS app. You can follow this manual: https://www.domoticz.com/wiki/Xiaomi_Gateway_(Aqara) store the secret key somewhere. - Run the xAAL gateway with: python -m xaal.aqara. The gateway @@ -14,13 +17,13 @@ Install & Config - To enable quick discovery and control devices (switches, leds..) edit the config file ~/.xaal/xaal.aqara.ini and add the key like this: - + [devices] [[xxxxxxxxxxxx]] base_addr = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx model = gateway secret = ydt5xis45x7k5x1x - + Notes ----- @@ -28,5 +31,3 @@ Notes network make sure to set a secret key to each hub. - xAAL gateway supports most Aqara devices, feel free to edit (and submit) xaal/aqara/devices.py if you own a unsupported device. - - diff --git a/devices/protocols/Aqara/pyproject.toml b/devices/protocols/Aqara/pyproject.toml index d4dca5d19f7c84f4b05603157acbfe34b6985389..633013cb7859baac1f658f911f446a2cbf5960f9 100644 --- a/devices/protocols/Aqara/pyproject.toml +++ b/devices/protocols/Aqara/pyproject.toml @@ -3,10 +3,14 @@ name = "xaal.aqara" version = "0.1" description = "xAAL devices for Xiaomi / Aqara" readme = "README.rst" -authors = [ { name = "Jerome Kerdreux", email = "Jerome.Kerdreux@imt-atlantique.fr" } ] -license = { text = "GPL License"} -classifiers = ["Programming Language :: Python", -"Topic :: Software Development :: Libraries :: Python Modules"] +authors = [ + { name = "Jerome Kerdreux", email = "Jerome.Kerdreux@imt-atlantique.fr" }, +] +license = { text = "GPL License" } +classifiers = [ + "Programming Language :: Python", + "Topic :: Software Development :: Libraries :: Python Modules", +] keywords = ["xaal", "aqara"] dependencies = ["xaal.lib", "gevent", "pycryptodomex"]