Suche

    Twinkly – Geräte

    Dokumentation direkt aus GitHub Wilkware/Twinkly ↗

    Version Product Version License Actions

    Ermöglicht die Kommunikation mit den Smart LED-Leuchten Twinkly.

    1. Funktionsumfang

    • Schalten des LED-Betriebsmodus (+ extended mode)
    • Einstellen der Farbe, Helligkeit, Sättigung, Effekt und Film
    • Auslesen aller Geräte- und Netwerkinformationen
    • Auslesen der Firmware Version
    • Änderung des Gerätenamens

    2. Voraussetzungen

    • Symcon ab Version 8.1

    3. Installation

    • Über den Modul Store die Bibliothek Twinkly installieren.
    • Alternativ über das Modul Control folgende URL hinzufügen.
      https://github.com/Wilkware/Twinkly oder git://github.com/Wilkware/Twinkly.git

    4. Einrichtung

    • Unter ‘Instanz hinzufügen’ ist das Twinkly Gerät-Modul (Alias: Twinkly Lichterkette, Smarte LED Lichterkette) unter dem Hersteller ‘Ledworks’ aufgeführt.

    Konfigurationsseite:

    Einstellungsbereich:

    💡 Gerät …

    NameBeschreibung
    IP-AdresseNetzwerkadresse der Lichterkette
    AktualisierungsintervallIntervall in Sekunden, in dem die Statusvariablen mit dem Gerät abgeglichen werden (0 = aus, Standard). Empfehlung: während der Saison z.B. 60 Sekunden einstellen. Ist das Gerät nicht erreichbar, zeigt die Instanz den Status „Gerät nicht erreichbar!“.
    Abgleich pausieren nachIst das Gerät so viele Tage nicht erreichbar (z.B. außerhalb der Saison), wird nur noch stündlich geprüft und die Instanz zeigt „Abgleich pausiert“ (Standby). Sobald das Gerät wieder antwortet, ein Befehl erfolgreich war oder die Konfiguration übernommen wird, gilt wieder das normale Intervall (0 = nie pausieren, Standard 3).

    ⏰ Zeitschaltung …

    NameBeschreibung
    Aus/EinZeitschaltung/Timer aktivieren bzw. deaktivieren.
    EinschaltenTägliche Einschaltzeit.
    AusschaltenTägliche Ausschaltzeit.
    JETZTTrägt die aktuelle Uhrzeit als Start- oder Endezeit ein

    ⚙️ Erweiterte Einstellungen …

    NameBeschreibung
    Aktivieren des erweiterten ModusDarüber können zusätzliche (ungetestete) LED Betriebsmodi freigeschalten werden (Musik Reaktiv, Wiedergabeliste & Echtzeit)!

    Aktionsbereich:

    🛠️ Gerätefunktionen …

    AktionBeschreibung
    HELLIGKEITÜber die Schaltflächen kann die aktuelle Helligkeit synchronisiert werden (z.B. wenn von App geändert wurde).
    SÄTTIGUNGÜber die Schaltflächen kann die aktuelle Sättigung synchronisiert werden (z.B. wenn von App geändert wurde).
    FARBEÜber die Schaltflächen kann die aktuelle Farbe synchronisiert werden (z.B. wenn von App geändert wurde).
    EFFEKTÜber die Schaltflächen kann der aktuelle Effekt synchronisiert werden.
    FILM(E)Über die Schaltflächen kann der aktuelle Film und alle hinterlegten Filme synchronisiert werden.
    GERÄTEINFOSÜber die Schaltflächen können die verschiedensten gerätespezifischen Einstellungen abgerufen werden.
    FIRMWAREÜber die Schaltflächen kann die Version des Gerätes ausgelesen und angezeigt werden.
    NETZWERKSTATUSÜber die Schaltflächen können die hinterlegten Netzwerkeinstellungen angezeigt werden.
    Neuer GerätenamenZeigt den aktuellen (nach dem Öffnen des Formulares) Namen an bzw. kann in einen neuen Namen geändert werden.
    ÄNDERNSetzt den Gerätenamen (Alias) neu.

    5. Statusvariablen

    Die Statusvariablen werden automatisch angelegt. Das Löschen einzelner kann zu Fehlfunktionen führen. Werte werden nur übernommen, wenn das Gerät den Befehl bestätigt hat; Änderungen über die App oder den Geräte-Timer werden im Aktualisierungsintervall übernommen.

    IdentNameTypBeschreibung
    SwitchSchalterBooleanEin- bzw. Ausschalten der Lichterkette
    ModeModusIntegerLED-Betriebsmodus
    ColorFarbeIntegerFarbwert
    EffectEffektIntegerAuswahl des vordefinierten Effekts
    MovieFilmStringFilmauswahl über die eindeutige Film-ID (abhängig von den in der App hinterlegten Filmen/Effekten)
    BrightnessHelligkeitIntegerHelligkeitswert
    SaturationSättigungIntegerSättigungswert

    6. Darstellungen

    Die Darstellungen werden direkt an den Statusvariablen hinterlegt, es werden keine Profile angelegt.

    VariableDarstellungWerte
    SchalterSchalterAn / Aus
    ModusAufzählungFarbe, Effekt, Film, Demo (erweiterter Modus zusätzlich: Musik Reaktiv, Wiedergabeliste, Echtzeit)
    FarbeFarbeFarbauswahl mit 6 Farbvorgaben
    EffektAufzählungEffekt 1 – n (Anzahl wird vom Gerät gelesen, Standard 5)
    FilmAufzählungAm Gerät hinterlegte Filme (gleichnamige Filme mit angehängter Geräte-ID, z.B. “Rainbow (1)”; ohne Filme: Keine Filme)
    HelligkeitSchieberegler0 – 100 % (Schrittweite 1)
    SättigungSchieberegler0 – 100 % (Schrittweite 1)

    7. Visualisierung

    Die Instanz kann direkt in der Kachel-Visualisierung verwendet werden, die Statusvariablen werden über ihre Darstellungen bedient. Alternativ können die Variablen einzeln verlinkt werden.

    8. Befehlsreferenz

    string TWINKLY_Color(int $InstanzID);
    

    Liest den aktuell am Gerät eingestelten Farbwert aus und synchronisert ihn mit der dazugehörigen Statusvariable.
    Die Funktion liefert als Rückgabewert einen String (Farbe: #RRGGBB (<Integer-Wert>)).

    Beispiel: TWINKLY_Color(12345); Ausgabe “Farbe: #FFA500 (16753920)”.

    string TWINKLY_Effect(int $InstanzID);
    

    Liest den aktuell am Gerät hinterlegten Effekt aus und synchronisert ihn mit der dazugehörigen Statusvariable.
    Die Funktion liefert als Rückgabewert einen String (Aktueller Effekt: x).

    Beispiel: TWINKLY_Effect(12345); Ausgabe “Aktueller Effekt: 1”.

    string TWINKLY_Movie(int $InstanzID);
    

    Liest den aktuell am Gerät hinterlegten Film und und alle hinterlegten Filme aus und synchronisert ihn mit der dazugehörigen Statusvariable.
    Die Funktion liefert als Rückgabewert einen String mit dem aktuellen Film und der Anzahl der verfügbaren Filme.

    Beispiel: TWINKLY_Movie(12345); Ausgabe “Aktueller Film: Rainbow” und “Verfügbare Filme: 1”.

    string TWINKLY_Brightness(int $InstanzID);
    

    Liest den aktuell am Gerät hinterlegten Helligkeitswert aus und synchronisert ihn mit der dazugehörigen Statusvariable.
    Die Funktion liefert als Rückgabewert einen String (Helligkeit: xy%).

    Beispiel: TWINKLY_Brightness(12345); Ausgabe “Helligkeit: 100%”.

    string TWINKLY_Saturation(int $InstanzID);
    

    Liest de aktuell am Gerät hinterlegten Sättigungswert aus und synchronisert ihn mit der dazugehörigen Statusvariable.
    Die Funktion liefert als Rückgabewert einen String (Sättigung: xy%).

    Beispiel: TWINKLY_Saturation(12345); Ausgabe “Sättigung: 100%”.

    string TWINKLY_Gestalt(int $InstanzID);
    

    Liest alle Geräteinformationen aus.
    Die Funktion liefert als Rückgabewert einen (sprintf) formatierten String.

    Beispiel: TWINKLY_Gestalt(12345);

    Produktname: Twinkly
    Hardware-Version: 100
    Bytes pro LED: 3
    Hardware-ID: ab01cd
    Flash-Größe: 64
    LED-Typ: 14
    Produktcode: TWS250STP-B
    Firmware-Familie: F
    Gerätename: Weihnachtsbaum
    Laufzeit: 239317051
    MAC: 12:34:56:ba:dc:fe
    UUID: 12345678-bacd-1234-abcd-1234567890ab
    Max. unterstützte LEDs: 1020
    Anzahl LEDs: 250
    LED-Profil: RGB
    Bildrate: 24
    Gemessene Bildrate: 23,810000
    Filmkapazität: 992
    Copyright: LEDWORKS 2018

    string TWINKLY_Version(int $InstanzID);
    

    Liest die installierte Firmwareversion des Gerätes aus.
    Die Funktion liefert als Rückgabewert einen String (Firmware: x.yy.zz).

    Beispiel: TWINKLY_Version(12345); Ausgabe “Firmware: 2.4.16”.

    string TWINKLY_Network(int $InstanzID);
    

    Liest die eingestellten Netzwerkinformationen aus. Die Funktion liefert als Rückgabewert einen (sprintf) formatierten String.

    Beispiel: TWINKLY_Network(12345);

    Network mode: 1 (Station)
    Station:
    SSID: ssid
    IP: 192.168.1.9
    Gateway: 192.168.1.1
    Mask: 255.255.255.0
    RSSI: -54 db
    Access Point:
    SSID: Twinkly_DE99EF
    IP: 192.168.4.1
    Channel: 1
    Encryption: NONE
    SSID Hidden: false
    Max connections: 4

    string TWINKLY_DeviceName(int $InstanzID, string $NewName);
    

    Setzt den Gerätenamen (Alias) neu.
    Die Funktion liefert als Rückgabewert einen String (Erfolgsmeldung).

    Beispiel: TWINKLY_DeviceName(12345, 'Lichterkette'); Ausgabe “Der Name wurde erfolgreich geändert!”.

    9. Versionshistorie

    v4.0.20261102

    • NEU: Kompatibilität auf Symcon 8.1 hochgesetzt
    • NEU: Automatischer Statusabgleich mit dem Gerät (Aktualisierungsintervall), inkl. Pausierung bei längerer Nichterreichbarkeit
    • NEU: Film als Aufzählung über die eindeutige Film-ID (Achtung: die Variable Film wird neu angelegt, Verknüpfungen müssen erneuert werden)
    • NEU: Effekt als Aufzählung, Anzahl der Effekte wird vom Gerät gelesen
    • NEU: Neue Instanzstatus (keine IP-Adresse, Gerät nicht erreichbar, Abgleich pausiert)
    • NEU: Darstellungen überarbeitet (neue Icons)
    • NEU: Konfigurationsformular auf Standardlayout umgestellt (inkl. Versionsanzeige)
    • FIX: Erweiterter Modus wurde nicht übernommen
    • FIX: Werte werden erst nach Bestätigung durch das Gerät übernommen
    • FIX: Zeitschaltung wird nur noch bei geänderten Einstellungen übertragen
    • FIX: Zeitbegrenzung der Gerätezugriffe und Wiederverwendung des Login-Tokens
    • FIX: Übersetzungen und Dokumentation überarbeitet

    v3.2.20240222

    • NEU: Anpassungen für IPS 7.x (Konfigurator & TileVisu)
    • NEU: Schaltervariable migriert auf Boolean
    • FIX: Übersetzungen nachgezogen
    • FIX: Interne Bibliotheken überarbeitet

    v3.1.20231127

    • NEU: Steuerung der Film(effekte) hinzugefügt
    • NEU: Synchronisation der Statusvariablen erweitert (dynamisches Film-Profil)
    • NEU: Twinkly-API erweitert
    • NEU: Kompatibilität auf IPS 6.4 hoch gesetzt
    • FIX: Interne Bibliotheken überarbeitet
    • FIX: PHP Syle Check korrigiert
    • FIX: Dokumentation überarbeitet

    v3.0.20221201

    • NEU: Trennung von Ein/Aus-Schaltung und Änderung des Betriebsmodus
    • NEU: Betriebsmodus “Farbe” und “Effekt” konfigurierbar hinzugefügt
    • NEU: Steuerung der Sättigung hinzugefügt
    • NEU: Synchronisation der Statusvariablen erweitert (z.B. wenn von App geändert wurde)
    • NEU: Konfigurationsformular überarbeitet und vereinheitlicht
    • NEU: Twinkly-API erweitert
    • NEU: Nutzung erweiterte Betriebsmodi (experimentell) ermöglicht
    • FIX: Interne Bibliotheken überarbeitet und vereinheitlicht
    • FIX: Dokumentation überarbeitet

    v2.1.20210801

    • NEU: Konfigurationsformular überarbeitet und vereinheitlicht
    • NEU: Zeitschaltung (Timer) hinzugefügt
    • NEU: Abruf der Netzwerkinformation hinzugefügt
    • NEU: Änderung des Gerätenamens (Alias) hinzugefügt
    • NEU: Twinkly-API erweitert
    • FIX: Übersetzungen nachgezogen
    • FIX: Interne Bibliotheken überarbeitet und vereinheitlicht
    • FIX: Debug Meldungen überarbeitet
    • FIX: Dokumentation überarbeitet

    v2.0.20201016

    • NEU: Steuerung bzw. Einstellung der Helligkeit
    • NEU: Vereinfachte Modusschaltung als normaler Lichtschalter
    • NEU: Fehlerbehandlung wenn keine Verbindung zum Gerät hergestellt werden kann
    • FIX: Debugausgabe überarbeitet
    • FIX: API erweitert und überarbeitet

    v1.0.20200501

    • NEU: Initialversion

    Entwickler

    Seit nunmehr über 10 Jahren fasziniert mich das Thema Haussteuerung. In den letzten Jahren betätige ich mich auch intensiv in der Symcon Community und steuere dort verschiedenste Skript und Module bei. Ihr findet mich dort unter dem Namen @pitti ;-)

    GitHub

    Spenden

    Die Software ist für die nicht kommerzielle Nutzung kostenlos, über eine Spende bei Gefallen des Moduls würde ich mich freuen.

    PayPal

    Lizenz

    Namensnennung - Nicht-kommerziell - Weitergabe unter gleichen Bedingungen 4.0 International

    Licence