MQTT - IO-16 Bricklet

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

Input

Download (example-input.txt)

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

setup:
    # Get current value from port A as bitmask
    subscribe to tinkerforge/response/io16_bricklet/XYZ/get_port
    publish '{"port": "a"}' to tinkerforge/request/io16_bricklet/XYZ/get_port

Output

Download (example-output.txt)

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

setup:
    # Set pin 0 on port A to output low: 1 << 0 = 1
    publish '{"port": "a", "selection_mask": 1, "direction": "out", "value": false}' to tinkerforge/request/io16_bricklet/XYZ/set_port_configuration 
    
    # Set pin 0 and 7 on port B to output high: (1 << 0) | (1 << 7) = 129
    publish '{"port": "b", "selection_mask": 129, "direction": "out", "value": true}' to tinkerforge/request/io16_bricklet/XYZ/set_port_configuration 

Interrupt

Download (example-interrupt.txt)

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

setup:
    # Handle incoming interrupt callbacks
    subscribe to tinkerforge/callback/io16_bricklet/XYZ/interrupt
    publish '{"register": true}' to tinkerforge/register/io16_bricklet/XYZ/interrupt # Register interrupt callback
    
    # Enable interrupt on pin 2 of port A: 1 << 2 = 4
    publish '{"port": "a", "interrupt_mask": 4}' to tinkerforge/request/io16_bricklet/XYZ/set_port_interrupt 

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/io16_bricklet/<UID>/set_port
Anfrage:
  • port – Typ: char, Wertebereich: ["a" bis "b"]
  • value_mask – Typ: int, Wertebereich: [0 bis 255]
Antwort:
  • keine Antwort

Setzt den Ausgangszustand (logisch 1 oder logisch 0) für einen Port ("a" oder "b") mittels einer Bitmaske (8Bit). Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Beispiel: Der Wert 15 bzw. 0b00001111 setzt die Pins 0-3 auf logisch 1 und die Pins 4-7 auf logisch 0.

Alle laufenden Monoflop Timer für den angegebenen Port werden abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

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

request/io16_bricklet/<UID>/get_port
Anfrage:
  • port – Typ: char, Wertebereich: ["a" bis "b"]
Antwort:
  • value_mask – Typ: int, Wertebereich: [0 bis 255]

Gibt eine Bitmaske der aktuell gemessenen Zustände des gewählten Ports zurück. Diese Funktion gibt die Zustände aller Pins zurück, unabhängig ob diese als Ein- oder Ausgang konfiguriert sind.

request/io16_bricklet/<UID>/set_port_configuration
Anfrage:
  • port – Typ: char, Wertebereich: ["a" bis "b"]
  • selection_mask – Typ: int, Wertebereich: [0 bis 255]
  • direction – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "i"
  • value – Typ: bool, Standardwert: true
Antwort:
  • keine Antwort

Konfiguriert den Zustand und die Richtung des angegebenen Ports. 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:

  • ('a', 255, 'i', true) bzw. ('a', 0b11111111, 'i', true) setzt alle Pins des Ports a als Eingang mit Pull-Up.
  • ('a', 128, 'i', false) bzw. ('a', 0b10000000, 'i', false) setzt Pin 7 des Ports A als Standard Eingang (potentialfrei wenn nicht verbunden).
  • ('b', 3, 'o', false) bzw. ('b', 0b00000011, 'o', false) setzt die Pins 0 und 1 des Ports B als Ausgang im Zustand logisch 0.
  • ('b', 4, 'o', true) bzw. ('b', 0b00000100, 'o', true) setzt Pin 2 des Ports B als Ausgang im Zustand logisch 1.

Laufende Monoflop Timer für die ausgewählten Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.

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

Für direction:

  • "in" = "i"
  • "out" = "o"
request/io16_bricklet/<UID>/get_port_configuration
Anfrage:
  • port – Typ: char, Wertebereich: ["a" bis "b"]
Antwort:
  • direction_mask – Typ: int, Wertebereich: [0 bis 255]
  • value_mask – Typ: int, Wertebereich: [0 bis 255]

Gibt eine Bitmaske für die Richtung und eine Bitmaske für den Zustand der Pins des gewählten Ports zurück. Eine 1 in der Bitmaske für die Richtung bedeutet Eingang und eine 0 in der Bitmaske bedeutet Ausgang.

Beispiel: Ein Rückgabewert von (15, 51) bzw. (0b00001111, 0b00110011) für Richtung und Zustand bedeutet:

  • Pin 0 und 1 sind als Eingang mit Pull-Up konfiguriert,
  • Pin 2 und 3 sind als Standard Eingang konfiguriert,
  • Pin 4 und 5 sind als Ausgang im Zustand logisch 1 konfiguriert
  • und Pin 6 und 7 sind als Ausgang im Zustand logisch 0 konfiguriert.
request/io16_bricklet/<UID>/get_edge_count
Anfrage:
  • pin – Typ: int, Wertebereich: [0 bis 1]
  • 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 Pin von Port A zurück. Die zu zählenden Flanken können mit request/io16_bricklet/<UID>/set_edge_count_config konfiguriert werden.

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

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen

request/io16_bricklet/<UID>/set_port_monoflop
Anfrage:
  • port – Typ: char, Wertebereich: ["a" bis "b"]
  • selection_mask – Typ: int, Wertebereich: [0 bis 255]
  • value_mask – Typ: int, Wertebereich: [0 bis 255]
  • time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Konfiguriert einen Monoflop für die Pins, wie mittels der 8 Bit langen Bitmaske des zweiten Parameters festgelegt. Die festgelegten Pins müssen als Ausgänge konfiguriert sein. Als Eingänge konfigurierte Pins werden ignoriert.

Der dritte Parameter ist eine Bitmaske mit den gewünschten Zuständen der festgelegten Ausgangspins. Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Der vierte Parameter stellt die Zeit dar, welche die Pins den Zustand halten sollen.

Wenn diese Funktion mit den Parametern ('a', 9, 1, 1500) bzw. ('a', 0b00001001, 0b00000001, 1500) aufgerufen wird: Pin 0 wird auf logisch 1 und Pin 3 auf logisch 0 am Port 'a' gesetzt. Nach 1,5s wird Pin 0 wieder logisch 0 und Pin 3 logisch 1 gesetzt.

Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-16 Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Pin wird die gesamte Zeit im Zustand logisch 1 sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Pin nach spätestens zwei Sekunden in den Zustand logisch 0 wechseln.

request/io16_bricklet/<UID>/get_port_monoflop
Anfrage:
  • port – Typ: char, Wertebereich: ["a" bis "b"]
  • pin – Typ: int, Wertebereich: [0 bis 7]
Antwort:
  • value – Typ: int, Wertebereich: [0 bis 255]
  • 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 Pin) den aktuellen Zustand und die Zeit, wie von request/io16_bricklet/<UID>/set_port_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/io16_bricklet/<UID>/set_selected_values
Anfrage:
  • port – Typ: char, Wertebereich: ["a" bis "b"]
  • selection_mask – Typ: int, Wertebereich: [0 bis 255]
  • value_mask – Typ: int, Wertebereich: [0 bis 255]
Antwort:
  • keine Antwort

Setzt den Ausgangszustand (logisch 1 oder logisch 0) mittels einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske hat eine Länge von 8 Bit und eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Beispiel: Die Parameter ('a', 192, 128) bzw. ('a', 0b11000000, 0b10000000) setzen den Pin 7 auf logisch 1 und den Pin 6 auf logisch 0 an Port A. Die Pins 0-6 bleiben unangetastet.

Laufende Monoflop Timer für die ausgewählten Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

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

request/io16_bricklet/<UID>/set_edge_count_config
Anfrage:
  • pin – Typ: int, Wertebereich: [0 bis 1]
  • 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 den ausgewählten Pin von Port A. Der Flankenzähler steht für Pins 0 und 1 zur Verfügung.

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

  • 0 = steigend
  • 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.

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

Für edge_type:

  • "rising" = 0
  • "falling" = 1
  • "both" = 2

Neu in Version 2.0.3 (Plugin).

request/io16_bricklet/<UID>/get_edge_count_config
Anfrage:
  • pin – Typ: int, Wertebereich: [0 bis 1]
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 Pin von Port A zurück, wie von request/io16_bricklet/<UID>/set_edge_count_config gesetzt.

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

Für edge_type:

  • "rising" = 0
  • "falling" = 1
  • "both" = 2

Neu in Version 2.0.3 (Plugin).

request/io16_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", "i", "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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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-16.

Konfigurationsfunktionen für Callbacks

request/io16_bricklet/<UID>/set_debounce_period
Anfrage:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Antwort:
  • keine Antwort

Setzt die Entprellperiode der register/io16_bricklet/<UID>/interrupt Callback.

Beispiel: Wenn dieser Wert auf 100 gesetzt wird, erhält man den Interrupt maximal alle 100ms. Dies ist notwendig falls etwas prellendes an das IO-16 Bricklet angeschlossen ist, wie z.B. eine Taste.

request/io16_bricklet/<UID>/get_debounce_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von request/io16_bricklet/<UID>/set_debounce_period gesetzt.

request/io16_bricklet/<UID>/set_port_interrupt
Anfrage:
  • port – Typ: char, Wertebereich: ["a" bis "b"]
  • interrupt_mask – Typ: int, Wertebereich: [0 bis 255]
Antwort:
  • keine Antwort

Setzt durch eine Bitmaske die Pins für welche der Interrupt aktiv ist. Interrupts werden ausgelöst bei Änderung des Spannungspegels eines Pins, z.B. ein Wechsel von logisch 1 zu logisch 0 und logisch 0 zu logisch 1.

Beispiel: ('a', 129) bzw. ('a', 0b10000001) aktiviert den Interrupt für die Pins 0 und 7 des Ports a.

Der Interrupt wird mit dem register/io16_bricklet/<UID>/interrupt Callback zugestellt.

request/io16_bricklet/<UID>/get_port_interrupt
Anfrage:
  • port – Typ: char, Wertebereich: ["a" bis "b"]
Antwort:
  • interrupt_mask – Typ: int, Wertebereich: [0 bis 255]

Gibt die Interrupt Bitmaske für den angegebenen Port zurück, wie von request/io16_bricklet/<UID>/set_port_interrupt 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/io16_bricklet/<UID>/interrupt
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • port – Typ: char, Wertebereich: ["a" bis "b"]
  • interrupt_mask – Typ: int, Wertebereich: [0 bis 255]
  • value_mask – Typ: int, Wertebereich: [0 bis 255]

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

Dieser Callback wird ausgelöst sobald eine Änderung des Spannungspegels detektiert wird, an Pins für welche der Interrupt mit request/io16_bricklet/<UID>/set_port_interrupt aktiviert wurde.

Die Rückgabewerte sind der Port, eine Bitmaske der aufgetretenen Interrupts und der aktuellen Zustände des Ports.

Beispiele:

  • ('a', 1, 1) bzw. ('a', 0b00000001, 0b00000001) bedeutet, dass an Port A ein Interrupt am Pin 0 aufgetreten ist und aktuell ist Pin 0 logisch 1 und die Pins 1-7 sind logisch 0.
  • ('b', 129, 254) bzw. ('b', 0b10000001, 0b11111110) bedeutet, dass an Port B Interrupts an den Pins 0 und 7 aufgetreten sind und aktuell ist Pin 0 logisch 0 und die Pins 1-7 sind logisch 1.
register/io16_bricklet/<UID>/monoflop_done
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • port – Typ: char, Wertebereich: ["a" bis "b"]
  • selection_mask – Typ: int, Wertebereich: [0 bis 255]
  • value_mask – Typ: int, Wertebereich: [0 bis 255]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/io16_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/io16_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 Port, die beteiligten Pins als Bitmaske und den aktuellen Zustand als Bitmaske (der Zustand nach dem Monoflop).