Skip to content

Commit

Permalink
Merge branch 'develop' of https://github.com/smarthomeNG/plugins into…
Browse files Browse the repository at this point in the history
… develop
  • Loading branch information
psilo909 committed Sep 15, 2023
2 parents 278e809 + fa68353 commit d2ce07d
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 23 deletions.
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ ehthumbs.db
Thumbs.db

# don't upload private plugins
/priv_*
/priv_*/

# don't upload plugins loaded from develop to a release installation
/*_dev/

# Pycharm settings
/.idea
Expand Down
41 changes: 41 additions & 0 deletions neato/user_doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,47 @@ Neato Botvac D7 ja nein
Vorwerk VR300 ja ja
=============== ============= ==========

Authentifizierung
=================

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'
account_pass: 'your_neato_account_password!'
robot_vendor: 'neato or vorwerk'

b) Oauth2 Authentifizierung über Emailadresse des Nutzerkontos und Token. Nutzbar nur für Vorwerk mit dem aktuellen MyKobol APP Interface

.. code-block:: html

Neato:
plugin_name: neato
account_email: 'your_neato_account_email'
token: 'HEX_ASCII_TOKEN'
robot_vendor: 'vorwerk'

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.

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.

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.



Unterstützte Plugin Attribute
=============================
Expand Down
22 changes: 0 additions & 22 deletions sonos/plugin.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -85,28 +85,6 @@ parameters:
de: "(optional) Verlängert die Dauer von Snippet Audio Dateien um einen festen Offset in Sekunden."
en: "(optional) Extend snippet duration by a fixed offset specified in seconds"

webif_pagelength:
type: int
default: 0
valid_list:
- -1
- 0
- 25
- 50
- 100
description:
de: 'Anzahl an Items, die standardmäßig in einer Web Interface Tabelle pro Seite angezeigt werden.
0 = automatisch, -1 = alle'
en: 'Amount of items being listed in a web interface table per page by default.
0 = automatic, -1 = all'
description_long:
de: 'Anzahl an Items, die standardmäßig in einer Web Interface Tabelle pro Seite angezeigt werden.\n
Bei 0 wird die Tabelle automatisch an die Höhe des Browserfensters angepasst.\n
Bei -1 werden alle Tabelleneinträge auf einer Seite angezeigt.'
en: 'Amount of items being listed in a web interface table per page by default.\n
0 adjusts the table height automatically based on the height of the browser windows.\n
-1 shows all table entries on one page.'

item_attributes:
sonos_uid:
type: str
Expand Down

0 comments on commit d2ce07d

Please sign in to comment.