C# - Humidity Bricklet 2.0

Dies ist die Beschreibung der C# API Bindings 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.

Eine Installationanleitung für die C# API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.cs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Humidity Bricklet 2.0

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletHumidityV2 h = new BrickletHumidityV2(UID, ipcon); // Create device object

        ipcon.Connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Get current humidity
        int humidity = h.GetHumidity();
        Console.WriteLine("Humidity: " + humidity/100.0 + " %RH");

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Callback

Download (ExampleCallback.cs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Humidity Bricklet 2.0

    // Callback function for humidity callback
    static void HumidityCB(BrickletHumidityV2 sender, int humidity)
    {
        Console.WriteLine("Humidity: " + humidity/100.0 + " %RH");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletHumidityV2 h = new BrickletHumidityV2(UID, ipcon); // Create device object

        ipcon.Connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Register humidity callback to function HumidityCB
        h.HumidityCallback += HumidityCB;

        // Set period for humidity callback to 1s (1000ms) without a threshold
        h.SetHumidityCallbackConfiguration(1000, false, 'x', 0, 0);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Threshold

Download (ExampleThreshold.cs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Humidity Bricklet 2.0

    // Callback function for humidity callback
    static void HumidityCB(BrickletHumidityV2 sender, int humidity)
    {
        Console.WriteLine("Humidity: " + humidity/100.0 + " %RH");
        Console.WriteLine("Recommended humidity for human comfort is 30 to 60 %RH.");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletHumidityV2 h = new BrickletHumidityV2(UID, ipcon); // Create device object

        ipcon.Connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Register humidity callback to function HumidityCB
        h.HumidityCallback += HumidityCB;

        // Configure threshold for humidity "outside of 30 to 60 %RH"
        // with a debounce period of 10s (10000ms)
        h.SetHumidityCallbackConfiguration(10000, false, 'o', 30*100, 60*100);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

API

Prinzipiell kann jede Funktion der C# Bindings, welche einen Wert zurück gibt eine Tinkerforge.TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Da C# nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletHumidityV2(String uid, IPConnection ipcon)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

BrickletHumidityV2 humidityV2 = new BrickletHumidityV2("YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

int BrickletHumidityV2.GetHumidity()

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 HumidityCallback Callback verwendet werden. Der Callback wird mit der Funktion SetHumidityCallbackConfiguration() konfiguriert.

short BrickletHumidityV2.GetTemperature()

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 TemperatureCallback Callback verwendet werden. Der Callback wird mit der Funktion SetTemperatureCallbackConfiguration() konfiguriert.

void BrickletHumidityV2.SetHeaterConfiguration(byte heaterConfig)

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 Konstanten sind für diese Funktion verfügbar:

  • BrickletHumidityV2.HEATER_CONFIG_DISABLED = 0
  • BrickletHumidityV2.HEATER_CONFIG_ENABLED = 1
byte BrickletHumidityV2.GetHeaterConfiguration()

Gibt die Heizelement-Konfiguration zurück, wie von SetHeaterConfiguration() gesetzt.

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

  • BrickletHumidityV2.HEATER_CONFIG_DISABLED = 0
  • BrickletHumidityV2.HEATER_CONFIG_ENABLED = 1
void BrickletHumidityV2.SetMovingAverageConfiguration(int movingAverageLengthHumidity, int movingAverageLengthTemperature)

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 SetSamplesPerSecond() 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!

void BrickletHumidityV2.GetMovingAverageConfiguration(out int movingAverageLengthHumidity, out int movingAverageLengthTemperature)

Gibt die Moving Average-Konfiguration zurück, wie von SetMovingAverageConfiguration() gesetzt.

void BrickletHumidityV2.SetSamplesPerSecond(byte sps)

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 Konstanten sind für diese Funktion verfügbar:

  • BrickletHumidityV2.SPS_20 = 0
  • BrickletHumidityV2.SPS_10 = 1
  • BrickletHumidityV2.SPS_5 = 2
  • BrickletHumidityV2.SPS_1 = 3
  • BrickletHumidityV2.SPS_02 = 4
  • BrickletHumidityV2.SPS_01 = 5

Neu in Version 2.0.3 (Plugin).

byte BrickletHumidityV2.GetSamplesPerSecond()

Gibt die Messwerte pro Sekunde zurück, wie von SetSamplesPerSecond() gesetzt.

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

  • BrickletHumidityV2.SPS_20 = 0
  • BrickletHumidityV2.SPS_10 = 1
  • BrickletHumidityV2.SPS_5 = 2
  • BrickletHumidityV2.SPS_1 = 3
  • BrickletHumidityV2.SPS_02 = 4
  • BrickletHumidityV2.SPS_01 = 5

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen

byte[] BrickletHumidityV2.GetAPIVersion()

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

bool BrickletHumidityV2.GetResponseExpected(byte functionId)

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

  • BrickletHumidityV2.FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 2
  • BrickletHumidityV2.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 6
  • BrickletHumidityV2.FUNCTION_SET_HEATER_CONFIGURATION = 9
  • BrickletHumidityV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 11
  • BrickletHumidityV2.FUNCTION_SET_SAMPLES_PER_SECOND = 13
  • BrickletHumidityV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletHumidityV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletHumidityV2.FUNCTION_RESET = 243
  • BrickletHumidityV2.FUNCTION_WRITE_UID = 248
void BrickletHumidityV2.SetResponseExpected(byte functionId, bool responseExpected)

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

  • BrickletHumidityV2.FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 2
  • BrickletHumidityV2.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 6
  • BrickletHumidityV2.FUNCTION_SET_HEATER_CONFIGURATION = 9
  • BrickletHumidityV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 11
  • BrickletHumidityV2.FUNCTION_SET_SAMPLES_PER_SECOND = 13
  • BrickletHumidityV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletHumidityV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletHumidityV2.FUNCTION_RESET = 243
  • BrickletHumidityV2.FUNCTION_WRITE_UID = 248
void BrickletHumidityV2.SetResponseExpectedAll(bool responseExpected)

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

void BrickletHumidityV2.GetSPITFPErrorCount(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)

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.

byte BrickletHumidityV2.SetBootloaderMode(byte mode)

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 Konstanten sind für diese Funktion verfügbar:

  • BrickletHumidityV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletHumidityV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletHumidityV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletHumidityV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletHumidityV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletHumidityV2.BOOTLOADER_STATUS_OK = 0
  • BrickletHumidityV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletHumidityV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletHumidityV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletHumidityV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletHumidityV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
byte BrickletHumidityV2.GetBootloaderMode()

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

  • BrickletHumidityV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletHumidityV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletHumidityV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletHumidityV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletHumidityV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletHumidityV2.SetWriteFirmwarePointer(long pointer)

Setzt den Firmware-Pointer für WriteFirmware(). 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.

byte BrickletHumidityV2.WriteFirmware(byte[] data)

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer() 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.

void BrickletHumidityV2.SetStatusLEDConfig(byte config)

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 Konstanten sind für diese Funktion verfügbar:

  • BrickletHumidityV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletHumidityV2.STATUS_LED_CONFIG_ON = 1
  • BrickletHumidityV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletHumidityV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
byte BrickletHumidityV2.GetStatusLEDConfig()

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig() gesetzt.

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

  • BrickletHumidityV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletHumidityV2.STATUS_LED_CONFIG_ON = 1
  • BrickletHumidityV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletHumidityV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
short BrickletHumidityV2.GetChipTemperature()

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.

void BrickletHumidityV2.Reset()

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.

void BrickletHumidityV2.WriteUID(long uid)

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.

long BrickletHumidityV2.ReadUID()

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

void BrickletHumidityV2.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)

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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

void BrickletHumidityV2.SetHumidityCallbackConfiguration(long period, bool valueHasToChange, char option, int min, int max)

Die Periode in ms ist die Periode mit der der HumidityCallback 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 HumidityCallback 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 Konstanten sind für diese Funktion verfügbar:

  • BrickletHumidityV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidityV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidityV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidityV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidityV2.THRESHOLD_OPTION_GREATER = '>'
void BrickletHumidityV2.GetHumidityCallbackConfiguration(out long period, out bool valueHasToChange, out char option, out int min, out int max)

Gibt die Callback-Konfiguration zurück, wie mittels SetHumidityCallbackConfiguration() gesetzt.

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

  • BrickletHumidityV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidityV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidityV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidityV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidityV2.THRESHOLD_OPTION_GREATER = '>'
void BrickletHumidityV2.SetTemperatureCallbackConfiguration(long period, bool valueHasToChange, char option, short min, short max)

Die Periode in ms ist die Periode mit der der TemperatureCallback 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 TemperatureCallback 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 Konstanten sind für diese Funktion verfügbar:

  • BrickletHumidityV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidityV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidityV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidityV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidityV2.THRESHOLD_OPTION_GREATER = '>'
void BrickletHumidityV2.GetTemperatureCallbackConfiguration(out long period, out bool valueHasToChange, out char option, out short min, out short max)

Gibt die Callback-Konfiguration zurück, wie mittels SetTemperatureCallbackConfiguration() gesetzt.

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

  • BrickletHumidityV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidityV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidityV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidityV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidityV2.THRESHOLD_OPTION_GREATER = '>'

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung geschieht durch Anhängen des Callback Handlers an den passenden Event:

void MyCallback(BrickletHumidityV2 sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

humidityV2.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

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.

event BrickletHumidityV2.HumidityCallback(BrickletHumidityV2 sender, int humidity)

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetHumidityCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie GetHumidity().

event BrickletHumidityV2.TemperatureCallback(BrickletHumidityV2 sender, short temperature)

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetTemperatureCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie GetTemperature().

Konstanten

int BrickletHumidityV2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Humidity Bricklet 2.0 zu identifizieren.

Die GetIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickletHumidityV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Humidity Bricklet 2.0 dar.