Merge pull request #854 from onkelandy/join

Join Plugin; user_doc and logo

join/__init__.py

@@ -31,7 +31,7 @@ class Join(SmartPlugin):
     SEND_URL = URL_PREFIX+'messaging/v1/sendPush?apikey='
     LIST_URL = URL_PREFIX+'registration/v1/listDevices?apikey='
 
-    PLUGIN_VERSION = "1.4.3"
+    PLUGIN_VERSION = "1.4.4"
 
 
     def __init__(self, sh):

join/plugin.yaml

@@ -9,10 +9,9 @@ plugin:
     tester: psilo909
     state: ready
     keywords: iot join remote mobile phone command
-    documentation: http://smarthomeng.de/user/plugins_doc/config/join.html        # url of documentation (wiki) page
     support: https://knx-user-forum.de/forum/supportforen/smarthome-py/1113523-neues-plugin-join-tts-sms-phonecall-notification-uvm
 
-    version: 1.4.3                 # Plugin version
+    version: 1.4.4                 # Plugin version
     sh_minversion: 1.4             # minimum shNG version to use this plugin
     #sh_maxversion:                # maximum shNG version to use this plugin (leave empty if latest)
     multi_instance: False          # plugin supports multi instance
@@ -195,4 +194,3 @@ plugin_functions:
                 description:
                     de: "AlarmVolume"
                     en: "AlarmVolume"
-

join/user_doc.rst

@@ -0,0 +1,69 @@
+.. index:: Plugins; join
+.. index:: join
+
+====
+join
+====
+
+.. image:: webif/static/img/plugin_logo.png
+   :alt: plugin logo
+   :width: 300px
+   :height: 300px
+   :scale: 50 %
+   :align: left
+
+Dieses Plugin erlaubt das Senden von Kommandos an das Smartphone mittels
+`Join API <https://joaoapps.com/join/api/>`_
+
+Konfiguration
+=============
+
+.. important::
+
+   Die Informationen zur Konfiguration des Plugins sind unter :doc:``/plugins_doc/config/join`` beschrieben.
+
+plugin.yaml
+-----------
+
+.. code-block:: yaml
+
+   join:
+       plugin_name: join
+       device_id: <your deviceid>
+       api_key: <your apikey>
+
+
+Pluginfunktionen
+================
+
+send()
+------
+
+send(title=None, text=None, icon=None, find=None, smallicon=None, device_id=None, device_ids=None, device_names=None, url=None, image=None, sound=None, group=None, clipboard=None, file=None, callnumber=None, smsnumber=None, smstext=None, mmsfile=None, wallpaper=None, lockWallpaper=None, interruptionFilter=None, mediaVolume=None, ringVolume=None, alarmVolume=None)
+
+Bezüglich einer genauen Beschreibung der einzelnen Variablen ist die Dokumentation zur
+`Join API <https://joaoapps.com/join/api/>`_ heranzuziehen.
+
+get_devices()
+-------------
+
+Gibt ein Array aller Geräte, die für die Join API registriert sind, zurück.
+
+Logikbeispiele
+--------------
+
+.. code-block:: python
+
+   if (sh.your.item() == 1):
+       sh.join.send(smsnumber="0123456789", smstext="Hello World") # Senden einer SMS ans Zielgerät
+
+   if (sh.your.item() == 1):
+       sh.join.send(title="01234567892", text="Hello World") # Schicken einer Benachrichtung ans Mobilgerät
+
+   if (sh.your.item() == 1):
+       sh.join.send(find="true") # Finden von Geräten
+
+Web Interface
+=============
+
+Das Plugin stellt kein Web Interface zur Verfügung.