MQTT - Dual Relay Bricklet¶

Simple¶

Download (example-simple.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

# Change XYZ to the UID of your Dual Relay Bricklet

setup:
    # Turn relays alternating on/off 10 times with 1 second delay
    for i in 0..4

        wait for 1s

        publish '{"relay1": true, "relay2": false}' to tinkerforge/request/dual_relay_bricklet/XYZ/set_state

        wait for 1s

        publish '{"relay1": false, "relay2": true}' to tinkerforge/request/dual_relay_bricklet/XYZ/set_state

    endfor

Grundfunktionen¶

request/dual_relay_bricklet/<UID>/set_state¶

Anfrage:	relay1 – Typ: bool, Standardwert: false relay2 – Typ: bool, Standardwert: false
Antwort:	keine Antwort

Setzt den Zustand der Relais, true bedeutet ein und false aus. Beispiel: (true, false) schaltet Relais 1 ein und Relais 2 aus.

Wenn nur eines der Relais gesetzt werden soll und der aktuelle Zustand des anderen Relais nicht bekannt ist, dann kann der Zustand mit request/dual_relay_bricklet/<UID>/get_state ausgelesen werden oder es kann request/dual_relay_bricklet/<UID>/set_selected_state genutzt werden.

Alle laufenden Monoflop Timer werden abgebrochen, wenn diese Funktion aufgerufen wird.

request/dual_relay_bricklet/<UID>/get_state¶

Anfrage:	keine Nutzdaten
Antwort:	relay1 – Typ: bool, Standardwert: false relay2 – Typ: bool, Standardwert: false

Gibt den Zustand der Relais zurück, true bedeutet ein und false aus.

Fortgeschrittene Funktionen¶

request/dual_relay_bricklet/<UID>/set_monoflop¶

Anfrage:	relay – Typ: int, Wertebereich: [1 bis 2] state – Typ: bool time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Antwort:	keine Antwort

Der erste Parameter kann 1 oder 2 sein (Relais 1 oder Relais 2). Der zweite Parameter ist der gewünschte Zustand des Relais (true bedeutet ein und false aus). Der dritte Parameter stellt die Zeit dar, welche das Relais den Zustand halten soll.

Wenn diese Funktion mit den Parametern (1, true, 1500) aufgerufen wird: Relais 1 wird angeschaltet und nach 1,5s wieder ausgeschaltet.

Ein Monoflop kann als Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Dual Relay Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Das Relais wird die gesamte Zeit ein sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird das Relais nach spätestens zwei Sekunden ausschalten.

request/dual_relay_bricklet/<UID>/get_monoflop¶

Anfrage:	relay – Typ: int, Wertebereich: [1 bis 2]
Antwort:	state – Typ: bool time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] time_remaining – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Gibt (für das angegebene Relais) den aktuellen Zustand und die Zeit, wie von request/dual_relay_bricklet/<UID>/set_monoflop gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.

Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.

request/dual_relay_bricklet/<UID>/set_selected_state¶

Anfrage:	relay – Typ: int, Wertebereich: [1 bis 2] state – Typ: bool
Antwort:	keine Antwort

Setzt den Zustand des ausgewählte Relais (1 oder 2), true bedeutet ein und false aus.

Ein laufender Monoflop Timer für das ausgewählte Relais wird abgebrochen, wenn diese Funktion aufgerufen wird.

Das andere Relais bleibt unangetastet.

request/dual_relay_bricklet/<UID>/get_identity¶

Anfrage:

keine Nutzdaten

Antwort:

uid – Typ: string, Länge: bis zu 8 connected_uid – Typ: string, Länge: bis zu 8 position – Typ: char, Wertebereich: ["a" bis "h", "z"] hardware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] firmware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1] _display_name – Typ: string

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Dual Relay.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

register/dual_relay_bricklet/<UID>/monoflop_done¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	relay – Typ: int, Wertebereich: [1 bis 2] state – Typ: bool

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/dual_relay_bricklet/<UID>/monoflop_done[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/dual_relay_bricklet/<UID>/monoflop_done[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Die Parameter enthalten das auslösende Relais (1 oder 2) und den aktuellen Zustand des Relais (der Zustand nach dem Monoflop).