Software / API Bindings / MQTT / API Referenz und Beispiele / Bricklets (Abgekündigt) / Solid State Relay Bricklet

MQTT - Solid State Relay Bricklet¶

Dies ist die Beschreibung der MQTT API Bindings für das Solid State Relay Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Solid State Relay Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die MQTT API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (example-simple.txt)

# Change XYZ to the UID of your Solid State Relay Bricklet

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

        wait for 1s

        publish '{"state": true}' to tinkerforge/request/solid_state_relay_bricklet/XYZ/set_state

        wait for 1s

        publish '{"state": false}' to tinkerforge/request/solid_state_relay_bricklet/XYZ/set_state

    endfor

API¶

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen¶

request/solid_state_relay_bricklet/<UID>/set_state¶

Anfrage:	state – Typ: bool, Standardwert: false
Antwort:	keine Antwort

Setzt den Zustand des Relais, true bedeutet ein und false aus.

Ein laufender Monoflop Timer wird abgebrochen, wenn diese Funktion aufgerufen wird.

request/solid_state_relay_bricklet/<UID>/get_state¶

Anfrage:	keine Nutzdaten
Antwort:	state – Typ: bool, Standardwert: false

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

Fortgeschrittene Funktionen¶

request/solid_state_relay_bricklet/<UID>/set_monoflop¶

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

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

Wenn diese Funktion mit den Parametern (true, 1500) aufgerufen wird: Das Relais 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/solid_state_relay_bricklet/<UID>/get_monoflop¶

Anfrage:	keine Nutzdaten
Antwort:	state – Typ: bool time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1] time_remaining – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1]

Gibt den aktuellen Zustand und die Zeit, wie von request/solid_state_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/solid_state_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 2¹⁶ - 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 Solid State 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.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

register/solid_state_relay_bricklet/<UID>/monoflop_done¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	state – Typ: bool

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/solid_state_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/solid_state_relay_bricklet/<UID>/monoflop_done[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Der Parameter ist der aktuellen Zustand des Relais (der Zustand nach dem Monoflop).