diff --git a/roombapysh/user_doc.rst b/roombapysh/user_doc.rst index fa27a88d2..e440c4d7c 100644 --- a/roombapysh/user_doc.rst +++ b/roombapysh/user_doc.rst @@ -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. @@ -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 @@ -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: @@ -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