Modbus - Temperature IR Bricklet

Dies ist die Beschreibung des Modbus Protokolls für das Temperature IR Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Temperature IR Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletTemperatureIR.get_ambient_temperature
Funktions ID:

1

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

Gibt die Umgebungstemperatur des Sensors zurück. Der Wertebereich ist von -400 bis 1250 und wird in °C/10 angegeben, z.B. bedeutet ein Wert von 423 eine gemessene Umgebungstemperatur von 42,3 °C.

Wenn die Umgebungstemperatur periodisch abgefragt werden soll, wird empfohlen den CALLBACK_AMBIENT_TEMPERATURE Callback zu nutzen und die Periode mit set_ambient_temperature_callback_period vorzugeben.

BrickletTemperatureIR.get_object_temperature
Funktions ID:

2

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

Gibt die Objekttemperatur des Sensors zurück, z.B. die Temperatur der Oberfläche auf welche der Sensor zielt. Der Wertebereich ist von -700 bis 3800 und wird in °C/10 angegeben, z.B. bedeutet ein Wert von 3001 eine gemessene Temperatur von 300,1 °C auf der Oberfläche des Objektes.

Die Temperatur von unterschiedlichen Materialien ist abhängig von ihrem Emissionsgrad. Der Emissionsgrad des Materials kann mit set_emissivity gesetzt werden.

Wenn die Objekttemperatur periodisch abgefragt werden soll, wird empfohlen den CALLBACK_OBJECT_TEMPERATURE Callback zu nutzen und die Periode mit set_object_temperature_callback_period vorzugeben.

Fortgeschrittene Funktionen

BrickletTemperatureIR.set_emissivity
Funktions ID:

3

Anfrage:
  • emissivity -- uint16
Antwort:

keine Antwort

Setzt den Emissionsgrad, welcher zur Berechnung der Oberflächentemperatur benutzt wird, wie von get_object_temperature zurückgegeben.

Der Emissionsgrad wird normalerweise als Wert zwischen 0,0 und 1,0 angegeben. Eine Liste von Emissionsgraden unterschiedlicher Materialien ist hier zu finden.

Der Parameter von set_emissivity muss mit eine Faktor von 65535 (16-Bit) vorgegeben werden. Beispiel: Ein Emissionsgrad von 0,1 kann mit dem Wert 6553 gesetzt werden, ein Emissionsgrad von 0,5 mit dem Wert 32767 und so weiter.

Bemerkung

Wenn eine exakte Messung der Objekttemperatur notwendig ist, ist es entscheidend eine exakten Emissionsgrad anzugeben.

Der Standard Emissionsgrad ist 1,0 (Wert von 65535) und der minimale Emissionsgrad welcher der Sensor verarbeiten kann ist 0,1 (Wert von 6553).

Der Emissionsgrad wird in nicht-flüchtigem Speicher gespeichert und wird auch noch einem Neustart weiter genutzt.

BrickletTemperatureIR.get_emissivity
Funktions ID:

4

Anfrage:

keine Nutzdaten

Antwort:
  • emissivity -- uint16

Gibt den Emissionsgrad zurück, wie von set_emissivity gesetzt.

BrickletTemperatureIR.get_identity
Funktions ID:

255

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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. 

Konfigurationsfunktionen für Callbacks

BrickletTemperatureIR.set_ambient_temperature_callback_period
Funktions ID:

5

Anfrage:
  • period -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms mit welcher der CALLBACK_AMBIENT_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der CALLBACK_AMBIENT_TEMPERATURE Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

BrickletTemperatureIR.get_ambient_temperature_callback_period
Funktions ID:

6

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

Gibt die Periode zurück, wie von set_ambient_temperature_callback_period gesetzt.

BrickletTemperatureIR.set_object_temperature_callback_period
Funktions ID:

7

Anfrage:
  • period -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms mit welcher der CALLBACK_OBJECT_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der CALLBACK_OBJECT_TEMPERATURE Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

BrickletTemperatureIR.get_object_temperature_callback_period
Funktions ID:

8

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

Gibt die Periode zurück, wie von set_object_temperature_callback_period gesetzt.

BrickletTemperatureIR.set_ambient_temperature_callback_threshold
Funktions ID:

9

Anfrage:
  • option -- char
  • min -- int16
  • max -- int16
Antwort:

keine Antwort

Setzt den Schwellwert für den CALLBACK_AMBIENT_TEMPERATURE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletTemperatureIR.get_ambient_temperature_callback_threshold
Funktions ID:

10

Anfrage:

keine Nutzdaten

Antwort:
  • option -- char
  • min -- int16
  • max -- int16

Gibt den Schwellwert zurück, wie von set_ambient_temperature_callback_threshold gesetzt.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletTemperatureIR.set_object_temperature_callback_threshold
Funktions ID:

11

Anfrage:
  • option -- char
  • min -- int16
  • max -- int16
Antwort:

keine Antwort

Setzt den Schwellwert für den CALLBACK_OBJECT_TEMPERATURE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletTemperatureIR.get_object_temperature_callback_threshold
Funktions ID:

12

Anfrage:

keine Nutzdaten

Antwort:
  • option -- char
  • min -- int16
  • max -- int16

Gibt den Schwellwert zurück, wie von set_object_temperature_callback_threshold gesetzt.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletTemperatureIR.set_debounce_period
Funktions ID:

13

Anfrage:
  • debounce -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

BrickletTemperatureIR.get_debounce_period
Funktions ID:

14

Anfrage:

keine Nutzdaten

Antwort:
  • debounce -- uint32

Gibt die Entprellperiode zurück, wie von set_debounce_period gesetzt.

Callbacks

BrickletTemperatureIR.CALLBACK_AMBIENT_TEMPERATURE
Funktions ID:

15

Antwort:
  • temperature -- int16

Dieser Callback wird mit der Periode, wie gesetzt mit set_ambient_temperature_callback_period, ausgelöst. Der Rückgabewert ist die Temperatur des Sensors.

Der CALLBACK_AMBIENT_TEMPERATURE Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE
Funktions ID:

16

Antwort:
  • temperature -- int16

Dieser Callback wird mit der Periode, wie gesetzt mit set_object_temperature_callback_period, ausgelöst. Der Rückgabewert ist die Objekttemperatur des Sensors.

Der CALLBACK_OBJECT_TEMPERATURE Callback wird nur ausgelöst, wenn sich die Objekttemperatur seit der letzten Auslösung geändert hat.

BrickletTemperatureIR.CALLBACK_AMBIENT_TEMPERATURE_REACHED
Funktions ID:

17

Antwort:
  • temperature -- int16

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_ambient_temperature_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist die Umgebungstemperatur des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set_debounce_period gesetzt, ausgelöst.

BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE_REACHED
Funktions ID:

18

Antwort:
  • temperature -- int16

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_object_temperature_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist die Objekttemperatur des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set_debounce_period gesetzt, ausgelöst.