C# - CO2 Bricklet 2.0

Dies ist die Beschreibung der C# API Bindings für das CO2 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des CO2 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
27
28
29
30
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 CO2 Bricklet 2.0

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletCO2V2 co2 = new BrickletCO2V2(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 co2Concentration, humidity; short temperature;
        co2.GetAllValues(out co2Concentration, out temperature, out humidity);

        Console.WriteLine("CO2 Concentration: " + co2Concentration + " ppm");
        Console.WriteLine("Temperature: " + temperature/100.0 + " °C");
        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
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 CO2 Bricklet 2.0

    // Callback function for all values callback
    static void AllValuesCB(BrickletCO2V2 sender, int co2Concentration, short temperature,
                            int humidity)
    {
        Console.WriteLine("CO2 Concentration: " + co2Concentration + " ppm");
        Console.WriteLine("Temperature: " + temperature/100.0 + " °C");
        Console.WriteLine("Humidity: " + humidity/100.0 + " %RH");
        Console.WriteLine("");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletCO2V2 co2 = new BrickletCO2V2(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
        co2.AllValuesCallback += AllValuesCB;

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

        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 BrickletCO2V2(String uid, IPConnection ipcon)

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

BrickletCO2V2 co2V2 = new BrickletCO2V2("YOUR_DEVICE_UID", ipcon);

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

void BrickletCO2V2.GetAllValues(out int co2Concentration, out short temperature, out int humidity)

Gibt alle Werte zurück, die das CO2 Bricklet 2.0 misst. Diese Werte umfassen: CO2-Konzentration (in ppm), Temperatur (in 0,01 °C) und Luftfeuchte (in 0,01 %RH).

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

void BrickletCO2V2.SetAirPressure(int airPressure)

Die CO2-Konzentration hängt (unter anderem) vom Umgebungs-Luftdruck ab.

Um die Genauigkeit des CO2 Bricklet 2.0 zu verbessern ist es möglich den aktuellen Luftdruck zu setzen. Dazu kann das Barometer Bricklet 2.0 oder auch das Air Quality Bricklet genutzt werden.

Die erwartete Einheit des Umgebungs-Luftdrucks ist mbar.

Standardmäßig ist die Luftdruck-Kompensation deaktiviert. Sobald ein Wert gesetzt wird, wird dieser zur Kompensation verwendet. Die Kompensation kann wieder ausgestellt werden in dem der Wert zurück auf 0 gesetzt wird.

Es ist hinreichend den Wert alle paar Minuten zu aktualisieren.

int BrickletCO2V2.GetAirPressure()

Gibt den Umgebungs-Luftdruch zurück, wie von SetAirPressure() gesetzt.

void BrickletCO2V2.SetTemperatureOffset(int offset)

Setzt ein Temperatur-Offset mit Auflösung 1/100°C. 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 der CO2-Konzentration mit ein. Um die Genauigkeit der Messwerte innerhalb eines Gehäuses zu verbessern sollte der Temperatur-Offset bestimmt und eingestellt werden.

Es ist hinreichend den Temperatur-Offset einmal zu setzen. Der Offset wird in einem nicht-flüchtigen Speicher gespeichert und auch nach einem Neustart wieder angewendet.

int BrickletCO2V2.GetTemperatureOffset()

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

int BrickletCO2V2.GetCO2Concentration()

Gibt die CO2-Konzentration in ppm zurück.

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

short BrickletCO2V2.GetTemperature()

Gibt die Temperatur in 0,01 °C Schritten 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 BrickletCO2V2.GetHumidity()

Gibt die relative Luftfeuchtigkeit in 0,01 %RH Schritten zurück.

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

Fortgeschrittene Funktionen

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

  • BrickletCO2V2.FUNCTION_SET_AIR_PRESSURE = 2
  • BrickletCO2V2.FUNCTION_SET_TEMPERATURE_OFFSET = 4
  • BrickletCO2V2.FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 6
  • BrickletCO2V2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION = 10
  • BrickletCO2V2.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 14
  • BrickletCO2V2.FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 18
  • BrickletCO2V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletCO2V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletCO2V2.FUNCTION_RESET = 243
  • BrickletCO2V2.FUNCTION_WRITE_UID = 248
void BrickletCO2V2.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:

  • BrickletCO2V2.FUNCTION_SET_AIR_PRESSURE = 2
  • BrickletCO2V2.FUNCTION_SET_TEMPERATURE_OFFSET = 4
  • BrickletCO2V2.FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 6
  • BrickletCO2V2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION = 10
  • BrickletCO2V2.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 14
  • BrickletCO2V2.FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 18
  • BrickletCO2V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletCO2V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletCO2V2.FUNCTION_RESET = 243
  • BrickletCO2V2.FUNCTION_WRITE_UID = 248
void BrickletCO2V2.SetResponseExpectedAll(bool responseExpected)

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

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

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

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

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

  • BrickletCO2V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletCO2V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletCO2V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletCO2V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletCO2V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletCO2V2.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 BrickletCO2V2.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 BrickletCO2V2.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:

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

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

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

  • BrickletCO2V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletCO2V2.STATUS_LED_CONFIG_ON = 1
  • BrickletCO2V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletCO2V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
short BrickletCO2V2.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 BrickletCO2V2.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 BrickletCO2V2.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 BrickletCO2V2.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 BrickletCO2V2.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 BrickletCO2V2.SetAllValuesCallbackConfiguration(long period, bool valueHasToChange)

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

Der Standardwert ist (0, false).

void BrickletCO2V2.GetAllValuesCallbackConfiguration(out long period, out bool valueHasToChange)

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

void BrickletCO2V2.SetCO2ConcentrationCallbackConfiguration(long period, bool valueHasToChange, char option, int min, int max)

Die Periode in ms ist die Periode mit der der CO2ConcentrationCallback 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 CO2ConcentrationCallback 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:

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

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

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

  • BrickletCO2V2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletCO2V2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCO2V2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCO2V2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCO2V2.THRESHOLD_OPTION_GREATER = '>'
void BrickletCO2V2.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:

  • BrickletCO2V2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletCO2V2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCO2V2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCO2V2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCO2V2.THRESHOLD_OPTION_GREATER = '>'
void BrickletCO2V2.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:

  • BrickletCO2V2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletCO2V2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCO2V2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCO2V2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCO2V2.THRESHOLD_OPTION_GREATER = '>'
void BrickletCO2V2.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:

  • BrickletCO2V2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletCO2V2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCO2V2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCO2V2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCO2V2.THRESHOLD_OPTION_GREATER = '>'
void BrickletCO2V2.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:

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

co2V2.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 BrickletCO2V2.AllValuesCallback(BrickletCO2V2 sender, int co2Concentration, short temperature, int humidity)

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

Die Parameter sind die gleichen wie GetAllValues().

event BrickletCO2V2.CO2ConcentrationCallback(BrickletCO2V2 sender, int co2Concentration)

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

Der Parameter ist der gleiche wie GetCO2Concentration().

event BrickletCO2V2.TemperatureCallback(BrickletCO2V2 sender, short temperature)

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

Der Parameter ist der gleiche wie GetTemperature().

event BrickletCO2V2.HumidityCallback(BrickletCO2V2 sender, int humidity)

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

Der Parameter ist der gleiche wie GetHumidity().

Konstanten

int BrickletCO2V2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein CO2 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 BrickletCO2V2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines CO2 Bricklet 2.0 dar.