MQTT - Industrial Dual Analog In Bricklet

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

setup:
    # Get current voltage from channel 1
    subscribe to tinkerforge/response/industrial_dual_analog_in_bricklet/XYZ/get_voltage
    publish '{"channel": 1}' to tinkerforge/request/industrial_dual_analog_in_bricklet/XYZ/get_voltage

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 Analog In Bricklet

setup:
    # Handle incoming voltage callbacks
    subscribe to tinkerforge/callback/industrial_dual_analog_in_bricklet/XYZ/voltage
    publish '{"register": true}' to tinkerforge/register/industrial_dual_analog_in_bricklet/XYZ/voltage # Register voltage callback
    
    # Set period for voltage (channel 1) callback to 1s (1000ms)
    # Note: The voltage (channel 1) callback is only called every second
    #       if the voltage (channel 1) has changed since the last call!
    publish '{"channel": 1, "period": 1000}' to tinkerforge/request/industrial_dual_analog_in_bricklet/XYZ/set_voltage_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 Analog In Bricklet

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/industrial-dual-analog-in_bricklet/XYZ/set_debounce_period
    
    # Handle incoming voltage reached callbacks
    subscribe to tinkerforge/callback/industrial_dual_analog_in_bricklet/XYZ/voltage_reached
    publish '{"register": true}' to tinkerforge/register/industrial_dual_analog_in_bricklet/XYZ/voltage_reached # Register voltage_reached callback
    
    # Configure threshold for voltage (channel 1) "greater than 10 V"
    publish '{"channel": 1, "option": "greater", "min": 10000, "max": 0}' to tinkerforge/request/industrial_dual_analog_in_bricklet/XYZ/set_voltage_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_analog_in_bricklet/<UID>/get_voltage
Anfrage:
  • channel – Typ: int, Wertebereich: [0 bis 1]
Antwort:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

Gibt die Spannung für den übergebenen Kanal zurück.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den register/industrial_dual_analog_in_bricklet/<UID>/voltage Callback zu nutzen und die Periode mit request/industrial_dual_analog_in_bricklet/<UID>/set_voltage_callback_period vorzugeben.

Fortgeschrittene Funktionen

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

Setzt die Abtastrate. Der Wertebereich der verfügbare Abtastraten liegt zwischen 1 Wert pro Sekunde und 976 Werte pro Sekunde. Ein Verringern der Abtastrate wird auch das Rauschen auf den Daten verringern.

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

Für rate:

  • "976_sps" = 0
  • "488_sps" = 1
  • "244_sps" = 2
  • "122_sps" = 3
  • "61_sps" = 4
  • "4_sps" = 5
  • "2_sps" = 6
  • "1_sps" = 7
request/industrial_dual_analog_in_bricklet/<UID>/get_sample_rate
Anfrage:
  • keine Nutzdaten
Antwort:
  • rate – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 6

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

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

Für rate:

  • "976_sps" = 0
  • "488_sps" = 1
  • "244_sps" = 2
  • "122_sps" = 3
  • "61_sps" = 4
  • "4_sps" = 5
  • "2_sps" = 6
  • "1_sps" = 7
request/industrial_dual_analog_in_bricklet/<UID>/set_calibration
Anfrage:
  • offset – Typ: [int, ...], Länge: 2, Wertebereich: [-8388608 bis 8388607]
  • gain – Typ: [int, ...], Länge: 2, Wertebereich: [-8388608 bis 8388607]
Antwort:
  • keine Antwort

Setzt Offset und Gain der MCP3911 internen Kalibrierungsregister.

Siehe MCP3911 Datenblatt 7.7 und 7.8. Das Industrial Dual Analog In Bricklet wird von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte nicht notwendig sein.

request/industrial_dual_analog_in_bricklet/<UID>/get_calibration
Anfrage:
  • keine Nutzdaten
Antwort:
  • offset – Typ: [int, ...], Länge: 2, Wertebereich: [-8388608 bis 8388607]
  • gain – Typ: [int, ...], Länge: 2, Wertebereich: [-8388608 bis 8388607]

Gibt die Kalibrierung zurück, wie von request/industrial_dual_analog_in_bricklet/<UID>/set_calibration gesetzt.

request/industrial_dual_analog_in_bricklet/<UID>/get_adc_values
Anfrage:
  • keine Nutzdaten
Antwort:
  • value – Typ: [int, ...], Länge: 2, Wertebereich: [-8388608 bis 8388607]

Gibt die ADC-Werte des MCP3911 ICs zurück. Diese Funktion wird für die Kalibrierung benötigt, siehe request/industrial_dual_analog_in_bricklet/<UID>/set_calibration.

request/industrial_dual_analog_in_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 Analog In.

Konfigurationsfunktionen für Callbacks

request/industrial_dual_analog_in_bricklet/<UID>/set_voltage_callback_period
Anfrage:
  • channel – 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_analog_in_bricklet/<UID>/voltage Callback für den übergebenen Kanal ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/industrial_dual_analog_in_bricklet/<UID>/voltage Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

request/industrial_dual_analog_in_bricklet/<UID>/get_voltage_callback_period
Anfrage:
  • channel – 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_analog_in_bricklet/<UID>/set_voltage_callback_period gesetzt.

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

Setzt den Schwellwert des register/industrial_dual_analog_in_bricklet/<UID>/voltage_reached Callbacks für den übergebenen Kanal.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Spannung außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Spannung innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Spannung kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Spannung 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_analog_in_bricklet/<UID>/get_voltage_callback_threshold
Anfrage:
  • channel – Typ: int, Wertebereich: [0 bis 1]
Antwort:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von request/industrial_dual_analog_in_bricklet/<UID>/set_voltage_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_analog_in_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_analog_in_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_analog_in_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_analog_in_bricklet/<UID>/voltage
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • channel – Typ: int, Wertebereich: [0 bis 1]
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/industrial_dual_analog_in_bricklet/<UID>/set_voltage_callback_period, ausgelöst. Der Payload des Callbacks ist die Spannung des Kanals.

Der register/industrial_dual_analog_in_bricklet/<UID>/voltage Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

register/industrial_dual_analog_in_bricklet/<UID>/voltage_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • channel – Typ: int, Wertebereich: [0 bis 1]
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/industrial_dual_analog_in_bricklet/<UID>/set_voltage_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist die Spannung des Kanals.

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