From 892219eef2046dc46f05dec142ff1f8567d880ce Mon Sep 17 00:00:00 2001
From: jkerdreu <jkerdreu@b32b6428-25c9-4566-ad07-03861ab6144f>
Date: Tue, 16 Jul 2024 11:42:48 +0000
Subject: [PATCH] Fix docs
git-svn-id: https://redmine.imt-atlantique.fr/svn/xaal/code/Python/branches/0.7@3202 b32b6428-25c9-4566-ad07-03861ab6144f
---
devices/protocols/Edisio/README.rst | 72 +++++++++++++------------
devices/protocols/Edisio/pyproject.toml | 12 +++--
2 files changed, 47 insertions(+), 37 deletions(-)
diff --git a/devices/protocols/Edisio/README.rst b/devices/protocols/Edisio/README.rst
index 6f01a21e..71cb1d6f 100644
--- a/devices/protocols/Edisio/README.rst
+++ b/devices/protocols/Edisio/README.rst
@@ -1,39 +1,45 @@
-WARNING
-=======
-Right we only support Edisio wireless switches: https://www.edisio.com/wireless-switches-efcb/
-Edisio doesn't provide docs, protocol example. We try to reverse eng the protocol.
+
+xaal.edisio
+===========
+This is a xAAL package to support Edisio wireless switches.
+WARNING
+-------
+We only support Edisio wireless switches: https://www.edisio.com/wireless-switches-efcb/.
+Edisio doesn't provide docs, protocol example or anything else. We had to figure out stuff by ourselves.
+
Sample outputs
-==============
-AA = Address ?
-BB = Button nb
-CC = Looks like a checksum
-EE = END of Data
-
- AA AA AA AA BB CC EE EE EE
-2018-09-27 15:37:49 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 01 01 1f 01 00 03 64 0d 0a
-2018-09-27 15:37:49 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 01 01 1f 01 00 03 64 0d 0a
-2018-09-27 15:37:49 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 01 01 1f 01 00 03 64 0d 0a
-2018-09-27 15:37:49 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 01 01 1f 01 00 03 64 0d 0a
-2018-09-27 15:37:54 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 03 01 1f 01 00 03 64 0d 0a
-2018-09-27 15:37:54 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 03 01 1f 01 00 03 64 0d 0a
-2018-09-27 15:37:54 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 03 01 1f 01 00 03 64 0d 0a
-2018-09-27 15:37:54 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 03 01 1f 01 00 03 64 0d 0a
-
-2018-09-27 15:38:00 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 01 01 1d 01 00 03 64 0d 0a
-2018-09-27 15:38:00 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 01 01 1d 01 00 03 64 0d 0a
-2018-09-27 15:38:00 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 01 01 1d 01 00 03 64 0d 0a
-2018-09-27 15:38:00 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 01 01 1d 01 00 03 64 0d 0a
-2018-09-27 15:38:09 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 03 01 1b 01 00 03 64 0d 0a
-2018-09-27 15:38:09 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 03 01 1b 01 00 03 64 0d 0a
-2018-09-27 15:38:09 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 03 01 1b 01 00 03 64 0d 0a
-2018-09-27 15:38:09 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 03 01 1b 01 00 03 64 0d 0a
-
-Config
-======
-- Edit ~/.xaal/xaal.edisio.ini according to your needs, mainly change the serial port, by default
+--------------
+
+.. code-block:: bash
+
+ AA = Address ?
+ BB = Button nb
+ CC = Looks like a checksum
+ EE = END of Data
+ AA AA AA AA BB CC EE EE EE
+ 2018-09-27 15:37:49 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 01 01 1f 01 00 03 64 0d 0a
+ 2018-09-27 15:37:49 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 01 01 1f 01 00 03 64 0d 0a
+ 2018-09-27 15:37:49 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 01 01 1f 01 00 03 64 0d 0a
+ 2018-09-27 15:37:49 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 01 01 1f 01 00 03 64 0d 0a
+ 2018-09-27 15:37:54 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 03 01 1f 01 00 03 64 0d 0a
+ 2018-09-27 15:37:54 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 03 01 1f 01 00 03 64 0d 0a
+ 2018-09-27 15:37:54 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 03 01 1f 01 00 03 64 0d 0a
+ 2018-09-27 15:37:54 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 00 74 bc b6 03 01 1f 01 00 03 64 0d 0a
+
+ 2018-09-27 15:38:00 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 01 01 1d 01 00 03 64 0d 0a
+ 2018-09-27 15:38:00 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 01 01 1d 01 00 03 64 0d 0a
+ 2018-09-27 15:38:00 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 01 01 1d 01 00 03 64 0d 0a
+ 2018-09-27 15:38:00 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 01 01 1d 01 00 03 64 0d 0a
+ 2018-09-27 15:38:09 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 03 01 1b 01 00 03 64 0d 0a
+ 2018-09-27 15:38:09 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 03 01 1b 01 00 03 64 0d 0a
+ 2018-09-27 15:38:09 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 03 01 1b 01 00 03 64 0d 0a
+ 2018-09-27 15:38:09 i7 xaal.edisio[18674] DEBUG [16] 6c 76 63 06 73 74 2b 03 01 1b 01 00 03 64 0d 0a
+
+Usage
+------
+- Edit *edisio.ini* according to your needs, mainly change the serial port, by default
everything else should be Ok.
-
diff --git a/devices/protocols/Edisio/pyproject.toml b/devices/protocols/Edisio/pyproject.toml
index d0376d79..f8661690 100644
--- a/devices/protocols/Edisio/pyproject.toml
+++ b/devices/protocols/Edisio/pyproject.toml
@@ -3,10 +3,14 @@ name = "xaal.edisio"
version = "0.1"
description = "xAAL gateway for Edisio devices"
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", "edisio"]
dependencies = ["xaal.lib", "gevent", "pyserial"]
--
GitLab