MQTT - PTC Bricklet

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

setup:
    # Get current temperature
    subscribe to tinkerforge/response/ptc_bricklet/XYZ/get_temperature
    publish '' to tinkerforge/request/ptc_bricklet/XYZ/get_temperature

Callback

Download (example-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Change XYZ to the UID of your PTC Bricklet

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

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/ptc_bricklet/XYZ/set_debounce_period
    
    # Handle incoming temperature reached callbacks
    subscribe to tinkerforge/callback/ptc_bricklet/XYZ/temperature_reached
    publish '{"register": true}' to tinkerforge/register/ptc_bricklet/XYZ/temperature_reached # Register temperature_reached callback
    
    # Configure threshold for temperature "greater than 30 °C"
    publish '{"option": "greater", "min": 3000, "max": 0}' to tinkerforge/request/ptc_bricklet/XYZ/set_temperature_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/ptc_bricklet/<UID>/get_temperature
Response-Payload:
 
  • temperature -- int

Gibt die Temperatur des verbundenen Sensors zurück. Der Wertebereich ist von -246 bis 849 °C und wird in °C/100 angegeben, z.B. bedeutet ein Wert von 4223 eine gemessene Temperatur von 42,23 °C.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den register/ptc_bricklet/<UID>/temperature Callback zu nutzen und die Periode mit request/ptc_bricklet/<UID>/set_temperature_callback_period vorzugeben.

request/ptc_bricklet/<UID>/is_sensor_connected
Response-Payload:
 
  • connected -- bool

Gibt true zurück wenn ein Sensor korrekt verbunden ist.

Falls diese Funktion false zurück gibt, ist entweder kein Pt100 oder Pt1000 Sensor verbunden, der Sensor ist inkorrekt verbunden oder der Sensor selbst ist fehlerhaft.

request/ptc_bricklet/<UID>/set_wire_mode
Request-Payload:
 
  • mode -- int (hat Symbole)

Stellt die Leiter-Konfiguration des Sensors ein. Mögliche Werte sind 2, 3 und 4, dies entspricht 2-, 3- und 4-Leiter-Sensoren. Der Wert muss er Jumper-Konfiguration am Bricklet entsprechen.

Der Standardwert ist 2 = 2-Leiter.

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

für mode:

  • "2" = 2
  • "3" = 3
  • "4" = 4
request/ptc_bricklet/<UID>/get_wire_mode
Response-Payload:
 
  • mode -- int (hat Symbole)

Gibt die Leiter-Konfiguration zurück, wie von request/ptc_bricklet/<UID>/set_wire_mode gesetzt.

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

für mode:

  • "2" = 2
  • "3" = 3
  • "4" = 4

Fortgeschrittene Funktionen

request/ptc_bricklet/<UID>/get_resistance
Response-Payload:
 
  • resistance -- int

Gibt den Wert zurück, wie vom "MAX31865 Präzisions Delta-Sigma ADC" berechnet.

Der Wert kann mit den folgenden Formeln in einen Widerstand konvertiert werden:

  • Pt100: Widerstand = (Wert * 390) / 32768
  • Pt1000: Widerstand = (Wert * 3900) / 32768

Wenn der Widerstand periodisch abgefragt werden soll, wird empfohlen den register/ptc_bricklet/<UID>/resistance Callback zu nutzen und die Periode mit request/ptc_bricklet/<UID>/set_resistance_callback_period vorzugeben.

request/ptc_bricklet/<UID>/set_noise_rejection_filter
Request-Payload:
 
  • filter -- int (hat Symbole)

Setzt den Entstörfilter auf 50Hz (0) oder 60Hz (1). Störungen von 50Hz oder 60Hz Stromquellen (inklusive Oberwellen der Stromquellen-Grundfrequenz) werden um 82dB abgeschwächt.

Der Standardwert ist 0 = 50Hz.

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

für filter:

  • "50Hz" = 0
  • "60Hz" = 1
request/ptc_bricklet/<UID>/get_noise_rejection_filter
Response-Payload:
 
  • filter -- int (hat Symbole)

Gibt die Einstellung des Entstörfilters zurück, wie von request/ptc_bricklet/<UID>/set_noise_rejection_filter gesetzt.

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

für filter:

  • "50Hz" = 0
  • "60Hz" = 1
request/ptc_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 PTC.

Konfigurationsfunktionen für Callbacks

request/ptc_bricklet/<UID>/set_temperature_callback_period
Request-Payload:
 
  • period -- int

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

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

Der Standardwert ist 0.

request/ptc_bricklet/<UID>/get_temperature_callback_period
Response-Payload:
 
  • period -- int

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

request/ptc_bricklet/<UID>/set_resistance_callback_period
Request-Payload:
 
  • period -- int

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

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

Der Standardwert ist 0.

request/ptc_bricklet/<UID>/get_resistance_callback_period
Response-Payload:
 
  • period -- int

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

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

Setzt den Schwellwert für den register/ptc_bricklet/<UID>/temperature_reached Callback.

Die folgenden Optionen sind möglich:

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

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

Setzt den Schwellwert für den register/ptc_bricklet/<UID>/resistance_reached Callback.

Die folgenden Optionen sind möglich:

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

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

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

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

Gibt die Entprellperiode zurück, wie von request/ptc_bricklet/<UID>/set_debounce_period gesetzt.

request/ptc_bricklet/<UID>/set_sensor_connected_callback_configuration
Request-Payload:
 
  • enabled -- bool

Wenn dieser Callback aktiviert ist, wird der register/ptc_bricklet/<UID>/sensor_connected Callback jedes mal ausgelöst, wenn ein Pt-Sensor verbunden/getrennt wird.

Standardmäßig ist dieser Callback deaktiviert.

Neu in Version 2.0.2 (Plugin).

request/ptc_bricklet/<UID>/get_sensor_connected_callback_configuration
Response-Payload:
 
  • enabled -- bool

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

Neu in Version 2.0.2 (Plugin).

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/ptc_bricklet/<UID>/temperature
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • temperature -- int

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/ptc_bricklet/<UID>/set_temperature_callback_period, ausgelöst. Der Payload des Callbacks ist die Temperatur des verbundenen Sensors.

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

register/ptc_bricklet/<UID>/temperature_reached
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • temperature -- int

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/ptc_bricklet/<UID>/set_temperature_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist die Temperatur des verbundenen Sensors.

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

register/ptc_bricklet/<UID>/resistance
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • resistance -- int

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/ptc_bricklet/<UID>/set_resistance_callback_period, ausgelöst. Der Payload des Callbacks ist der Widerstand des verbundenen Sensors.

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

register/ptc_bricklet/<UID>/resistance_reached
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • resistance -- int

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/ptc_bricklet/<UID>/set_resistance_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist der Widerstand des verbundenen Sensors.

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

register/ptc_bricklet/<UID>/sensor_connected
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • connected -- bool

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/ptc_bricklet/<UID>/set_sensor_connected_callback_configuration gesetzten Konfiguration

Der Payload des Callbacks ist der gleiche wie bei request/ptc_bricklet/<UID>/is_sensor_connected.

Neu in Version 2.0.2 (Plugin).