Skip to content

Commit

Permalink
Deploying to gh-pages from @ smarthomeNG/plugins@879b421 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
msinn committed Jan 15, 2024
1 parent c69bbbf commit e636b61
Show file tree
Hide file tree
Showing 6 changed files with 193 additions and 26 deletions.
31 changes: 16 additions & 15 deletions _sources/plugins/neato/user_doc.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,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
.. code-block:: yaml
Neato:
plugin_name: neato
account_email: 'your_neato_account_email'
Expand All @@ -53,7 +54,7 @@ a) Authentifizierung über Emailadresse des Nutzerkontos und zugehöriges Passwo
b) Oauth2 Authentifizierung über Emailadresse des Nutzerkontos und Token. Nutzbar nur für Vorwerk mit dem aktuellen MyKobol APP Interface

.. code-block:: html
.. code-block:: yaml
Neato:
plugin_name: neato
Expand All @@ -64,18 +65,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 @@ -107,13 +108,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 @@ -148,7 +149,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
11 changes: 7 additions & 4 deletions _sources/plugins/roombapysh/user_doc.rst.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. index:: Plugins; roombapysh
.. index:: roombapysh

======
======================
Roomba für SmartHomeNG
======
======================

Dieses Plugin ermöglicht die Einbindung von iRobot Roomba Staubsaugrobotern.
Das Plugin basiert auf https://github.com/pschmitt/roombapy (ein Fork von https://github.com/NickWaterton/Roomba980-Python) für die Kommunikation.
Expand Down Expand Up @@ -53,7 +53,8 @@ Installation

Vor der Inbetriebnahme des Plugins bitte paho-mqtt und orjson installieren.

.. code-block::
.. code-block:: bash
pip3 install paho-mqtt
pip3 install orjson
Expand All @@ -76,6 +77,7 @@ Hier ein Beispiel einer vollständigen Konfiguration von Items.
Die Datei liegt auch im Plugin-Verzeichnis (Harry.yaml).

.. code-block:: yaml
# Harry.yaml
Harry:
connect:
Expand Down Expand Up @@ -245,7 +247,8 @@ Beispiele

Beispiel, wie in der smartVisu der Status des Roomba als Icon angezeigt werden kann:

.. code-block:: yaml
.. code-block:: jinja
{{ basic.symbol('', ['Harry.Status'], '', ['scene_robo_vac_cleaner.svg','text_question_mark.svg','scene_robo_vac_cleaner_charging.svg','scene_robo_vac_cleaner_charging.svg','scene_robo_vac_cleaner_active.svg','scene_robo_vac_cleaner_paused.svg','scene_robo_vac_cleaner_dock.svg','scene_robo_vac_cleaner_attention.svg'], [0,1,2,3,4,5,6,7], '', ['#766','#f00','#ff0','#0f0','#0f0','#ff0','#0f0','#f00'],'','','midi') }}
Ein Beispiel, wie eine komplette smartVisu Seite aussehen könnte liegt als roomba.html im Plugin-Verzeichnis
Expand Down
2 changes: 1 addition & 1 deletion entwicklung/core/core_shng.html
Original file line number Diff line number Diff line change
Expand Up @@ -5491,7 +5491,7 @@ <h2>smarthome.py<a class="headerlink" href="#smarthome-py" title="Permalink to t
the main oject, which is an instance of this class. Mostly it is referred to as <code class="docutils literal notranslate"><span class="pre">sh</span></code>, <code class="docutils literal notranslate"><span class="pre">_sh</span></code> or <code class="docutils literal notranslate"><span class="pre">smarthome</span></code>.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="lib.smarthome.SmartHome.BASE">
<span class="sig-name descname"><span class="pre">BASE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/home/runner/work/smarthome/smarthome/smarthomeng'</span></em><a class="headerlink" href="#lib.smarthome.SmartHome.BASE" title="Link zu dieser Definition"></a></dt>
<span class="sig-name descname"><span class="pre">BASE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/home/runner/work/plugins/plugins/smarthomeng'</span></em><a class="headerlink" href="#lib.smarthome.SmartHome.BASE" title="Link zu dieser Definition"></a></dt>
<dd></dd></dl>

<dl class="py method">
Expand Down
17 changes: 12 additions & 5 deletions plugins/neato/user_doc.html
Original file line number Diff line number Diff line change
Expand Up @@ -5532,14 +5532,21 @@ <h2>Authentifizierung<a class="headerlink" href="#authentifizierung" title="Perm
<ol class="loweralpha simple">
<li><p>Authentifizierung über Emailadresse des Nutzerkontos und zugehöriges Passwort. Nutzbar für Neato und alte Vorwerk API</p></li>
</ol>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">Neato</span><span class="p">:</span>
<span class="w"> </span><span class="nt">plugin_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">neato</span>
<span class="w"> </span><span class="nt">account_email</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;your_neato_account_email&#39;</span>
<span class="w"> </span><span class="nt">account_pass</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;your_neato_account_password!&#39;</span>
<span class="w"> </span><span class="nt">robot_vendor</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;neato</span><span class="nv"> </span><span class="s">or</span><span class="nv"> </span><span class="s">vorwerk&#39;</span>
</pre></div>
</div>
<ol class="loweralpha simple" start="2">
<li><p>Oauth2 Authentifizierung über Emailadresse des Nutzerkontos und Token. Nutzbar nur für Vorwerk mit dem aktuellen MyKobol APP Interface</p></li>
</ol>
<div class="highlight-html notranslate"><div class="highlight"><pre><span></span>Neato:
plugin_name: neato
account_email: &#39;your_neato_account_email&#39;
token: &#39;HEX_ASCII_TOKEN&#39;
robot_vendor: &#39;vorwerk&#39;
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">Neato</span><span class="p">:</span>
<span class="w"> </span><span class="nt">plugin_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">neato</span>
<span class="w"> </span><span class="nt">account_email</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;your_neato_account_email&#39;</span>
<span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;HEX_ASCII_TOKEN&#39;</span>
<span class="w"> </span><span class="nt">robot_vendor</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;vorwerk&#39;</span>
</pre></div>
</div>
<p>Der Token kann hier kompfortabel über die Schritt für Schritt Anleitung des Plugin Webinterfaces generiert werden, siehe Vorwerk OAuth2 Tab.</p>
Expand Down
Loading

0 comments on commit e636b61

Please sign in to comment.