C# - Air Quality 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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

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 Air Quality Bricklet

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

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

        // Get current all values
        int iaqIndex, temperature, humidity, airPressure; byte iaqIndexAccuracy;
        aq.GetAllValues(out iaqIndex, out iaqIndexAccuracy, out temperature, out humidity,
                        out airPressure);

        Console.WriteLine("IAQ Index: " + iaqIndex);

        if(iaqIndexAccuracy == BrickletAirQuality.ACCURACY_UNRELIABLE)
        {
            Console.WriteLine("IAQ Index Accuracy: Unreliable");
        }
        else if(iaqIndexAccuracy == BrickletAirQuality.ACCURACY_LOW)
        {
            Console.WriteLine("IAQ Index Accuracy: Low");
        }
        else if(iaqIndexAccuracy == BrickletAirQuality.ACCURACY_MEDIUM)
        {
            Console.WriteLine("IAQ Index Accuracy: Medium");
        }
        else if(iaqIndexAccuracy == BrickletAirQuality.ACCURACY_HIGH)
        {
            Console.WriteLine("IAQ Index Accuracy: High");
        }

        Console.WriteLine("Temperature: " + temperature/100.0 + " °C");
        Console.WriteLine("Humidity: " + humidity/100.0 + " %RH");
        Console.WriteLine("Air Pressure: " + airPressure/100.0 + " hPa");

        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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

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 Air Quality Bricklet

    // Callback function for all values callback
    static void AllValuesCB(BrickletAirQuality sender, int iaqIndex,
                            byte iaqIndexAccuracy, int temperature, int humidity,
                            int airPressure)
    {
        Console.WriteLine("IAQ Index: " + iaqIndex);

        if(iaqIndexAccuracy == BrickletAirQuality.ACCURACY_UNRELIABLE)
        {
            Console.WriteLine("IAQ Index Accuracy: Unreliable");
        }
        else if(iaqIndexAccuracy == BrickletAirQuality.ACCURACY_LOW)
        {
            Console.WriteLine("IAQ Index Accuracy: Low");
        }
        else if(iaqIndexAccuracy == BrickletAirQuality.ACCURACY_MEDIUM)
        {
            Console.WriteLine("IAQ Index Accuracy: Medium");
        }
        else if(iaqIndexAccuracy == BrickletAirQuality.ACCURACY_HIGH)
        {
            Console.WriteLine("IAQ Index Accuracy: High");
        }

        Console.WriteLine("Temperature: " + temperature/100.0 + " °C");
        Console.WriteLine("Humidity: " + humidity/100.0 + " %RH");
        Console.WriteLine("Air Pressure: " + airPressure/100.0 + " hPa");
        Console.WriteLine("");
    }

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

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

        // Register all values callback to function AllValuesCB
        aq.AllValuesCallback += AllValuesCB;

        // Set period for all values callback to 1s (1000ms)
        aq.SetAllValuesCallbackConfiguration(1000, false);

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

Grundfunktionen¶

class BrickletAirQuality(string uid, IPConnection ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	airQuality – Typ: BrickletAirQuality

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

BrickletAirQuality airQuality = new BrickletAirQuality("YOUR_DEVICE_UID", ipcon);

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

void BrickletAirQuality.GetAllValues(out int iaqIndex, out byte iaqIndexAccuracy, out int temperature, out int humidity, out int airPressure)¶

Ausgabeparameter:	iaqIndex – Typ: int, Wertebereich: [0 bis 500] iaqIndexAccuracy – Typ: byte, Wertebereich: Siehe Konstanten temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1] humidity – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1] airPressure – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1]

Gibt alle Werte zurück, die das Air Quality Bricklet misst. Diese Werte umfassen: IAQ (Indoor Air Quality = Innenraumluftqualität) Index (ein höherer Werte bedeutet eine stärkere Luftverschmutzung), IAQ Index Genauigkeit, Temperatur, Luftfeuchte und Luftdruck.

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

Für iaqIndexAccuracy:

• BrickletAirQuality.ACCURACY_UNRELIABLE = 0
• BrickletAirQuality.ACCURACY_LOW = 1
• BrickletAirQuality.ACCURACY_MEDIUM = 2
• BrickletAirQuality.ACCURACY_HIGH = 3

void BrickletAirQuality.SetTemperatureOffset(int offset)¶

Parameter:	offset – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1]

Setzt ein Temperatur-Offset. Ein Offset von 10 verringert die gemessene Temperatur um 0,1 °C.

Wenn das Bricklet in einem Gehäuse verbaut wird, aber die Umgebungstemperatur außerhalb des Gehäuses gemessen werden soll, dann muss vom gemessenen Temperatur ein bestimmter Wert abgezogen werden, um den Messfehler durch das Aufheizen des Gehäuses zu kompensieren.

Wir empfehlen den Messaufbau im Gehäuse mindestens 24 Stunden laufen zu lassen, damit sich ein Temperaturgleichgewicht einstellt. Danach muss die Temperatur außerhalb des Gehäuses gemessen werden und die Differenz zur Temperatur innerhalb des Gehäuses als Offset eingestellt werden.

Dieses Temperatur-Offset geht in die Berechnung der Luftfeuchte und des IAQ Index mit ein. Um die Genauigkeit der Messwerte innerhalb eines Gehäuses zu verbessern sollte der Temperatur-Offset unbedingt bestimmt und eingestellt werden.

int BrickletAirQuality.GetTemperatureOffset()¶

Rückgabe:	offset – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1]

Gibt das Temperatur-Offset zurück, wie mittels SetTemperatureOffset() gesetzt.

void BrickletAirQuality.GetIAQIndex(out int iaqIndex, out byte iaqIndexAccuracy)¶

Ausgabeparameter:	iaqIndex – Typ: int, Wertebereich: [0 bis 500] iaqIndexAccuracy – Typ: byte, Wertebereich: Siehe Konstanten

Gibt den IAQ Index und dessen Genaugkeit zurück. Ein höherer Werte bedeutet eine stärkere Luftverschmutzung.

Wenn der Wert periodisch benötigt wird, kann auch der IAQIndexCallback Callback verwendet werden. Der Callback wird mit der Funktion SetIAQIndexCallbackConfiguration() konfiguriert.

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

Für iaqIndexAccuracy:

• BrickletAirQuality.ACCURACY_UNRELIABLE = 0
• BrickletAirQuality.ACCURACY_LOW = 1
• BrickletAirQuality.ACCURACY_MEDIUM = 2
• BrickletAirQuality.ACCURACY_HIGH = 3

int BrickletAirQuality.GetTemperature()¶

Rückgabe:	temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1]

Gibt die Temperatur zurück.

Wenn der Wert periodisch benötigt wird, kann auch der TemperatureCallback Callback verwendet werden. Der Callback wird mit der Funktion SetTemperatureCallbackConfiguration() konfiguriert.

int BrickletAirQuality.GetHumidity()¶

Rückgabe:	humidity – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1]

Gibt die relative Luftfeuchtigkeit zurück.

Wenn der Wert periodisch benötigt wird, kann auch der HumidityCallback Callback verwendet werden. Der Callback wird mit der Funktion SetHumidityCallbackConfiguration() konfiguriert.

int BrickletAirQuality.GetAirPressure()¶

Rückgabe:	airPressure – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1]

Gibt den Luftdruck Schritten zurück.

Wenn der Wert periodisch benötigt wird, kann auch der AirPressureCallback Callback verwendet werden. Der Callback wird mit der Funktion SetAirPressureCallbackConfiguration() konfiguriert.

Fortgeschrittene Funktionen¶

void BrickletAirQuality.RemoveCalibration()¶

Löscht die Kalibrierung auf dem Flash. Nach dem diese Funktion aufgerufen wird muss das Air Quality Bricklet vom Strom getrennt werden.

Beim nächsten starten des Bricklet wird eine komplett neue Kalibrierung gestartet, wie beim allerersten Starten des Bricklets.

Die Kalibrierung basiert auf den Daten der letzten vier Tage, daher dauert es vier Tage bis eine volle Kalibrierung wieder hergestellt ist.

Neu in Version 2.0.3 (Plugin).

void BrickletAirQuality.SetBackgroundCalibrationDuration(byte duration)¶

Parameter:	duration – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 1

Das Air Quality Bricklet nutzt eine automatische Hintergrundkalibrierung um den IAQ-Index zu bestimmen. Der Kalibrierungsmechanismus nutzt eine Historie von gemessenen Werte. Die Länge dieser Historie kann zwischen 4 und 28 Tagen konfiguriert werden.

Wenn das Bricklet hauptsächlich am gleichen Ort bleibt und die Umgebung nicht oft verändert wird, empfehlen wir eine Länge von 28 Tagen zu verwenden.

Wenn die Länge geändert wird,wird die aktuelle Kalibrierung verworfen und die Kalibrierung beginnt von vorne. Die Konfiguration der Länge wird im Flash gespeichert, diese Funktion sollte also nur einmal in der Lebenszeit des Bricklets aufgerufen werden müssen.

Eine Änderung der Kalibrierungslänge wird beim nächsten Start des Bricklets übernommen.

Vor Firmware-Version 2.0.3 war die Hintergrundkalibrierungslänge 4 Tage und nicht konfigurierbare.

Der Standardwert (seit Firmware-Version 2.0.3) beträgt 28 Tage.

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

Für duration:

• BrickletAirQuality.DURATION_4_DAYS = 0
• BrickletAirQuality.DURATION_28_DAYS = 1

Neu in Version 2.0.3 (Plugin).

byte BrickletAirQuality.GetBackgroundCalibrationDuration()¶

Rückgabe:	duration – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt die Länge der Hintergrundkalibrierung zurück, wie von SetBackgroundCalibrationDuration() gesetzt.

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

Für duration:

• BrickletAirQuality.DURATION_4_DAYS = 0
• BrickletAirQuality.DURATION_28_DAYS = 1

Neu in Version 2.0.3 (Plugin).

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

Ausgabeparameter:	errorCountAckChecksum – Typ: long, Wertebereich: [0 bis 232 - 1] errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 232 - 1] errorCountFrame – Typ: long, Wertebereich: [0 bis 232 - 1] errorCountOverflow – Typ: long, Wertebereich: [0 bis 232 - 1]

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.

void BrickletAirQuality.SetStatusLEDConfig(byte config)¶

Parameter:	config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

Für config:

• BrickletAirQuality.STATUS_LED_CONFIG_OFF = 0
• BrickletAirQuality.STATUS_LED_CONFIG_ON = 1
• BrickletAirQuality.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletAirQuality.STATUS_LED_CONFIG_SHOW_STATUS = 3

byte BrickletAirQuality.GetStatusLEDConfig()¶

Rückgabe:	config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

• BrickletAirQuality.STATUS_LED_CONFIG_OFF = 0
• BrickletAirQuality.STATUS_LED_CONFIG_ON = 1
• BrickletAirQuality.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletAirQuality.STATUS_LED_CONFIG_SHOW_STATUS = 3

short BrickletAirQuality.GetChipTemperature()¶

Rückgabe:	temperature – Typ: short, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, 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 BrickletAirQuality.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 BrickletAirQuality.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 BrickletAirQuality.SetAllValuesCallbackConfiguration(long period, bool valueHasToChange)¶

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

Die Periode ist die Periode mit der der AllValuesCallback 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.

void BrickletAirQuality.GetAllValuesCallbackConfiguration(out long period, out bool valueHasToChange)¶

Ausgabeparameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false

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

void BrickletAirQuality.SetIAQIndexCallbackConfiguration(long period, bool valueHasToChange)¶

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

Die Periode ist die Periode mit der der IAQIndexCallback 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.

void BrickletAirQuality.GetIAQIndexCallbackConfiguration(out long period, out bool valueHasToChange)¶

Ausgabeparameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false

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

void BrickletAirQuality.SetTemperatureCallbackConfiguration(long period, bool valueHasToChange, char option, int min, int max)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode 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.

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

Für option:

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

void BrickletAirQuality.GetTemperatureCallbackConfiguration(out long period, out bool valueHasToChange, out char option, out int min, out int max)¶

Ausgabeparameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

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

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

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode 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.

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

Für option:

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

void BrickletAirQuality.GetHumidityCallbackConfiguration(out long period, out bool valueHasToChange, out char option, out int min, out int max)¶

Ausgabeparameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

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

void BrickletAirQuality.SetAirPressureCallbackConfiguration(long period, bool valueHasToChange, char option, int min, int max)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode ist die Periode mit der der AirPressureCallback 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 AirPressureCallback 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.

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

Für option:

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

void BrickletAirQuality.GetAirPressureCallbackConfiguration(out long period, out bool valueHasToChange, out char option, out int min, out int max)¶

Ausgabeparameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

• BrickletAirQuality.THRESHOLD_OPTION_OFF = 'x'
• BrickletAirQuality.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletAirQuality.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletAirQuality.THRESHOLD_OPTION_SMALLER = '<'
• BrickletAirQuality.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(BrickletAirQuality sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

airQuality.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

event BrickletAirQuality.AllValuesCallback(BrickletAirQuality sender, int iaqIndex, byte iaqIndexAccuracy, int temperature, int humidity, int airPressure)¶

Callback-Parameter:	sender – Typ: BrickletAirQuality iaqIndex – Typ: int, Wertebereich: [0 bis 500] iaqIndexAccuracy – Typ: byte, Wertebereich: Siehe Konstanten temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1] humidity – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1] airPressure – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1]

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

Die Parameter sind der gleiche wie GetAllValues().

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

Für iaqIndexAccuracy:

• BrickletAirQuality.ACCURACY_UNRELIABLE = 0
• BrickletAirQuality.ACCURACY_LOW = 1
• BrickletAirQuality.ACCURACY_MEDIUM = 2
• BrickletAirQuality.ACCURACY_HIGH = 3

event BrickletAirQuality.IAQIndexCallback(BrickletAirQuality sender, int iaqIndex, byte iaqIndexAccuracy)¶

Callback-Parameter:	sender – Typ: BrickletAirQuality iaqIndex – Typ: int, Wertebereich: [0 bis 500] iaqIndexAccuracy – Typ: byte, Wertebereich: Siehe Konstanten

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

Die Parameter sind die gleichen wie GetIAQIndex().

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

Für iaqIndexAccuracy:

• BrickletAirQuality.ACCURACY_UNRELIABLE = 0
• BrickletAirQuality.ACCURACY_LOW = 1
• BrickletAirQuality.ACCURACY_MEDIUM = 2
• BrickletAirQuality.ACCURACY_HIGH = 3

event BrickletAirQuality.TemperatureCallback(BrickletAirQuality sender, int temperature)¶

Callback-Parameter:	sender – Typ: BrickletAirQuality temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1]

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

Der Parameter ist der gleiche wie GetTemperature().

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

Callback-Parameter:	sender – Typ: BrickletAirQuality humidity – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1]

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

Der Parameter ist der gleiche wie GetHumidity().

event BrickletAirQuality.AirPressureCallback(BrickletAirQuality sender, int airPressure)¶

Callback-Parameter:	sender – Typ: BrickletAirQuality airPressure – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1]

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

Der Parameter ist der gleiche wie GetAirPressure().

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[] BrickletAirQuality.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 BrickletAirQuality.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:

• BrickletAirQuality.FUNCTION_SET_TEMPERATURE_OFFSET = 2
• BrickletAirQuality.FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
• BrickletAirQuality.FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
• BrickletAirQuality.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
• BrickletAirQuality.FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
• BrickletAirQuality.FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
• BrickletAirQuality.FUNCTION_REMOVE_CALIBRATION = 23
• BrickletAirQuality.FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
• BrickletAirQuality.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletAirQuality.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletAirQuality.FUNCTION_RESET = 243
• BrickletAirQuality.FUNCTION_WRITE_UID = 248

void BrickletAirQuality.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:

• BrickletAirQuality.FUNCTION_SET_TEMPERATURE_OFFSET = 2
• BrickletAirQuality.FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
• BrickletAirQuality.FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
• BrickletAirQuality.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
• BrickletAirQuality.FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
• BrickletAirQuality.FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
• BrickletAirQuality.FUNCTION_REMOVE_CALIBRATION = 23
• BrickletAirQuality.FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
• BrickletAirQuality.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletAirQuality.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletAirQuality.FUNCTION_RESET = 243
• BrickletAirQuality.FUNCTION_WRITE_UID = 248

void BrickletAirQuality.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.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

byte BrickletAirQuality.SetBootloaderMode(byte mode)¶

Parameter:	mode – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: byte, Wertebereich: Siehe Konstanten

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

Für mode:

• BrickletAirQuality.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletAirQuality.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletAirQuality.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletAirQuality.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletAirQuality.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• BrickletAirQuality.BOOTLOADER_STATUS_OK = 0
• BrickletAirQuality.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletAirQuality.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletAirQuality.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletAirQuality.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletAirQuality.BOOTLOADER_STATUS_CRC_MISMATCH = 5

byte BrickletAirQuality.GetBootloaderMode()¶

Rückgabe:	mode – Typ: byte, Wertebereich: Siehe Konstanten

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

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

Für mode:

• BrickletAirQuality.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletAirQuality.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletAirQuality.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletAirQuality.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletAirQuality.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletAirQuality.SetWriteFirmwarePointer(long pointer)¶

Parameter:	pointer – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

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 BrickletAirQuality.WriteFirmware(byte[] data)¶

Parameter:	data – Typ: byte[], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: byte, Wertebereich: [0 bis 255]

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 BrickletAirQuality.WriteUID(long uid)¶

Parameter:	uid – Typ: long, Wertebereich: [0 bis 232 - 1]

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 BrickletAirQuality.ReadUID()¶

Rückgabe:	uid – Typ: long, Wertebereich: [0 bis 232 - 1]

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

Konstanten¶

int BrickletAirQuality.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Air Quality 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 BrickletAirQuality.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Air Quality Bricklet dar.