Modbus - Temperature Bricklet

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

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletTemperature.get_temperature
Funktions ID:

1

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

Gibt die Temperatur des Sensors zurück. Der Wertebereich ist von -2500 bis 8500 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 CALLBACK_TEMPERATURE Callback zu nutzen und die Periode mit set_temperature_callback_period vorzugeben.

Fortgeschrittene Funktionen

BrickletTemperature.set_i2c_mode
Funktions ID:

10

Anfrage:
  • mode -- uint8
Antwort:

keine Antwort

Setzt den I2C Modus. Mögliche Modi sind:

  • 0: Fast (400kHz, Standard)
  • 1: Slow (100kHz)

Wenn Probleme mit offensichtlichen Ausreißern in den Temperature Bricklet Messungen auftreten, können diese eventuell aufgrund von elektromagnetischen Störungen sein. In diesem Fall kann es helfen die I2C Geschwindigkeit zu verringern.

Falls in einem System ein hoher Durchsatz an Nachrichten erwünscht ist, sollte die I2C Geschwindigkeit allerdings nicht verringert werden.

Neu in Version 2.0.1 (Plugin).

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

  • 0: fast, für mode
  • 1: slow, für mode
BrickletTemperature.get_i2c_mode
Funktions ID:

11

Anfrage:

keine Nutzdaten

Antwort:
  • mode -- uint8

Gibt den I2C Modus zurück, wie von set_i2c_mode gesetzt.

Neu in Version 2.0.1 (Plugin).

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

  • 0: fast, für mode
  • 1: slow, für mode
BrickletTemperature.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

BrickletTemperature.set_temperature_callback_period
Funktions ID:

2

Anfrage:
  • period -- uint32
Antwort:

keine Antwort

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

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

Der Standardwert ist 0.

BrickletTemperature.get_temperature_callback_period
Funktions ID:

3

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

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

BrickletTemperature.set_temperature_callback_threshold
Funktions ID:

4

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

keine Antwort

Setzt den Schwellwert für den CALLBACK_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 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
BrickletTemperature.get_temperature_callback_threshold
Funktions ID:

5

Anfrage:

keine Nutzdaten

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

Gibt den Schwellwert zurück, wie von set_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
BrickletTemperature.set_debounce_period
Funktions ID:

6

Anfrage:
  • debounce -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

BrickletTemperature.get_debounce_period
Funktions ID:

7

Anfrage:

keine Nutzdaten

Antwort:
  • debounce -- uint32

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

Callbacks

BrickletTemperature.CALLBACK_TEMPERATURE
Funktions ID:

8

Antwort:
  • temperature -- int16

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

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

BrickletTemperature.CALLBACK_TEMPERATURE_REACHED
Funktions ID:

9

Antwort:
  • temperature -- int16

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

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