TCP/IP - Humidity Bricklet 2.0

Dies ist die Beschreibung des TCP/IP Protokolls für das Humidity Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Humidity Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen

BrickletHumidityV2.get_humidity
Funktions ID:

1

Anfrage:

keine Nutzdaten

Antwort:
  • humidity -- uint16

Gibt die gemessene Luftfeuchtigkeit des Sensors zurück. Der Wertebereich ist von 0 bis 10000 und wird in %RH/100 angegeben (relative Luftfeuchtigkeit), z.B. bedeutet ein Wert von 4223 eine gemessene Luftfeuchtigkeit von 42,23 %RH.

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_HUMIDITY Callback verwendet werden. Der Callback wird mit der Funktion set_humidity_callback_configuration konfiguriert.

BrickletHumidityV2.get_temperature
Funktions ID:

5

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

Gibt die gemessene Temperatur des Sensors zurück. Der Wertebereich ist von -4000 bis 16500 und wird in °C/100 angegeben, z.B. bedeutet ein Wert von 3200 eine gemessene Temperatur von 32,00 °C.

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_TEMPERATURE Callback verwendet werden. Der Callback wird mit der Funktion set_temperature_callback_configuration konfiguriert.

BrickletHumidityV2.set_heater_configuration
Funktions ID:

9

Anfrage:
  • heater_config -- uint8
Antwort:

keine Antwort

Aktiviert/deaktiviert das Heizelement. Das Heizelement kann genutzt werden um den Sensor bei extremer Feuchtigkeit zu trocknen.

Standardmäßig ist das Heizelement deaktiviert.

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

  • 0: disabled, für heater_config
  • 1: enabled, für heater_config
BrickletHumidityV2.get_heater_configuration
Funktions ID:

10

Anfrage:

keine Nutzdaten

Antwort:
  • heater_config -- uint8

Gibt die Heizelement-Konfiguration zurück, wie von set_heater_configuration gesetzt.

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

  • 0: disabled, für heater_config
  • 1: enabled, für heater_config
BrickletHumidityV2.set_moving_average_configuration
Funktions ID:

11

Anfrage:
  • moving_average_length_humidity -- uint16
  • moving_average_length_temperature -- uint16
Antwort:

keine Antwort

Setzt die Länge eines gleitenden Mittelwerts für die Luftfeuchtigkeit und Temperatur.

Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 1-1000.

Einer neue Wert wird alle 50ms* gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von 50s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

Der Standardwert ist 5.

* In Firmware Version 2.0.3 haben wir die Funktion set_samples_per_second hinzugefügt. Diese konfiguriert die Messfrequenz. Da eine hohe Messfrequenz zu Selbsterhitzung führen kann haben wir die Standardeinstellung von 20 SPS auf 1 SPS geändert. Mit einer Messung pro Sekunde entspricht eine Mittelwert-Länge von 1000 einem Zeitfenster von 1000 Sekunden!

BrickletHumidityV2.get_moving_average_configuration
Funktions ID:

12

Anfrage:

keine Nutzdaten

Antwort:
  • moving_average_length_humidity -- uint16
  • moving_average_length_temperature -- uint16

Gibt die Moving Average-Konfiguration zurück, wie von set_moving_average_configuration gesetzt.

BrickletHumidityV2.set_samples_per_second
Funktions ID:

13

Anfrage:
  • sps -- uint8
Antwort:

keine Antwort

Setzt die Messungen pro Sekunde mit denen neue Luftfeuchte/Temperatur-Werte vom HDC1080 Sensor gelesen werden.

Wir haben diese Funktion hinzugefügt, da eine hohe Messfrequenz zu einer Selbsterhitzung des Sensors führen kann. Diese kann die Temperaturmessung verfälschen.

Wenn wenig Messwerte benötigt werden kann die Frequenz auf bis zu 0,1 Messungen pro Sekunde verringert werden um einen Fehler durch Selbsterhitzung möglichst weit zu minimieren.

Vor Version 2.0.3 wurden 30 Messungen pro Sekunde gemacht. Der neue Standardwert seit 2.0.3 ist 1 Messung pro Sekunde.

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

  • 0: 20, für sps
  • 1: 10, für sps
  • 2: 5, für sps
  • 3: 1, für sps
  • 4: 02, für sps
  • 5: 01, für sps

Neu in Version 2.0.3 (Plugin).

BrickletHumidityV2.get_samples_per_second
Funktions ID:

14

Anfrage:

keine Nutzdaten

Antwort:
  • sps -- uint8

Gibt die Messwerte pro Sekunde zurück, wie von set_samples_per_second gesetzt.

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

  • 0: 20, für sps
  • 1: 10, für sps
  • 2: 5, für sps
  • 3: 1, für sps
  • 4: 02, für sps
  • 5: 01, für sps

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen

BrickletHumidityV2.get_spitfp_error_count
Funktions ID:

234

Anfrage:

keine Nutzdaten

Antwort:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletHumidityV2.set_bootloader_mode
Funktions ID:

235

Anfrage:
  • mode -- uint8
Antwort:
  • status -- uint8

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
  • 0: ok, für status
  • 1: invalid mode, für status
  • 2: no change, für status
  • 3: entry function not present, für status
  • 4: device identifier incorrect, für status
  • 5: crc mismatch, für status
BrickletHumidityV2.get_bootloader_mode
Funktions ID:

236

Anfrage:

keine Nutzdaten

Antwort:
  • mode -- uint8

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

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

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
BrickletHumidityV2.set_write_firmware_pointer
Funktions ID:

237

Anfrage:
  • pointer -- uint32
Antwort:

keine Antwort

Setzt den Firmware-Pointer für write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletHumidityV2.write_firmware
Funktions ID:

238

Anfrage:
  • data -- uint8[64]
Antwort:
  • status -- uint8

Schreibt 64 Bytes Firmware an die Position die vorher von set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletHumidityV2.set_status_led_config
Funktions ID:

239

Anfrage:
  • config -- uint8
Antwort:

keine Antwort

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletHumidityV2.get_status_led_config
Funktions ID:

240

Anfrage:

keine Nutzdaten

Antwort:
  • config -- uint8

Gibt die Konfiguration zurück, wie von set_status_led_config gesetzt.

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

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletHumidityV2.get_chip_temperature
Funktions ID:

242

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletHumidityV2.reset
Funktions ID:243
Anfrage:keine Nutzdaten
Antwort:keine Antwort

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletHumidityV2.write_uid
Funktions ID:

248

Anfrage:
  • uid -- uint32
Antwort:

keine Antwort

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletHumidityV2.read_uid
Funktions ID:

249

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- uint32

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletHumidityV2.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

BrickletHumidityV2.set_humidity_callback_configuration
Funktions ID:

2

Anfrage:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- uint16
  • max -- uint16
Antwort:

keine Antwort

Die Periode in ms ist die Periode mit der der CALLBACK_HUMIDITY Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den CALLBACK_HUMIDITY Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, '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
BrickletHumidityV2.get_humidity_callback_configuration
Funktions ID:

3

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- uint16
  • max -- uint16

Gibt die Callback-Konfiguration zurück, wie mittels set_humidity_callback_configuration 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
BrickletHumidityV2.set_temperature_callback_configuration
Funktions ID:

6

Anfrage:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int16
  • max -- int16
Antwort:

keine Antwort

Die Periode in ms ist die Periode mit der der CALLBACK_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den CALLBACK_TEMPERATURE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, '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
BrickletHumidityV2.get_temperature_callback_configuration
Funktions ID:

7

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int16
  • max -- int16

Gibt die Callback-Konfiguration zurück, wie mittels set_temperature_callback_configuration 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

Callbacks

BrickletHumidityV2.CALLBACK_HUMIDITY
Funktions ID:

4

Antwort:
  • humidity -- uint16

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_humidity_callback_configuration gesetzten Konfiguration

Der Rückgabewert ist der gleiche wie get_humidity.

BrickletHumidityV2.CALLBACK_TEMPERATURE
Funktions ID:

8

Antwort:
  • temperature -- int16

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_temperature_callback_configuration gesetzten Konfiguration

Der Rückgabewert ist der gleiche wie get_temperature.