MQTT - IO-4 Bricklet 2.0

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

Input

Download (example-input.txt)

1
2
3
4
5
6
# Change XYZ to the UID of your IO-4 Bricklet 2.0

setup:
    # Get current value
    subscribe to tinkerforge/response/io4_v2_bricklet/XYZ/get_value
    publish '' to tinkerforge/request/io4_v2_bricklet/XYZ/get_value

Interrupt

Download (example-interrupt.txt)

1
2
3
4
5
6
7
8
9
# Change XYZ to the UID of your IO-4 Bricklet 2.0

setup:
    # Handle incoming input value callbacks
    subscribe to tinkerforge/callback/io4_v2_bricklet/XYZ/input_value
    publish '{"register": true}' to tinkerforge/register/io4_v2_bricklet/XYZ/input_value # Register input_value callback

    # Set period for input value (channel 1) callback to 0.5s (500ms)
    publish '{"channel": 1, "period": 500, "value_has_to_change": false}' to tinkerforge/request/io4_v2_bricklet/XYZ/set_input_value_callback_configuration

Output

Download (example-output.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
# Change XYZ to the UID of your IO-4 Bricklet 2.0

setup:
    # Configure channel 3 as output low
    publish '{"channel": 3, "direction": "out", "value": false}' to tinkerforge/request/io4_v2_bricklet/XYZ/set_configuration

    # Set channel 3 alternating high/low 10 times with 100 ms delay
    for i in 0..9

        wait for 0.1s

        publish '{"channel": 3, "value": true}' to tinkerforge/request/io4_v2_bricklet/XYZ/set_selected_value

        wait for 0.1s

        publish '{"channel": 3, "value": false}' to tinkerforge/request/io4_v2_bricklet/XYZ/set_selected_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/io4_v2_bricklet/<UID>/set_value
Anfrage:
  • value – Typ: [bool, ...], Länge: 4
Antwort:
  • keine Antwort

Setzt den Zustand aller vier Kanäle. Der Wert true bzw. false erzeugen logisch 1 bzw. logisch 0 auf dem entsprechenden Kanal.

Mit der Funktionen request/io4_v2_bricklet/<UID>/set_selected_value können einzelnen Kanäle gesetzt werden.

Beispiel: (True, True, False, False) setzt die Kanäle 0-1 auf logisch 1 und die Kanäle 2-3 auf logisch 0.

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

Bemerkung

Diese Funktion bewirkt keine Änderung an Kanälen die als Eingang konfiguriert sind. Pull-Up Widerstände können mit request/io4_v2_bricklet/<UID>/set_configuration zugeschaltet werden.

request/io4_v2_bricklet/<UID>/get_value
Anfrage:
  • keine Nutzdaten
Antwort:
  • value – Typ: [bool, ...], Länge: 4

Gibt die aktuell gemessenen Zustände zurück. Diese Funktion gibt die Zustände aller Kanäle zurück, unabhängig ob diese als Ein- oder Ausgang konfiguriert sind.

request/io4_v2_bricklet/<UID>/set_selected_value
Anfrage:
  • channel – Typ: int, Wertebereich: [0 bis 3]
  • value – Typ: bool
Antwort:
  • keine Antwort

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

Ein laufender Monoflop Timer oder PWM für den ausgewählten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

Diese Funktion bewirkt keine Änderung an Kanälen die als Eingang konfiguriert sind. Pull-Up Widerstände können mit request/io4_v2_bricklet/<UID>/set_configuration zugeschaltet werden.

request/io4_v2_bricklet/<UID>/set_configuration
Anfrage:
  • channel – Typ: int, Wertebereich: [0 bis 3]
  • direction – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "i"
  • value – Typ: bool, Standardwert: true
Antwort:
  • keine Antwort

Konfiguriert den Zustand und die Richtung eines angegebenen Kanals. Mögliche Richtungen sind 'i' und 'o' für Ein- und Ausgang.

Wenn die Richtung als Ausgang konfiguriert ist, ist der Zustand entweder logisch 1 oder logisch 0 (gesetzt als true oder false).

Wenn die Richtung als Eingang konfiguriert ist, ist der Zustand entweder Pull-Up oder Standard (gesetzt als true oder false).

Beispiele:

  • (0, 'i', true) setzt Kanal 0 als Eingang mit Pull-Up.
  • (1, 'i', false) setzt Kanal 1 als Standard Eingang (potentialfrei wenn nicht verbunden).
  • (2, 'o', true) setzt Kanal 2 als Ausgang im Zustand logisch 1.
  • (3, 'o', false) setzt Kanal 3 als Ausgang im Zustand logisch 0.

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

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

Für direction:

  • "in" = "i"
  • "out" = "o"
request/io4_v2_bricklet/<UID>/get_configuration
Anfrage:
  • channel – Typ: int, Wertebereich: [0 bis 3]
Antwort:
  • direction – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "i"
  • value – Typ: bool, Standardwert: true

Gibt die Kanal-Konfiguration zurück, wie von request/io4_v2_bricklet/<UID>/set_configuration gesetzt.

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

Für direction:

  • "in" = "i"
  • "out" = "o"

Fortgeschrittene Funktionen

request/io4_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 232 - 1]
Antwort:
  • keine Antwort

Der erste Parameter ist der gewünschte Zustand des Kanals (true bedeutet high und false low). Der zweite Parameter stellt die Zeit dar, in welcher der Kanal den Zustand halten soll.

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

Ein PWM für den ausgewählten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

Ein Monoflop kann als Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-4 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 eingeschaltet sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Kanal nach spätestens zwei Sekunden ausschalten.

request/io4_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 232 - 1]
  • time_remaining – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Gibt (für den angegebenen Kanal) den aktuellen Zustand und die Zeit, wie von request/io4_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/io4_v2_bricklet/<UID>/get_edge_count
Anfrage:
  • channel – Typ: int, Wertebereich: [0 bis 3]
  • reset_counter – Typ: bool
Antwort:
  • count – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Kanal zurück. Die zu zählenden Flanken können mit request/io4_v2_bricklet/<UID>/set_edge_count_configuration konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

Bemerkung

Aufrufen dieser Funktion ist nur für Kanäle erlaubt, die als Eingang konfiguriert sind.

request/io4_v2_bricklet/<UID>/set_edge_count_configuration
Anfrage:
  • channel – Typ: int, Wertebereich: [0 bis 3]
  • edge_type – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100
Antwort:
  • keine Antwort

Konfiguriert den Flankenzähler für einen bestimmten Kanal.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden für Kanäle die als Eingang konfiguriert sind. Mögliche Flankentypen sind:

  • 0 = steigend (Standard)
  • 1 = fallend
  • 2 = beide

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

Bemerkung

Aufrufen dieser Funktion ist nur für Kanäle erlaubt, die als Eingang konfiguriert sind.

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

Für edge_type:

  • "rising" = 0
  • "falling" = 1
  • "both" = 2
request/io4_v2_bricklet/<UID>/get_edge_count_configuration
Anfrage:
  • channel – Typ: int, Wertebereich: [0 bis 3]
Antwort:
  • edge_type – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Kanal zurück, wie von request/io4_v2_bricklet/<UID>/set_edge_count_configuration gesetzt.

Bemerkung

Aufrufen dieser Funktion ist nur für Kanäle erlaubt, die als Eingang konfiguriert sind.

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

Für edge_type:

  • "rising" = 0
  • "falling" = 1
  • "both" = 2
request/io4_v2_bricklet/<UID>/set_pwm_configuration
Anfrage:
  • channel – Typ: int, Wertebereich: [0 bis 3]
  • frequency – Typ: int, Einheit: 1/10 Hz, Wertebereich: [0 bis 320000000], Standardwert: 0
  • duty_cycle – Typ: int, Einheit: 1/100 %, Wertebereich: [0 bis 10000], Standardwert: 0
Antwort:
  • keine Antwort

Aktiviert ein PWM auf dem angegebenen Kanal.

Bevor diese Funktion aufgerufen wird, muss der Kanal als Ausgabe konfiguriert werden, ansonsten wird ein "invalid parameter"-Fehler gemeldet. Um die PWM wieder auszustellen, kann die Frequenz auf 0 gesetzt werden oder eine andere Funktion aufgerufen werden die Einstellungen am Kanal verändert (z.B. request/io4_v2_bricklet/<UID>/set_selected_value).

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

request/io4_v2_bricklet/<UID>/get_pwm_configuration
Anfrage:
  • channel – Typ: int, Wertebereich: [0 bis 3]
Antwort:
  • frequency – Typ: int, Einheit: 1/10 Hz, Wertebereich: [0 bis 320000000], Standardwert: 0
  • duty_cycle – Typ: int, Einheit: 1/100 %, Wertebereich: [0 bis 10000], Standardwert: 0

Gibt die PWM Konfiguration zurück, wie von request/io4_v2_bricklet/<UID>/set_pwm_configuration gesetzt.

request/io4_v2_bricklet/<UID>/get_spitfp_error_count
Anfrage:
  • keine Nutzdaten
Antwort:
  • error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 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/io4_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/io4_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/io4_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/io4_v2_bricklet/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 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/io4_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/io4_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 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 IO-4 2.0.

Konfigurationsfunktionen für Callbacks

request/io4_v2_bricklet/<UID>/set_input_value_callback_configuration
Anfrage:
  • channel – Typ: int, Wertebereich: [0 bis 3]
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode ist die Periode mit der der register/io4_v2_bricklet/<UID>/input_value Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

request/io4_v2_bricklet/<UID>/get_input_value_callback_configuration
Anfrage:
  • channel – Typ: int, Wertebereich: [0 bis 3]
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration für den gegebenen Kanal zurück, wie mittels request/io4_v2_bricklet/<UID>/set_input_value_callback_configuration gesetzt.

request/io4_v2_bricklet/<UID>/set_all_input_value_callback_configuration
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/io4_v2_bricklet/<UID>/all_input_value Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

request/io4_v2_bricklet/<UID>/get_all_input_value_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels request/io4_v2_bricklet/<UID>/set_all_input_value_callback_configuration gesetzt.

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/io4_v2_bricklet/<UID>/input_value
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • channel – Typ: int, Wertebereich: [0 bis 3]
  • changed – Typ: bool
  • value – Typ: bool

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/io4_v2_bricklet/<UID>/set_input_value_callback_configuration gesetzten Konfiguration

Die Parameter sind der Kanal, Changed und der Wert. Der changed-Parameter ist True wenn sich der Wert seit dem letzten Callback geändert hat.

register/io4_v2_bricklet/<UID>/all_input_value
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • changed – Typ: [bool, ...], Länge: 4
  • value – Typ: [bool, ...], Länge: 4

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/io4_v2_bricklet/<UID>/set_all_input_value_callback_configuration gesetzten Konfiguration

Die Payload-Member des Callbacks sind der gleiche wie request/io4_v2_bricklet/<UID>/get_value. Zusätzlich ist der changed-Parameter True wenn sich der Wert seit dem letzten Callback geändert hat.

register/io4_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/io4_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/io4_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/io4_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/io4_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/io4_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/io4_v2_bricklet/<UID>/set_write_firmware_pointer
Anfrage:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für request/io4_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/io4_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/io4_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/io4_v2_bricklet/<UID>/write_uid
Anfrage:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 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/io4_v2_bricklet/<UID>/read_uid
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

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