From c324ec46d5faa4b63036eef70c1f8ffd0b28e8d8 Mon Sep 17 00:00:00 2001 From: Onkel Andy Date: Sat, 30 Dec 2023 00:04:49 +0100 Subject: [PATCH] neato plugin: fix and improve docu --- neato/user_doc.rst | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/neato/user_doc.rst b/neato/user_doc.rst index 2871982fb..dbe11f7e8 100755 --- a/neato/user_doc.rst +++ b/neato/user_doc.rst @@ -21,7 +21,8 @@ Die Informationen zur Konfiguration des Plugins sind unter :doc:`/plugins_doc/co Anforderungen ============= -1) Es muss auf dem SmarthomeNG Rechner en_US.utf8 installiert sein (sudo dpkg-reconfigure locales) + +Es muss auf dem SmarthomeNG Rechner en_US.utf8 installiert sein (sudo dpkg-reconfigure locales) Unterstützte Hardware ===================== @@ -40,11 +41,12 @@ Vorwerk VR300 ja ja Authentifizierung ================= -Das Plugin unterstützt zwei verschiedene Arten der Authentifizierung mit dem Neato oder Vorwerk Backend: +Das Plugin unterstützt zwei verschiedene Arten der Authentifizierung mit dem Neato oder Vorwerk Backend: a) Authentifizierung über Emailadresse des Nutzerkontos und zugehöriges Passwort. Nutzbar für Neato und alte Vorwerk API .. code-block:: html + Neato: plugin_name: neato account_email: 'your_neato_account_email' @@ -64,18 +66,18 @@ b) Oauth2 Authentifizierung über Emailadresse des Nutzerkontos und Token. Nutzb Der Token kann hier kompfortabel über die Schritt für Schritt Anleitung des Plugin Webinterfaces generiert werden, siehe Vorwerk OAuth2 Tab. Wenn eine Nutzung des Webinterfaces nicht möglich ist, kann ein Token auch manuell generiert werden. Hierzu: - -a) Neato plugin aktivieren und Emailadresse des Vorwerk Nutzerkontos konfigurieren. + +a) Neato plugin aktivieren und Emailadresse des Vorwerk Nutzerkontos konfigurieren. b) Plugin Logging auf Level INFO stellen (in logger.yaml oder via Admin Interface) -c) Plugin Funktion request_oauth2_code ausführen. Hierbei wird ein Code bei Vorwerk angefragt, welcher an die oben angegebene Emaildresse gesendet wird. +c) Plugin Funktion request_oauth2_code ausführen. Hierbei wird ein Code bei Vorwerk angefragt, welcher an die oben angegebene Emaildresse gesendet wird. -d) Nach Erhalt des Codes die Plugin Funktion request_oauth2_token(code) ausführen, wobei als Argument der per Email erhaltene Code übergeben wird. +d) Nach Erhalt des Codes die Plugin Funktion request_oauth2_token(code) ausführen, wobei als Argument der per Email erhaltene Code übergeben wird. e) Im Logfile nach dem generierten ASCII Token im Hexadezimalformat suchen -f) Das Hex ASCII Token in der plugin.yaml angeben. +f) Das Hex ASCII Token in der plugin.yaml angeben. @@ -107,13 +109,13 @@ Roboter Status Das String Item für den Roboterstatus (state) kann folgende Zustände einnehmen: ======================= ==== -Roboterstatus (state) +Roboterstatus (state) ======================= ==== -invalid -idle -busy -paused -error +invalid +idle +busy +paused +error ======================= ==== @@ -148,7 +150,7 @@ Das Num Item für die Roboterbefehle (command) kann folgende Zustände einnehmen ============================= ========= Befehl (command) dezimal ============================= ========= -Start cleaning 61 +Start cleaning 61 Stop cleaning 62 Pause cleaning 63 Resume cleaning 64 @@ -229,4 +231,3 @@ Beispiele für Integrationen in smartVisu:

Battery status: {{ basic.value('RobotBatteryState', 'Neato.Robot.ChargePercentage') }}

/** Get the robots battery charge status (num) */ -