MQTT - Industrial Dual 0-20mA Bricklet

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

setup:
    # Get current current from sensor 1
    subscribe to tinkerforge/response/industrial_dual_0_20ma_bricklet/XYZ/get_current
    publish '{"sensor": 1}' to tinkerforge/request/industrial_dual_0_20ma_bricklet/XYZ/get_current

Callback

Download (example-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet

setup:
    # Handle incoming current callbacks
    subscribe to tinkerforge/callback/industrial_dual_0_20ma_bricklet/XYZ/current
    publish '{"register": true}' to tinkerforge/register/industrial_dual_0_20ma_bricklet/XYZ/current # Register current callback

    # Set period for current (sensor 1) callback to 1s (1000ms)
    # Note: The current (sensor 1) callback is only called every second
    #       if the current (sensor 1) has changed since the last call!
    publish '{"sensor": 1, "period": 1000}' to tinkerforge/request/industrial_dual_0_20ma_bricklet/XYZ/set_current_callback_period

Threshold

Download (example-threshold.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/industrial-dual-0-20ma_bricklet/XYZ/set_debounce_period

    # Handle incoming current reached callbacks
    subscribe to tinkerforge/callback/industrial_dual_0_20ma_bricklet/XYZ/current_reached
    publish '{"register": true}' to tinkerforge/register/industrial_dual_0_20ma_bricklet/XYZ/current_reached # Register current_reached callback

    # Configure threshold for current (sensor 1) "greater than 10 mA"
    publish '{"sensor": 1, "option": "greater", "min": 10000000, "max": 0}' to tinkerforge/request/industrial_dual_0_20ma_bricklet/XYZ/set_current_callback_threshold

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_dual_0_20ma_bricklet/<UID>/get_current
Anfrage:
  • sensor – Typ: int, Wertebereich: [0 bis 1]
Antwort:
  • current – Typ: int, Einheit: 1 nA, Wertebereich: [0 bis 22505322]

Gibt die gemessenen Stromstärke des angegebenen Sensors zurück.

Es ist möglich zu erkennen ob ein IEC 60381-1-kompatibler Sensor angeschlossen ist und ob er funktionsfähig ist.

Falls die zurückgegebene Stromstärke kleiner als 4mA ist, ist wahrscheinlich kein Sensor angeschlossen oder der Sensor ist defekt. Falls die zurückgegebene Stromstärke über 20mA ist, besteht entweder ein Kurzschluss oder der Sensor ist defekt. Somit ist erkennbar ob ein Sensor angeschlossen und funktionsfähig ist.

Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen den register/industrial_dual_0_20ma_bricklet/<UID>/current Callback zu nutzen und die Periode mit request/industrial_dual_0_20ma_bricklet/<UID>/set_current_callback_period vorzugeben.

Fortgeschrittene Funktionen

request/industrial_dual_0_20ma_bricklet/<UID>/set_sample_rate
Anfrage:
  • rate – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:
  • keine Antwort

Setzt die Abtastrate auf 240, 60, 15 oder 4 Samples pro Sekunde. Die Auflösung für die Raten sind 12, 14, 16 und 18 Bit respektive.

Wert Beschreibung
0 240 Samples pro Sekunde, 12 Bit Auflösung
1 60 Samples pro Sekunde, 14 Bit Auflösung
2 15 Samples pro Sekunde, 16 Bit Auflösung
3 4 Samples pro Sekunde, 18 Bit Auflösung

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

Für rate:

  • "240_sps" = 0
  • "60_sps" = 1
  • "15_sps" = 2
  • "4_sps" = 3
request/industrial_dual_0_20ma_bricklet/<UID>/get_sample_rate
Anfrage:
  • keine Nutzdaten
Antwort:
  • rate – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Abtastrate zurück, wie von request/industrial_dual_0_20ma_bricklet/<UID>/set_sample_rate gesetzt.

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

Für rate:

  • "240_sps" = 0
  • "60_sps" = 1
  • "15_sps" = 2
  • "4_sps" = 3
request/industrial_dual_0_20ma_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 Dual 0-20mA.

Konfigurationsfunktionen für Callbacks

request/industrial_dual_0_20ma_bricklet/<UID>/set_current_callback_period
Anfrage:
  • sensor – Typ: int, Wertebereich: [0 bis 1]
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die Periode mit welcher der register/industrial_dual_0_20ma_bricklet/<UID>/current Callback für den übergebenen Sensor ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/industrial_dual_0_20ma_bricklet/<UID>/current Callback wird nur ausgelöst, wenn sich die Stromstärke seit der letzten Auslösung geändert hat.

request/industrial_dual_0_20ma_bricklet/<UID>/get_current_callback_period
Anfrage:
  • sensor – Typ: int, Wertebereich: [0 bis 1]
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/industrial_dual_0_20ma_bricklet/<UID>/set_current_callback_period gesetzt.

request/industrial_dual_0_20ma_bricklet/<UID>/set_current_callback_threshold
Anfrage:
  • sensor – Typ: int, Wertebereich: [0 bis 1]
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Schwellwert des register/industrial_dual_0_20ma_bricklet/<UID>/current_reached Callbacks für den übergebenen Sensor.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Stromstärke außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Stromstärke innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Stromstärke kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Stromstärke größer als der min Wert ist (max wird ignoriert)

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

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/industrial_dual_0_20ma_bricklet/<UID>/get_current_callback_threshold
Anfrage:
  • sensor – Typ: int, Wertebereich: [0 bis 1]
Antwort:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von request/industrial_dual_0_20ma_bricklet/<UID>/set_current_callback_threshold gesetzt.

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

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/industrial_dual_0_20ma_bricklet/<UID>/set_debounce_period
Anfrage:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Antwort:
  • keine Antwort

Setzt die Periode mit welcher der Schwellwert Callback

ausgelöst werden, wenn der Schwellwert

weiterhin erreicht bleibt.

request/industrial_dual_0_20ma_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_dual_0_20ma_bricklet/<UID>/set_debounce_period 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_dual_0_20ma_bricklet/<UID>/current
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • sensor – Typ: int, Wertebereich: [0 bis 1]
  • current – Typ: int, Einheit: 1 nA, Wertebereich: [0 bis 22505322]

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/industrial_dual_0_20ma_bricklet/<UID>/set_current_callback_period, ausgelöst. Der Payload des Callbacks ist die Stromstärke des Sensors.

Der register/industrial_dual_0_20ma_bricklet/<UID>/current Callback wird nur ausgelöst, wenn sich die Stromstärke seit der letzten Auslösung geändert hat.

register/industrial_dual_0_20ma_bricklet/<UID>/current_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • sensor – Typ: int, Wertebereich: [0 bis 1]
  • current – Typ: int, Einheit: 1 nA, Wertebereich: [0 bis 22505322]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/industrial_dual_0_20ma_bricklet/<UID>/set_current_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist die Stromstärke des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit request/industrial_dual_0_20ma_bricklet/<UID>/set_debounce_period gesetzt, ausgelöst.