From 1ee68d6c0749b15143d08d67e5dbcd004921bfe2 Mon Sep 17 00:00:00 2001
From: jkerdreu <jkerdreu@b32b6428-25c9-4566-ad07-03861ab6144f>
Date: Tue, 16 Jul 2024 11:27:36 +0000
Subject: [PATCH] Fix some docs
git-svn-id: https://redmine.imt-atlantique.fr/svn/xaal/code/Python/branches/0.7@3200 b32b6428-25c9-4566-ad07-03861ab6144f
---
devices/protocols/Aqara/README.rst | 17 +++++++++--------
devices/protocols/Aqara/pyproject.toml | 12 ++++++++----
2 files changed, 17 insertions(+), 12 deletions(-)
diff --git a/devices/protocols/Aqara/README.rst b/devices/protocols/Aqara/README.rst
index 5fd80c7b..4aaccf4a 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 d4dca5d1..633013cb 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"]
--
GitLab