MQTT - Industrial Digital In 4 Bricklet

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

1
2
3
4
5
6
# Change XYZ to the UID of your Industrial Digital In 4 Bricklet

setup:
    # Get current value as bitmask
    subscribe to tinkerforge/response/industrial_digital_in_4_bricklet/XYZ/get_value
    publish '' to tinkerforge/request/industrial_digital_in_4_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 Industrial Digital In 4 Bricklet

setup:
    # Handle incoming interrupt callbacks
    subscribe to tinkerforge/callback/industrial_digital_in_4_bricklet/XYZ/interrupt
    publish '{"register": true}' to tinkerforge/register/industrial_digital_in_4_bricklet/XYZ/interrupt # Register interrupt callback
    
    # Enable interrupt on pin 0: 1 << 0 = 1
    publish '{"interrupt_mask": 1}' to tinkerforge/request/industrial_digital_in_4_bricklet/XYZ/set_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/industrial_digital_in_4_bricklet/<UID>/get_value
Anfrage:
  • keine Nutzdaten
Antwort:
  • value_mask – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Ausgabewerte mit einer Bitmaske zurück. Die Bitmaske ist 16Bit lang. true bedeutet logisch 1 und false logisch 0.

Zum Beispiel: Der Wert 3 bzw. 0b0011 bedeutet, dass die Pins 0-1 auf logisch 1 und alle anderen auf logisch 0 sind.

Falls keine Gruppen verwendet werden (siehe request/industrial_digital_in_4_bricklet/<UID>/set_group), entsprechen die Pins der Beschriftung auf dem Industrial Digital In 4 Bricklet.

Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

request/industrial_digital_in_4_bricklet/<UID>/get_edge_count
Anfrage:
  • pin – 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 Pin zurück. Die zu zählenden Flanken können mit request/industrial_digital_in_4_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.

Die Flankenzähler benutzen die Gruppierung, wie von request/industrial_digital_in_4_bricklet/<UID>/set_group gesetzt.

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen

request/industrial_digital_in_4_bricklet/<UID>/set_group
Anfrage:
  • group – Typ: [char, ...], Länge: 4, Wertebereich: ["a" bis "d", "n"]
Antwort:
  • keine Antwort

Setzt eine Gruppe von Digital In 4 Bricklets die zusammenarbeiten sollen. Mögliche Gruppierungen können mit der Funktion request/industrial_digital_in_4_bricklet/<UID>/get_available_for_group gefunden werden.

Eine Gruppe besteht aus 4 Element. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Jedes Element kann entweder auf einen der Ports ('a' bis 'd') gesetzt werden oder falls nicht genutzt 'n' gesetzt werden.

Zum Beispiel: Falls zwei Digital In 4 Bricklets mit Port A und Port B verbunden sind, könnte diese Funktion mit ['a', 'b', 'n', 'n'] aufgerufen werden.

In diesem Fall wären die Pins von Port A den Werten 0-3 zugewiesen und die Pins von Port B den Werten 4-7. Es ist jetzt möglich mit der Funktion request/industrial_digital_in_4_bricklet/<UID>/get_value beide Bricklets gleichzeitig auszulesen.

Änderungen an der Gruppeneinteilung setzt die Konfiguration und Zählerwerte aller Flankenzähler zurück.

request/industrial_digital_in_4_bricklet/<UID>/get_group
Anfrage:
  • keine Nutzdaten
Antwort:
  • group – Typ: [char, ...], Länge: 4, Wertebereich: ["a" bis "d", "n"]

Gibt die Gruppierung zurück, wie von request/industrial_digital_in_4_bricklet/<UID>/set_group gesetzt.

request/industrial_digital_in_4_bricklet/<UID>/get_available_for_group
Anfrage:
  • keine Nutzdaten
Antwort:
  • available – Typ: int, Wertebereich: [0 bis 15]

Gibt eine Bitmaske von Ports zurück die für die Gruppierung zur Verfügung stehen. Zum Beispiel bedeutet der Wert 5 bzw. 0b0101: Port A und Port C sind mit Bricklets verbunden die zusammen gruppiert werden können.

request/industrial_digital_in_4_bricklet/<UID>/set_edge_count_config
Anfrage:
  • selection_mask – Typ: int, Wertebereich: [0 bis 216 - 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 die ausgewählten Pins. Eine Bitmaske von 9 bzw. 0b1001 aktiviert den Flankenzähler für die Pins 0 und 3.

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 Flankenzähler benutzen die Gruppierung, wie von request/industrial_digital_in_4_bricklet/<UID>/set_group 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.1 (Plugin).

request/industrial_digital_in_4_bricklet/<UID>/get_edge_count_config
Anfrage:
  • pin – Typ: int, Wertebereich: [0 bis 255]
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 zurück, wie von request/industrial_digital_in_4_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.1 (Plugin).

request/industrial_digital_in_4_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 Industrial Digital In 4.

Konfigurationsfunktionen für Callbacks

request/industrial_digital_in_4_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/industrial_digital_in_4_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 Digital In 4 Bricklet angeschlossen ist, wie z.B. einen Schalter.

request/industrial_digital_in_4_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/industrial_digital_in_4_bricklet/<UID>/set_debounce_period gesetzt.

request/industrial_digital_in_4_bricklet/<UID>/set_interrupt
Anfrage:
  • interrupt_mask – Typ: int, Wertebereich: [0 bis 216 - 1]
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: Eine Interrupt Bitmaske von 9 bzw. 0b1001 aktiviert den Interrupt für die Pins 0 und 3.

Die Interrupts benutzen die Gruppierung, wie von request/industrial_digital_in_4_bricklet/<UID>/set_group gesetzt.

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

request/industrial_digital_in_4_bricklet/<UID>/get_interrupt
Anfrage:
  • keine Nutzdaten
Antwort:
  • interrupt_mask – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Interrupt Bitmaske zurück, wie von request/industrial_digital_in_4_bricklet/<UID>/set_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/industrial_digital_in_4_bricklet/<UID>/interrupt
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • interrupt_mask – Typ: int, Wertebereich: [0 bis 216 - 1]
  • value_mask – Typ: int, Wertebereich: [0 bis 216 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/industrial_digital_in_4_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/industrial_digital_in_4_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/industrial_digital_in_4_bricklet/<UID>/set_interrupt aktiviert wurde.

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

Beispiele:

  • (1, 1) bzw. (0b0001, 0b0001) bedeutet, dass ein Interrupt am Pin 0 aufgetreten ist und aktuell Pin 0 logisch 1 ist und die Pins 1-3 logisch 0 sind.
  • (9, 14) bzw. (0b1001, 0b1110) bedeutet, dass Interrupts an den Pins 0 und 3 aufgetreten sind und aktuell Pin 0 logisch 0 ist und die Pins 1-3 logisch 1 sind.

Die Interrupts benutzen die Gruppierung, wie von request/industrial_digital_in_4_bricklet/<UID>/set_group gesetzt.