MQTT - Analog In Bricklet 2.0

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

Simple

Download (example-simple.txt)

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

setup:
    # Get current voltage
    subscribe to tinkerforge/response/analog_in_v2_bricklet/XYZ/get_voltage
    publish '' to tinkerforge/request/analog_in_v2_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 Analog In Bricklet 2.0

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

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/analog-in-v2_bricklet/XYZ/set_debounce_period
    
    # Handle incoming voltage reached callbacks
    subscribe to tinkerforge/callback/analog_in_v2_bricklet/XYZ/voltage_reached
    publish '{"register": true}' to tinkerforge/register/analog_in_v2_bricklet/XYZ/voltage_reached # Register voltage_reached callback
    
    # Configure threshold for voltage "smaller than 5 V"
    publish '{"option": "smaller", "min": 5000, "max": 0}' to tinkerforge/request/analog_in_v2_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"-Attribut enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/analog_in_v2_bricklet/<UID>/get_voltage
Response-Payload:
  • voltage -- int

Gibt die gemessene Spannung zurück. Der Wert ist in mV und im Bereich von 0 bis 42V. Die Auflösung ca. 10mV.

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

Fortgeschrittene Funktionen

request/analog_in_v2_bricklet/<UID>/get_analog_value
Response-Payload:
  • value -- int

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den register/analog_in_v2_bricklet/<UID>/analog_value Callback zu nutzen und die Periode mit request/analog_in_v2_bricklet/<UID>/set_analog_value_callback_period vorzugeben.

request/analog_in_v2_bricklet/<UID>/set_moving_average
Request-Payload:
  • average -- int

Setzt die Länge eines gleitenden Mittelwerts für die Spannung.

Wenn die Länge auf 1 gesetzt wird, ist das Averaging aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 1-50.

Der Standardwert ist 50.

request/analog_in_v2_bricklet/<UID>/get_moving_average
Response-Payload:
  • average -- int

Gibt die Länge des gleitenden Mittelwerts zurück, wie von request/analog_in_v2_bricklet/<UID>/set_moving_average gesetzt.

request/analog_in_v2_bricklet/<UID>/get_identity
Response-Payload:
  • uid -- string
  • connected_uid -- string
  • position -- string
  • hardware_version -- [int,int,int]
  • firmware_version -- [int,int,int]
  • device_identifier -- int (hat Symbole)
  • _display_name -- 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 kann 'a', 'b', 'c' oder 'd' sein.

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 Analog In 2.0.

Konfigurationsfunktionen für Callbacks

request/analog_in_v2_bricklet/<UID>/set_voltage_callback_period
Request-Payload:
  • period -- int

Setzt die Periode in ms mit welcher der register/analog_in_v2_bricklet/<UID>/voltage Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

Der Standardwert ist 0.

request/analog_in_v2_bricklet/<UID>/get_voltage_callback_period
Response-Payload:
  • period -- int

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

request/analog_in_v2_bricklet/<UID>/set_analog_value_callback_period
Request-Payload:
  • period -- int

Setzt die Periode in ms mit welcher der register/analog_in_v2_bricklet/<UID>/analog_value Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/analog_in_v2_bricklet/<UID>/analog_value Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

request/analog_in_v2_bricklet/<UID>/get_analog_value_callback_period
Response-Payload:
  • period -- int

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

request/analog_in_v2_bricklet/<UID>/set_voltage_callback_threshold
Request-Payload:
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

Setzt den Schwellwert für den register/analog_in_v2_bricklet/<UID>/voltage_reached Callback.

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)

Der Standardwert ist ('x', 0, 0).

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

für option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/analog_in_v2_bricklet/<UID>/get_voltage_callback_threshold
Response-Payload:
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

Gibt den Schwellwert zurück, wie von request/analog_in_v2_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/analog_in_v2_bricklet/<UID>/set_analog_value_callback_threshold
Request-Payload:
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

Setzt den Schwellwert für den register/analog_in_v2_bricklet/<UID>/analog_value_reached Callback.

Die folgenden Optionen sind möglich:

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

Der Standardwert ist ('x', 0, 0).

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

für option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/analog_in_v2_bricklet/<UID>/get_analog_value_callback_threshold
Response-Payload:
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

Gibt den Schwellwert zurück, wie von request/analog_in_v2_bricklet/<UID>/set_analog_value_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/analog_in_v2_bricklet/<UID>/set_debounce_period
Request-Payload:
  • debounce -- int

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

request/analog_in_v2_bricklet/<UID>/get_debounce_period
Response-Payload:
  • debounce -- int

Gibt die Entprellperiode zurück, wie von request/analog_in_v2_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/analog_in_v2_bricklet/<UID>/voltage
Request-Payload:
  • register -- bool
Response-Payload:
  • voltage -- int

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

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

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

register/analog_in_v2_bricklet/<UID>/analog_value
Request-Payload:
  • register -- bool
Response-Payload:
  • value -- int

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/analog_in_v2_bricklet/<UID>/set_analog_value_callback_period, ausgelöst. Der Payload des Callbacks ist der Analogwert des Sensors.

Der register/analog_in_v2_bricklet/<UID>/analog_value Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

register/analog_in_v2_bricklet/<UID>/voltage_reached
Request-Payload:
  • register -- bool
Response-Payload:
  • voltage -- int

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

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

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

register/analog_in_v2_bricklet/<UID>/analog_value_reached
Request-Payload:
  • register -- bool
Response-Payload:
  • value -- int

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/analog_in_v2_bricklet/<UID>/set_analog_value_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist der Analogwert des Sensors.

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