Software / API Bindings / MQTT / API Referenz und Beispiele / Bricklets / Industrial Quad Relay Bricklet 2.0

MQTT - Industrial Quad Relay Bricklet 2.0¶

Dies ist die Beschreibung der MQTT API Bindings für das Industrial Quad Relay Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Quad Relay Bricklet 2.0 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 Industrial Quad Relay Bricklet 2.0

setup:
    # Turn relays alternating on/off 10 times with 100 ms delay
    for i in 0..9

        wait for 0.1s

        publish '{"value": [true,false,false,false]}' to tinkerforge/request/industrial_quad_relay_v2_bricklet/XYZ/set_value

        wait for 0.1s

        publish '{"value": [false,true,false,false]}' to tinkerforge/request/industrial_quad_relay_v2_bricklet/XYZ/set_value

        wait for 0.1s

        publish '{"value": [false,false,true,false]}' to tinkerforge/request/industrial_quad_relay_v2_bricklet/XYZ/set_value

        wait for 0.1s

        publish '{"value": [false,false,false,true]}' to tinkerforge/request/industrial_quad_relay_v2_bricklet/XYZ/set_value

    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/industrial_quad_relay_v2_bricklet/<UID>/set_value¶

Anfrage:	value – Typ: [bool, ...], Länge: 4
Antwort:	keine Antwort

Setzt den Wert der vier Relais. Ein Wert von true schließt das Relais und ein Wert von False öffnet das Relais.

Nutze request/industrial_quad_relay_v2_bricklet/<UID>/set_selected_value um einzelne Relais zu schalten.

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

request/industrial_quad_relay_v2_bricklet/<UID>/get_value¶

Anfrage:	keine Nutzdaten
Antwort:	value – Typ: [bool, ...], Länge: 4

Gibt die Werte zurück, wie von request/industrial_quad_relay_v2_bricklet/<UID>/set_value gesetzt.

request/industrial_quad_relay_v2_bricklet/<UID>/set_channel_led_config¶

Anfrage:	channel – Typ: int, Wertebereich: [0 bis 3] config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:	keine Antwort

Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird ist die LED an wenn ein High-Signal am Kanal anliegt und sonst aus.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für config:

"off" = 0
"on" = 1
"show_heartbeat" = 2
"show_channel_status" = 3

request/industrial_quad_relay_v2_bricklet/<UID>/get_channel_led_config¶

Anfrage:	channel – Typ: int, Wertebereich: [0 bis 3]
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Kanal-LED-Konfiguration zurück, wie von request/industrial_quad_relay_v2_bricklet/<UID>/set_channel_led_config gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für config:

"off" = 0
"on" = 1
"show_heartbeat" = 2
"show_channel_status" = 3

Fortgeschrittene Funktionen¶

request/industrial_quad_relay_v2_bricklet/<UID>/set_monoflop¶

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

Konfiguriert einen Monoflop für den angegebenen Kanal.

Der zweite Parameter ist eine der gewünschten Zustände des festgelegten Kanals. Eine true bedeutet Relais geschlossen und ein *false bedeutet Relais offen.

Der dritte Parameter ist die Zeit die der Kanal den Zustand halten sollen.

Wenn diese Funktion mit den Parametern (0, 1, 1500) aufgerufen wird, wird Kanal 0 geschlossen und nach 1,5s wieder geöffnet.

Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Industrial Quad Relay Bricklet 2.0 ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Kanal wird die gesamte Zeit im Zustand geschlossen sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Kanal nach spätestens zwei Sekunden in den Zustand geöffnet wechseln.

request/industrial_quad_relay_v2_bricklet/<UID>/get_monoflop¶

Anfrage:	channel – Typ: int, Wertebereich: [0 bis 3]
Antwort:	value – 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 (für den angegebenen Kanal) den aktuellen Zustand und die Zeit, wie von request/industrial_quad_relay_v2_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/industrial_quad_relay_v2_bricklet/<UID>/set_selected_value¶

Anfrage:	channel – Typ: int, Wertebereich: [0 bis 3] value – Typ: bool
Antwort:	keine Antwort

Setzt den Ausgabewert des spezifizierten Kanals ohne die anderen Kanäle zu beeinflussen.

Ein laufender Monoflop Timer für den spezifizierten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

request/industrial_quad_relay_v2_bricklet/<UID>/get_spitfp_error_count¶

Anfrage:	keine Nutzdaten
Antwort:	error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: int, Wertebereich: [0 bis 2³² - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

request/industrial_quad_relay_v2_bricklet/<UID>/set_status_led_config¶

Anfrage:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:	keine Antwort

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für config:

"off" = 0
"on" = 1
"show_heartbeat" = 2
"show_status" = 3

request/industrial_quad_relay_v2_bricklet/<UID>/get_status_led_config¶

Anfrage:	keine Nutzdaten
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/industrial_quad_relay_v2_bricklet/<UID>/set_status_led_config gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für config:

"off" = 0
"on" = 1
"show_heartbeat" = 2
"show_status" = 3

request/industrial_quad_relay_v2_bricklet/<UID>/get_chip_temperature¶

Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

request/industrial_quad_relay_v2_bricklet/<UID>/reset¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

request/industrial_quad_relay_v2_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 Industrial Quad Relay 2.0.

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/industrial_quad_relay_v2_bricklet/<UID>/monoflop_done¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	channel – Typ: int, Wertebereich: [0 bis 3] value – Typ: bool

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

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Payload-Member des Callbacks enthalten den Kanal und den aktuellen Zustand des Kanals (der Zustand nach dem Monoflop).

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

request/industrial_quad_relay_v2_bricklet/<UID>/set_bootloader_mode¶

Anfrage:	mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:	status – Typ: int, Wertebereich: Siehe Symbole

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für mode:

"bootloader" = 0
"firmware" = 1
"bootloader_wait_for_reboot" = 2
"firmware_wait_for_reboot" = 3
"firmware_wait_for_erase_and_reboot" = 4

Für status:

"ok" = 0
"invalid_mode" = 1
"no_change" = 2
"entry_function_not_present" = 3
"device_identifier_incorrect" = 4
"crc_mismatch" = 5

request/industrial_quad_relay_v2_bricklet/<UID>/get_bootloader_mode¶

Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/industrial_quad_relay_v2_bricklet/<UID>/set_bootloader_mode.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für mode:

"bootloader" = 0
"firmware" = 1
"bootloader_wait_for_reboot" = 2
"firmware_wait_for_reboot" = 3
"firmware_wait_for_erase_and_reboot" = 4

request/industrial_quad_relay_v2_bricklet/<UID>/set_write_firmware_pointer¶

Anfrage:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Antwort:	keine Antwort

Setzt den Firmware-Pointer für request/industrial_quad_relay_v2_bricklet/<UID>/write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

request/industrial_quad_relay_v2_bricklet/<UID>/write_firmware¶

Anfrage:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:	status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/industrial_quad_relay_v2_bricklet/<UID>/set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

request/industrial_quad_relay_v2_bricklet/<UID>/write_uid¶

Anfrage:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Antwort:	keine Antwort

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

request/industrial_quad_relay_v2_bricklet/<UID>/read_uid¶

Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.