SymconJSLive

SymconJSLive Splitter

Splitter für alle JSLive Module

Dokumentation

Inhaltsverzeichnis

1. Funktionsumfang
2. Voraussetzungen
3. Installation
4. Hinweise zur Verwendung
5. Einrichten
6. PHP-Befehlsreferenz
7. Parameter / Modul-Infos
8. Datenaustausch
9. Anhang
10. Lizenz

1. Funktionsumfang

Dieses Modul dient als Schnittstelle zwischen den JSLive Modulen und der Webhook Instance

2. Voraussetzungen

• IPS ab Version 5.3

3. Installation

Die installation des Module ist über den Symcon Modulstore kostenlos möglich

4. Hinweise zur Verwendung

###Daten-Modus ####Websocket (Empfohlen)

• Bei diesen Modus baut der Client über den Webhook und Splitter eine Verbindung zum jeweiligen Modul auf. Dabei werden nur Daten bei Veränderung von werden an den Client mitgeteilt.

####Interval

• Ist Interval aktiv, fragt der Client über die API des JSLive Moduls im unter "Abfrage-Zeit" angegebenen Interval ab. Achtung dieser Modus sorgt für einen erhöhten Datentransfer, und belastet bei Verwendung den Connect-Dienst.

5. Einrichten und Aktionen

Der JSLive-Splitter kann auch ohne Konfiguration verwendet werden, aus Sicherheitsgründen sollte aber ein Passwort verwendet werden. Dieses schützt, vor unbefugten zugriff Dritter!

Connect Adresse laden

• Lädt die Adresse vom Connect Modul

Benutzerdefiniert Vorlagen laden

• Dient zum exportieren der Vorlagen, diese können im Anschluss angepasst und einzelnen Modulen unter Expert => Vorlagen-Skript zugewiesen werden.
• Zum exportieren ist die angabe einer Kategorie nötig(Die Stammkategorie ist nicht zulässig!)

6. PHP-Befehlsreferenz

Keine PHP-Befehlsreferenz nötig

7. Parameter / Modul-Infos

GUID des Modules (z.B. wenn Instanz per PHP angelegt werden soll):

Instanz	GUID
Splitter	{9FFF3FC0-FD51-C289-FA36-BC1C370946CF}

Allgemeine Einstellungen

Eigenschaft	Typ	Standardwert	Info
Passwort	string		Password für den Webhook-Zugriff
Adresse	string	http://127.0.0.1:3777	Webadresse des IP-Symcon Servers
Daten Modus	string	Websocket	Beschreibung unter 4. Hinweise zur Verwendung
Interval Abfrage-Zeit	int	3	in Sekunden

Viewport Einstellungen

Eigenschaft	Typ	Standardwert	Info
Aktivieren	bool	true	Damit Engräte die Ausgabe der Module automatisch skalieren können
Content	string	width=device-width, initial-scale=1, maximum-scale=1.0, minimum-scale=1, user-scalable=no	Html-Parameter der Viewport Configuratzion

Expert Einstellungen

Eigenschaft	Typ	Standardwert	Info
Debug	bool	false	Dienst zur erweiterten Ausgabe in Symcon
Verwende Cache	bool	true	Aktiviert den Cache-Support des Browsers
Verwende Kompression	bool	true	Aktiviert die GZip Kompression und verringert den Datenverbrauch
Frame benutzt den vollen Link als Quelle	bool	false	Bei Aktivierung werden alle Iframes auf einen Absoluten Pfad umgestellt.(Bei Verwendung von Aio-Neo nötig!)

8. Datenaustausch

folgt später...

9. Anhang

10. Lizenz

IPS-Modul:
GNU GENERAL PUBLIC LICENSE