TasmotaV2

Diese Dokumentation beschreibt immer die neueste Version des Moduls, aktuell 1.0.1 im Kanal Beta.

Tasmota Device V2

Bindet ein Tasmota-Gerät über MQTT ein. Die Instanz liest die Discovery-Nachricht des Geräts (tasmota/discovery/<MAC>/config) und legt daraus Relais, Licht, Rollläden, Taster und Schalter an. Sensoren und Energiewerte entstehen automatisch aus der Telemetrie. Normalerweise wird die Instanz über den Tasmota Konfigurator V2 angelegt.

Voraussetzung am Gerät: MQTT ist eingerichtet und die Discovery ist aktiv (SetOption19 0, Standard). Weitere Einstellungen am Gerät sind nicht nötig. Nur wenn Taster oder Schalter am Gerät in IP-Symcon als Auslöser dienen sollen, gibt es dafür zwei optionale Einstellungen (siehe 2.4).

Inhaltsverzeichnis

• Tasmota V2
  • Inhaltsverzeichnis
  • 1. Konfiguration
  • 2. Variablen
    • 2.1 Allgemein
    • 2.2 Relais und Licht
    • 2.3 Rollläden
    • 2.4 Taster und Schalter
    • 2.5 Energie und Sensoren
    • 2.6 Systemvariablen
    • 2.7 Spezialfunktionen (Funktionskatalog)
  • 3. Funktionen
  • 4. Spenden
  • 5. Lizenz

1. Konfiguration

2. Variablen

Variablen entstehen, sobald das Gerät sie ankündigt oder ein Telegramm sie enthält. Die Idents bleiben bei einer Umbenennung gleich.

2.1 Allgemein

2.2 Relais und Licht

2.3 Rollläden

2.4 Taster und Schalter

Optional, nur wenn man es braucht. Ein Taster oder Schalter am Gerät schaltet normalerweise direkt das Relais, und das Modul zeigt nur den neuen Zustand (Power<n>). Das genügt für die meisten Geräte, es muss nichts eingestellt werden.

Soll IP-Symcon dagegen auf Taster oder Schalter am Gerät reagieren, zum Beispiel mit einer Szene bei Doppelklick oder einem Befehl bei langem Drücken, gibt es am Gerät zwei Einstellungen:

Achtung: Mit diesen Einstellungen sind Taster oder Schalter vom Relais getrennt und schalten es nicht mehr selbst. Das Relais schaltet dann nur noch, wenn IP-Symcon (oder eine Regel im Gerät) darauf reagiert. Fällt IP-Symcon oder der MQTT-Broker aus, bleibt der Taster am Gerät wirkungslos. Ohne die Einstellungen legt das Modul keine Taster- und Schaltervariablen an.

2.5 Energie und Sensoren

2.6 Systemvariablen

Nur mit der Option “Systemvariablen”.

2.7 Spezialfunktionen (Funktionskatalog)

Hardware, die die Discovery nicht beschreibt, erkennt die Instanz an der GPIO-Belegung des Geräts oder, beim Sonoff iFan, an einem Kennzeichen der Discovery (Befehl Gpio, wird beim Start und bei “Zustand abfragen” gesendet). Für jede erkannte Funktion legt sie Variablen an, wertet deren Ergebnisse aus und ordnet bedienbaren Variablen den Befehl zu. Der Katalog liegt in libs/data/features.json.

Unterstützte Spezialhardware:

• Fingerabdrucksensor AS608
• Lüfter Sonoff iFan02 und iFan03
• LED-Streifen WS2812 (adressierbare LEDs)
• IR-Empfänger
• Anwesenheitsradar HLK-LD2410
• Geräte mit Energiemessung (Leistungsgrenzen)
• Port-Erweiterungen MCP230xx und PCF8574
• PWM-Treiber PCA9685

Hinweise zum Anwesenheitsradar LD2410 (aus der Tasmota-Doku und dem Quelltext des Treibers):

• Der Treiber ist nicht in den vorkompilierten Firmwares enthalten, er braucht eine eigene Firmware mit USE_LD2410. Gemeint ist der HLK-LD2410 (B und C), der LD2410S hat einen eigenen Treiber und wird nicht unterstützt.
• Das Gerät veröffentlicht die Telemetrie laut Quelltext nur, solange die Bewegungsenergie nicht null ist. Ein ruhender Mensch erzeugt keine Telemetrie. Für eine zuverlässige Anwesenheit den OUT-Pin des Sensors an einen GPIO legen und dort als Switch konfigurieren, er erscheint dann als Schalter (Switch<n>, siehe 2.4).
• Haltezeit und Empfindlichkeit speichert der Sensor selbst, die Instanz fragt sie beim Start ab.
• Der Engineering-Modus (LD2410EngineeringStart, LD2410EngineeringEnd) und LD2410Get laufen über TASV2_SendCommand und TASV2_SendCommandWait.

Die Treiber der Port-Erweiterungen und des PCA9685 sind laut Tasmota-Doku nicht in den vorkompilierten Firmwares enthalten.

3. Funktionen

boolean TASV2_SendCommand(integer $InstanzID, string $Command, string $Payload); Sendet einen beliebigen Tasmota-Befehl an cmnd/<Topic>/<Command>, zum Beispiel TASV2_SendCommand($id, 'Backlog', 'Power1 ON; Delay 20; Power1 OFF');. Die Antwort kommt asynchron und wird, soweit bekannt, in die Variablen übernommen.

Die Treiber der Port-Erweiterungen sind in den vorkompilierten Tasmota-Firmwares nicht enthalten, die Variablen entstehen deshalb nur bei einer eigenen Firmware. Eingänge werden gemeldet, wenn sich ein Pin ändert (Interrupt), oder mit der Telemetrie. Die Einstellung der Pins ist am Gerät nötig, zum Beispiel:

TASV2_SendCommand($id, 'Sensor29', '4,5');                // MCP230xx: Pin 4 als Ausgang
TASV2_SendCommand($id, 'driver15', 'pwmf,200');           // PCA9685: PWM-Frequenz

Beispiel für einzelne Pixel eines LED-Streifens (Led<x>, Farbe als #RRGGBB), Syntax laut Tasmota-Doku:

TASV2_SendCommand($id, 'Led3', '#FF0000');           // Pixel 3 rot
TASV2_SendCommand($id, 'Led1', '#00FF00 #0000FF');   // Pixel 1 grün, Pixel 2 blau

Beispiele für IR-Sender (GPIO IRsend), Syntax laut Tasmota-Doku:

// Code senden (Standard-Firmware: NEC, RC5, RC6), Schreibweise wie in der Tasmota-Doku
TASV2_SendCommand($id, 'IRSend', '{"Protocol":"NEC","Bits":32,"Data":0x8166817E}');

// Klimaanlage (Tasmota-IR-Build)
TASV2_SendCommand($id, 'IRHVAC', '{"Vendor":"Mitsubishi_Heavy_152","Power":"On","Mode":"Cool","FanSpeed":3,"Temp":22}');

string TASV2_SendCommandWait(integer $InstanzID, string $Command, string $Payload, integer $Timeout); Sendet einen Tasmota-Befehl wie TASV2_SendCommand und wartet auf die Antwort des Geräts. Die Antwort kommt als Text (JSON) zurück. Ohne Antwort innerhalb von $Timeout Millisekunden (100 bis 30000), bei unbekanntem Befehl oder wenn die MQTT-Verbindung nicht aktiv ist, ist der Rückgabewert ein leerer Text. Den Timeout muss man bei dieser Funktion immer angeben, empfohlen sind 3000.

Wofür sie gedacht ist:

• Einstellungen lesen, bevor ein Skript sie ändert, zum Beispiel PowerOnState, TelePeriod oder ein SetOption.
• Abfragen ohne Variable, zum Beispiel Firmware (Status 2), Netzwerk (Status 5), Template oder Gpio.
• Befehle prüfen: ob das Gerät den Befehl angenommen hat und welchen Wert es jetzt hat.
• Konfigurationsskripte, die mehrere Befehle nacheinander senden und jeweils das Ergebnis brauchen.

Für das einfache Schalten und Bedienen genügt TASV2_SendCommand oder die Bedienung der Variablen. TASV2_SendCommandWait blockiert das aufrufende Skript, bis die Antwort da ist, und sollte deshalb nicht in Ereignissen verwendet werden, die oft auslösen. Befehle, auf die das Gerät nicht antwortet (zum Beispiel ShutterOpen1), laufen bis zum Timeout. Es zählt nur eine Antwort, die zum Befehl passt: Das ist eine Nachricht stat/<Topic>/RESULT mit dem Befehlsnamen als Schlüssel (oder STATUS<n> bei Status).

$antwort = TASV2_SendCommandWait($id, 'PowerOnState', '', 3000);
if ($antwort !== '') {
    $wert = json_decode($antwort, true)['PowerOnState'] ?? null; // zum Beispiel 3
}

// Firmware des Geräts
$firmware = json_decode(TASV2_SendCommandWait($id, 'Status', '2', 3000), true)['StatusFWR']['Version'] ?? '';

boolean TASV2_RequestState(integer $InstanzID); Fragt den Zustand des Geräts ab (Status 0), die Hardware (Gpio) und die Startwerte der erkannten Funktionen. Läuft automatisch beim Start, beim Verbinden der Instanz mit dem MQTT-Parent (auch beim Anlegen über den Konfigurator) und wenn die MQTT-Verbindung aktiv wird. Fehlt noch die Discovery-Nachricht des Geräts und sendet das Gerät sie (SetOption19 0), fordert die Instanz sie dabei selbst an.

void TASV2_RequestInitialState(integer $InstanzID); Wird vom internen Timer einmal 8 Sekunden nach dem Start oder Neuladen aufgerufen und fragt den Zustand ab, falls der MQTT-Parent inzwischen aktiv ist. Der Aufruf von Hand ist nicht nötig.

boolean TASV2_RequestDiscovery(integer $InstanzID); Veranlasst das Gerät, seine Discovery-Nachricht erneut zu senden (Befehl Discover 1). Das ist nötig, wenn die Instanz neu angelegt wurde und die einmalig gesendete Nachricht verpasst hat.

4. Spenden

Dieses Modul ist für die nicht kommerzielle Nutzung kostenlos, Schenkungen als Unterstützung für den Autor werden hier akzeptiert:

5. Lizenz

CC BY-NC-SA 4.0