C# - Humidity Bricklet¶

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

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletHumidity h = new BrickletHumidity(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/10.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
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

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

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletHumidity h = new BrickletHumidity(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)
        // Note: The humidity callback is only called every second
        //       if the humidity has changed since the last call!
        h.SetHumidityCallbackPeriod(1000);

        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
37
38

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

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

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

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

        // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
        h.SetDebouncePeriod(10000);

        // Register humidity reached callback to function HumidityReachedCB
        h.HumidityReachedCallback += HumidityReachedCB;

        // Configure threshold for humidity "outside of 30 to 60 %RH"
        h.SetHumidityCallbackThreshold('o', 30*10, 60*10);

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

Grundfunktionen¶

class BrickletHumidity(string uid, IPConnection ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	humidity – Typ: BrickletHumidity

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

BrickletHumidity humidity = new BrickletHumidity("YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

int BrickletHumidity.GetHumidity()¶

Rückgabe:	humidity – Typ: int, Einheit: 1/10 %, Wertebereich: [0 bis 1000]

Gibt die gemessene Luftfeuchtigkeit des Sensors zurück.

Wenn die Luftfeuchtigkeit periodisch abgefragt werden soll, wird empfohlen den HumidityCallback Callback zu nutzen und die Periode mit SetHumidityCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

int BrickletHumidity.GetAnalogValue()¶

Rückgabe:	value – Typ: int, Wertebereich: [0 bis 212 - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von GetHumidity() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während GetAnalogValue() unverarbeitete Analogwerte zurück gibt. Der zurückgegebene Luftfeuchtigkeitswert ist auf Raumtemperatur kalibriert, d.h. wenn der Sensor in sehr kalten oder warmen Umgebungen verwendet wird, ist es ratsam den Luftfeuchtigkeitswert direkt aus den Analogwerten zu berechnen. Siehe hierzu das HIH 5030 Datenblatt.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den AnalogValueCallback Callback zu nutzen und die Periode mit SetAnalogValueCallbackPeriod() vorzugeben.

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

Ausgabeparameter:

uid – Typ: string, Länge: bis zu 8 connectedUid – Typ: string, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 1]

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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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 BrickletHumidity.SetHumidityCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

long BrickletHumidity.GetHumidityCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetHumidityCallbackPeriod() gesetzt.

void BrickletHumidity.SetAnalogValueCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

long BrickletHumidity.GetAnalogValueCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetAnalogValueCallbackPeriod() gesetzt.

void BrickletHumidity.SetHumidityCallbackThreshold(char option, int min, int max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/10 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/10 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den HumidityReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

void BrickletHumidity.GetHumidityCallbackThreshold(out char option, out int min, out int max)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/10 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/10 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetHumidityCallbackThreshold() gesetzt.

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

Für option:

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

void BrickletHumidity.SetAnalogValueCallbackThreshold(char option, int min, int max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den AnalogValueReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

void BrickletHumidity.GetAnalogValueCallbackThreshold(out char option, out int min, out int max)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetAnalogValueCallbackThreshold() gesetzt.

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

Für option:

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

void BrickletHumidity.SetDebouncePeriod(long debounce)¶

Parameter:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

• HumidityReachedCallback,
• AnalogValueReachedCallback

ausgelöst werden, wenn die Schwellwerte

• SetHumidityCallbackThreshold(),
• SetAnalogValueCallbackThreshold()

weiterhin erreicht bleiben.

long BrickletHumidity.GetDebouncePeriod()¶

Rückgabe:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() gesetzt.

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(BrickletHumidity sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

humidity.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

event BrickletHumidity.HumidityCallback(BrickletHumidity sender, int humidity)¶

Callback-Parameter:	sender – Typ: BrickletHumidity humidity – Typ: int, Einheit: 1/10 %, Wertebereich: [0 bis 1000]

Dieser Callback wird mit der Periode, wie gesetzt mit SetHumidityCallbackPeriod(), ausgelöst. Der Parameter ist die Luftfeuchtigkeit des Sensors.

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

event BrickletHumidity.AnalogValueCallback(BrickletHumidity sender, int value)¶

Callback-Parameter:	sender – Typ: BrickletHumidity value – Typ: int, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetAnalogValueCallbackPeriod(), ausgelöst. Der Parameter ist der Analogwert des Sensors.

AnalogValueCallback Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

event BrickletHumidity.HumidityReachedCallback(BrickletHumidity sender, int humidity)¶

Callback-Parameter:	sender – Typ: BrickletHumidity humidity – Typ: int, Einheit: 1/10 %, Wertebereich: [0 bis 1000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetHumidityCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Luftfeuchtigkeit des Sensors.

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

event BrickletHumidity.AnalogValueReachedCallback(BrickletHumidity sender, int value)¶

Callback-Parameter:	sender – Typ: BrickletHumidity value – Typ: int, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Analogwert des Sensors.

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

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

byte[] BrickletHumidity.GetAPIVersion()¶

Ausgabeparameter:	apiVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255]

Gibt die Version der API Definition 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 BrickletHumidity.GetResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: bool

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:

Für functionId:

• BrickletHumidity.FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD = 3
• BrickletHumidity.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
• BrickletHumidity.FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD = 7
• BrickletHumidity.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
• BrickletHumidity.FUNCTION_SET_DEBOUNCE_PERIOD = 11

void BrickletHumidity.SetResponseExpected(byte functionId, bool responseExpected)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: bool

Ä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:

Für functionId:

• BrickletHumidity.FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD = 3
• BrickletHumidity.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
• BrickletHumidity.FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD = 7
• BrickletHumidity.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
• BrickletHumidity.FUNCTION_SET_DEBOUNCE_PERIOD = 11

void BrickletHumidity.SetResponseExpectedAll(bool responseExpected)¶

Parameter:	responseExpected – Typ: bool

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

Konstanten¶

int BrickletHumidity.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Humidity Bricklet 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 BrickletHumidity.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Humidity Bricklet dar.