Skip to content

Commit

Permalink
Revert "neato plugin: fix and improve docu"
Browse files Browse the repository at this point in the history
This reverts commit c324ec4.
  • Loading branch information
onkelandy committed Dec 29, 2023
1 parent c324ec4 commit fd4931c
Showing 1 changed file with 15 additions and 16 deletions.
31 changes: 15 additions & 16 deletions neato/user_doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ Die Informationen zur Konfiguration des Plugins sind unter :doc:`/plugins_doc/co

Anforderungen
=============

Es muss auf dem SmarthomeNG Rechner en_US.utf8 installiert sein (sudo dpkg-reconfigure locales)
1) Es muss auf dem SmarthomeNG Rechner en_US.utf8 installiert sein (sudo dpkg-reconfigure locales)

Unterstützte Hardware
=====================
Expand All @@ -41,12 +40,11 @@ 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'
Expand All @@ -66,18 +64,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.



Expand Down Expand Up @@ -109,13 +107,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
======================= ====


Expand Down Expand Up @@ -150,7 +148,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
Expand Down Expand Up @@ -231,3 +229,4 @@ Beispiele für Integrationen in smartVisu:

<p>Battery status: {{ basic.value('RobotBatteryState', 'Neato.Robot.ChargePercentage') }}</p>
/** Get the robots battery charge status (num) */

0 comments on commit fd4931c

Please sign in to comment.