MQTT - Voltage/Current Bricklet

Dies ist die Beschreibung der MQTT API Bindings für das Voltage/Current Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Voltage/Current 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
 7
 8
 9
10
# Change XYZ to the UID of your Voltage/Current Bricklet

setup:
    # Get current voltage
    subscribe to tinkerforge/response/voltage_current_bricklet/XYZ/get_voltage
    publish '' to tinkerforge/request/voltage_current_bricklet/XYZ/get_voltage
    
    # Get current current
    subscribe to tinkerforge/response/voltage_current_bricklet/XYZ/get_current
    publish '' to tinkerforge/request/voltage_current_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 Voltage/Current Bricklet

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

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/voltage-current_bricklet/XYZ/set_debounce_period
    
    # Handle incoming power reached callbacks
    subscribe to tinkerforge/callback/voltage_current_bricklet/XYZ/power_reached
    publish '{"register": true}' to tinkerforge/register/voltage_current_bricklet/XYZ/power_reached # Register power_reached callback
    
    # Configure threshold for power "greater than 10 W"
    publish '{"option": "greater", "min": 10000, "max": 0}' to tinkerforge/request/voltage_current_bricklet/XYZ/set_power_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/voltage_current_bricklet/<UID>/get_current
Response-Payload:
 
  • current -- int

Gibt die gemessenen Stromstärke zurück. Der Wert ist in mA und im Bereich von -20000mA bis 20000mA.

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

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

Gibt die gemessenen Spannung zurück. Der Wert ist in mV und im Bereich von 0mV bis 36000mV.

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

request/voltage_current_bricklet/<UID>/get_power
Response-Payload:
 
  • power -- int

Gibt die gemessenen Leistung zurück. Der Wert ist in mW und im Bereich von 0mW bis 720000mW.

Wenn die Leistung periodisch abgefragt werden soll, wird empfohlen den register/voltage_current_bricklet/<UID>/power Callback zu nutzen und die Periode mit request/voltage_current_bricklet/<UID>/set_power_callback_period vorzugeben.

request/voltage_current_bricklet/<UID>/set_configuration
Request-Payload:
 
  • averaging -- int (hat Symbole)
  • voltage_conversion_time -- int
  • current_conversion_time -- int

Setzt die Konfiguration des Voltage/Current Bricklet. Es ist möglich die Anzahl für die Durchschnittsbildung, und die Wandlungszeit für Spannung und Stromstärke zu definieren.

Durchschnittsbildung:

Wert Anzahl
0 1
1 4
2 16
3 64
4 128
5 256
6 512
>=7 1024

Wandlungszeit für Spannung/Stromstärke:

Wert Wandlungszeit
0 140µs
1 204µs
2 332µs
3 588µs
4 1.1ms
5 2.116ms
6 4.156ms
>=7 8.244ms

Die Standardwerte sind 3, 4 und 4 (64, 1.1ms, 1.1ms) für die Durchschnittsbildung und die Spannungs/Stromstärkenwandlungszeit.

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

für averaging:

  • "1" = 0
  • "4" = 1
  • "16" = 2
  • "64" = 3
  • "128" = 4
  • "256" = 5
  • "512" = 6
  • "1024" = 7
request/voltage_current_bricklet/<UID>/get_configuration
Response-Payload:
 
  • averaging -- int (hat Symbole)
  • voltage_conversion_time -- int
  • current_conversion_time -- int

Gibt die Konfiguration zurück, wie von request/voltage_current_bricklet/<UID>/set_configuration gesetzt.

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

für averaging:

  • "1" = 0
  • "4" = 1
  • "16" = 2
  • "64" = 3
  • "128" = 4
  • "256" = 5
  • "512" = 6
  • "1024" = 7

Fortgeschrittene Funktionen

request/voltage_current_bricklet/<UID>/set_calibration
Request-Payload:
 
  • gain_multiplier -- int
  • gain_divisor -- int

Da der Shunt-Widerstand über den die Stromstärke gemessen wird keine perfekte Genauigkeit hat, ist es nötig einen Multiplikator und einen Divisor zu setzen falls sehr genaue Messwerte nötig sind.

Zum Beispiel: Wenn eine Messung von 1000mA erwartet wird, das Voltage/Current Bricklet aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden.

request/voltage_current_bricklet/<UID>/get_calibration
Response-Payload:
 
  • gain_multiplier -- int
  • gain_divisor -- int

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

request/voltage_current_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 Voltage/Current.

Konfigurationsfunktionen für Callbacks

request/voltage_current_bricklet/<UID>/set_current_callback_period
Request-Payload:
 
  • period -- int

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

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

Der Standardwert ist 0.

request/voltage_current_bricklet/<UID>/get_current_callback_period
Response-Payload:
 
  • period -- int

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

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

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

Der register/voltage_current_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/voltage_current_bricklet/<UID>/get_voltage_callback_period
Response-Payload:
 
  • period -- int

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

request/voltage_current_bricklet/<UID>/set_power_callback_period
Request-Payload:
 
  • period -- int

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

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

Der Standardwert ist 0.

request/voltage_current_bricklet/<UID>/get_power_callback_period
Response-Payload:
 
  • period -- int

Gibt die Periode zurück, wie von request/voltage_current_bricklet/<UID>/get_power_callback_period gesetzt

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

Setzt den Schwellwert für den register/voltage_current_bricklet/<UID>/current_reached Callback.

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)

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/voltage_current_bricklet/<UID>/get_current_callback_threshold
Response-Payload:
 
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

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

Setzt den Schwellwert für den register/voltage_current_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/voltage_current_bricklet/<UID>/get_voltage_callback_threshold
Response-Payload:
 
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

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

Setzt den Schwellwert für den register/voltage_current_bricklet/<UID>/power_reached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Leistung außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Leistung innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Leistung kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Leistung 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/voltage_current_bricklet/<UID>/get_power_callback_threshold
Response-Payload:
 
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

Gibt den Schwellwert zurück, wie von request/voltage_current_bricklet/<UID>/set_power_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/voltage_current_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/voltage_current_bricklet/<UID>/get_debounce_period
Response-Payload:
 
  • debounce -- int

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

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

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

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

register/voltage_current_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/voltage_current_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/voltage_current_bricklet/<UID>/voltage[/<SUFFIX>]-Topic veröffentlicht.

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

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

register/voltage_current_bricklet/<UID>/power
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • power -- int

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/voltage_current_bricklet/<UID>/set_power_callback_period, ausgelöst. Der Payload des Callbacks ist die Leistung des Sensors.

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

register/voltage_current_bricklet/<UID>/current_reached
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • current -- int

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/voltage_current_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/voltage_current_bricklet/<UID>/set_debounce_period gesetzt, ausgelöst.

register/voltage_current_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/voltage_current_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/voltage_current_bricklet/<UID>/voltage_reached[/<SUFFIX>]-Topic veröffentlicht.

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

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

register/voltage_current_bricklet/<UID>/power_reached
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • power -- int

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

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

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