Visual Basic .NET - CO2 Bricklet 2.0

Dies ist die Beschreibung der Visual Basic .NET 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 Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.vb)

 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
Imports System
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your CO2 Bricklet 2.0

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim co2 As 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
        Dim co2Concentration, humidity As Integer
        Dim temperature As Short

        co2.GetAllValues(co2Concentration, temperature, humidity)

        Console.WriteLine("CO2 Concentration: " + co2Concentration.ToString() + " ppm")
        Console.WriteLine("Temperature: " + (temperature/100.0).ToString() + " °C")
        Console.WriteLine("Humidity: " + (humidity/100.0).ToString() + " %RH")

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Callback

Download (ExampleCallback.vb)

 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
Imports System
Imports Tinkerforge

Module ExampleCallback
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your CO2 Bricklet 2.0

    ' Callback subroutine for all values callback
    Sub AllValuesCB(ByVal sender As BrickletCO2V2, ByVal co2Concentration As Integer, _
                    ByVal temperature As Short, ByVal humidity As Integer)
        Console.WriteLine("CO2 Concentration: " + co2Concentration.ToString() + " ppm")
        Console.WriteLine("Temperature: " + (temperature/100.0).ToString() + " °C")
        Console.WriteLine("Humidity: " + (humidity/100.0).ToString() + " %RH")
        Console.WriteLine("")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim co2 As 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 subroutine AllValuesCB
        AddHandler co2.AllValuesCallback, AddressOf AllValuesCB

        ' Set period for all values callback to 1s (1000ms)
        co2.SetAllValuesCallbackConfiguration(1000, False)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API

Da Visual Basic .NET nicht mehrere Rückgabewerte direkt unterstützt, wird das ByRef Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

Class BrickletCO2V2(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim co2V2 As New BrickletCO2V2("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletCO2V2.GetAllValues(ByRef co2Concentration As Integer, ByRef temperature As Short, ByRef humidity As Integer)
Ausgabeparameter:
  • co2Concentration – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • temperature – Typ: Short, Wertebereich: [-215 bis 215 - 1]
  • humidity – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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.

Sub BrickletCO2V2.SetAirPressure(ByVal airPressure As Integer)
Parameter:
  • airPressure – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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.

Function BrickletCO2V2.GetAirPressure() As Integer
Rückgabe:
  • airPressure – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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

Sub BrickletCO2V2.SetTemperatureOffset(ByVal offset As Integer)
Parameter:
  • offset – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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.

Function BrickletCO2V2.GetTemperatureOffset() As Integer
Rückgabe:
  • offset – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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

Function BrickletCO2V2.GetCO2Concentration() As Integer
Rückgabe:
  • co2Concentration – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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.

Function BrickletCO2V2.GetTemperature() As Short
Rückgabe:
  • temperature – Typ: Short, Wertebereich: [-215 bis 215 - 1]

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.

Function BrickletCO2V2.GetHumidity() As Integer
Rückgabe:
  • humidity – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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

Function BrickletCO2V2.GetAPIVersion() As Byte()
Rückgabe:
  • apiVersion – Typ: Byte Array, Länge: 3, Wertebereich: [0 bis 255]

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.

Function BrickletCO2V2.GetResponseExpected(ByVal functionId As Byte) As Boolean
Parameter:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: Boolean

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:

  • 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
Sub BrickletCO2V2.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)
Parameter:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: Boolean

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

  • 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
Sub BrickletCO2V2.SetResponseExpectedAll(ByVal responseExpected As Boolean)
Parameter:
  • responseExpected – Typ: Boolean

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

Sub BrickletCO2V2.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)
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.

Function BrickletCO2V2.SetBootloaderMode(ByVal mode As Byte) As Byte
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 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:

Für mode:

  • 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

Für status:

  • 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
Function BrickletCO2V2.GetBootloaderMode() As Byte
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:

  • 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
Sub BrickletCO2V2.SetWriteFirmwarePointer(ByVal pointer As Long)
Parameter:
  • pointer – Typ: Long, 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.

Function BrickletCO2V2.WriteFirmware(ByVal data() As Byte) As Byte
Parameter:
  • data – Typ: Byte Array, 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.

Sub BrickletCO2V2.SetStatusLEDConfig(ByVal config As Byte)
Parameter:
  • config – Typ: Byte, Wertebereich: Siehe Konstanten

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:

  • 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
Function BrickletCO2V2.GetStatusLEDConfig() As Byte
Rückgabe:
  • config – Typ: Byte, Wertebereich: Siehe Konstanten

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

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

Für config:

  • 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
Function BrickletCO2V2.GetChipTemperature() As Short
Rückgabe:
  • temperature – Typ: Short, Wertebereich: [-215 bis 215 - 1]

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.

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

Sub BrickletCO2V2.WriteUID(ByVal uid As Long)
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.

Function BrickletCO2V2.ReadUID() As Long
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.

Sub BrickletCO2V2.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)
Ausgabeparameter:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: Char
  • hardwareVersion – Typ: Byte Array, Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: Byte Array, Länge: 3, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: Integer, 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 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

Sub BrickletCO2V2.SetAllValuesCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)
Parameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, 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.

Sub BrickletCO2V2.GetAllValuesCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)
Ausgabeparameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false

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

Sub BrickletCO2V2.SetCO2ConcentrationCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)
Parameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • max – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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

Für option:

  • BrickletCO2V2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletCO2V2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletCO2V2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletCO2V2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletCO2V2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletCO2V2.GetCO2ConcentrationCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)
Ausgabeparameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • max – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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

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

Für option:

  • BrickletCO2V2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletCO2V2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletCO2V2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletCO2V2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletCO2V2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletCO2V2.SetTemperatureCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Short, ByVal max As Short)
Parameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Short, Wertebereich: [-215 bis 215 - 1]
  • max – Typ: Short, Wertebereich: [-215 bis 215 - 1]

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.

Der Standardwert ist (0, false, 'x', 0, 0).

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

Für option:

  • BrickletCO2V2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletCO2V2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletCO2V2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletCO2V2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletCO2V2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletCO2V2.GetTemperatureCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Short, ByRef max As Short)
Ausgabeparameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Short, Wertebereich: [-215 bis 215 - 1]
  • max – Typ: Short, Wertebereich: [-215 bis 215 - 1]

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

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

Für option:

  • BrickletCO2V2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletCO2V2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletCO2V2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletCO2V2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletCO2V2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletCO2V2.SetHumidityCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)
Parameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • max – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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.

Der Standardwert ist (0, false, 'x', 0, 0).

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

Für option:

  • BrickletCO2V2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletCO2V2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletCO2V2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletCO2V2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletCO2V2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletCO2V2.GetHumidityCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)
Ausgabeparameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • max – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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

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

Für option:

  • BrickletCO2V2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletCO2V2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletCO2V2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletCO2V2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletCO2V2.THRESHOLD_OPTION_GREATER = ">"C

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

Sub MyCallback(ByVal sender As BrickletCO2V2, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler co2V2.ExampleCallback, AddressOf MyCallback

Die verfügbaren Callback Properties und ihre Parametertypen 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(ByVal sender As BrickletCO2V2, ByVal co2Concentration As Integer, ByVal temperature As Short, ByVal humidity As Integer)
Callback-Parameter:
  • sender – Typ: BrickletCO2V2
  • co2Concentration – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • temperature – Typ: Short, Wertebereich: [-215 bis 215 - 1]
  • humidity – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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

Die Parameter sind die gleichen wie GetAllValues().

Event BrickletCO2V2.CO2ConcentrationCallback(ByVal sender As BrickletCO2V2, ByVal co2Concentration As Integer)
Callback-Parameter:
  • sender – Typ: BrickletCO2V2
  • co2Concentration – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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

Der Parameter ist der gleiche wie GetCO2Concentration().

Event BrickletCO2V2.TemperatureCallback(ByVal sender As BrickletCO2V2, ByVal temperature As Short)
Callback-Parameter:
  • sender – Typ: BrickletCO2V2
  • temperature – Typ: Short, Wertebereich: [-215 bis 215 - 1]

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

Der Parameter ist der gleiche wie GetTemperature().

Event BrickletCO2V2.HumidityCallback(ByVal sender As BrickletCO2V2, ByVal humidity As Integer)
Callback-Parameter:
  • sender – Typ: BrickletCO2V2
  • humidity – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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

Der Parameter ist der gleiche wie GetHumidity().

Konstanten

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

Const BrickletCO2V2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines CO2 Bricklet 2.0 dar.