Visual Basic .NET - CO2 Bricklet¶

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

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

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim co2 As New BrickletCO2(UID, ipcon) ' Create device object

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

        ' Get current CO2 concentration
        Dim co2Concentration As Integer = co2.GetCO2Concentration()
        Console.WriteLine("CO2 Concentration: " + co2Concentration.ToString() + " ppm")

        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

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

    ' Callback subroutine for CO2 concentration callback
    Sub CO2ConcentrationCB(ByVal sender As BrickletCO2, _
                           ByVal co2Concentration As Integer)
        Console.WriteLine("CO2 Concentration: " + co2Concentration.ToString() + " ppm")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim co2 As New BrickletCO2(UID, ipcon) ' Create device object

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

        ' Register CO2 concentration callback to subroutine CO2ConcentrationCB
        AddHandler co2.CO2ConcentrationCallback, AddressOf CO2ConcentrationCB

        ' Set period for CO2 concentration callback to 1s (1000ms)
        ' Note: The CO2 concentration callback is only called every second
        '       if the CO2 concentration has changed since the last call!
        co2.SetCO2ConcentrationCallbackPeriod(1000)

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

Threshold¶

Download (ExampleThreshold.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
36
37

Imports System
Imports Tinkerforge

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

    ' Callback subroutine for CO2 concentration reached callback
    Sub CO2ConcentrationReachedCB(ByVal sender As BrickletCO2, _
                                  ByVal co2Concentration As Integer)
        Console.WriteLine("CO2 Concentration: " + co2Concentration.ToString() + " ppm")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim co2 As New BrickletCO2(UID, ipcon) ' Create device object

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

        ' Get threshold callbacks with a debounce time of 10 seconds (10000ms)
        co2.SetDebouncePeriod(10000)

        ' Register CO2 concentration reached callback to subroutine
        ' CO2ConcentrationReachedCB
        AddHandler co2.CO2ConcentrationReachedCallback, _
                   AddressOf CO2ConcentrationReachedCB

        ' Configure threshold for CO2 concentration "greater than 750 ppm"
        co2.SetCO2ConcentrationCallbackThreshold(">"C, 750, 0)

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

Grundfunktionen¶

Class BrickletCO2(ByVal uid As String, ByVal ipcon As IPConnection)¶

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

Dim co2 As New BrickletCO2("YOUR_DEVICE_UID", ipcon)

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

Function BrickletCO2.GetCO2Concentration() As Integer¶

Rückgabe:	co2Concentration – Typ: Integer, Einheit: 1 ppm, Wertebereich: [0 bis 10000]

Gibt die gemessene CO2-Konzentration zurück.

Wenn die CO2-Konzentration periodisch abgefragt werden soll, wird empfohlen den CO2ConcentrationCallback Callback zu nutzen und die Periode mit SetCO2ConcentrationCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

Sub BrickletCO2.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, Wertebereich: ["a"C bis "h"C, "z"C] hardwareVersion – Typ: Byte Array, 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 Array, 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: 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 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¶

Sub BrickletCO2.SetCO2ConcentrationCallbackPeriod(ByVal period As Long)¶

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

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

Der CO2ConcentrationCallback Callback wird nur ausgelöst, wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

Function BrickletCO2.GetCO2ConcentrationCallbackPeriod() As Long¶

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

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

Sub BrickletCO2.SetCO2ConcentrationCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)¶

Parameter:	option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C min – Typ: Integer, Einheit: 1 ppm, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 ppm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den CO2ConcentrationReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

Sub BrickletCO2.GetCO2ConcentrationCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)¶

Ausgabeparameter:	option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C min – Typ: Integer, Einheit: 1 ppm, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 ppm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

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

Sub BrickletCO2.SetDebouncePeriod(ByVal debounce As Long)¶

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

Setzt die Periode mit welcher die Schwellwert Callbacks

• CO2ConcentrationReachedCallback,

ausgelöst werden, wenn die Schwellwerte

• SetCO2ConcentrationCallbackThreshold(),

weiterhin erreicht bleiben.

Function BrickletCO2.GetDebouncePeriod() As Long¶

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

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

Callbacks¶

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

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

AddHandler co2.ExampleCallback, AddressOf MyCallback

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

Event BrickletCO2.CO2ConcentrationCallback(ByVal sender As BrickletCO2, ByVal co2Concentration As Integer)¶

Callback-Parameter:	sender – Typ: BrickletCO2 co2Concentration – Typ: Integer, Einheit: 1 ppm, Wertebereich: [0 bis 10000]

Dieser Callback wird mit der Periode, wie gesetzt mit SetCO2ConcentrationCallbackPeriod(), ausgelöst. Der Parameter ist die gemessene CO2-Konzentration des Sensors.

Der CO2ConcentrationCallback Callback wird nur ausgelöst, wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

Event BrickletCO2.CO2ConcentrationReachedCallback(ByVal sender As BrickletCO2, ByVal co2Concentration As Integer)¶

Callback-Parameter:	sender – Typ: BrickletCO2 co2Concentration – Typ: Integer, Einheit: 1 ppm, Wertebereich: [0 bis 10000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetCO2ConcentrationCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die gemessene CO2-Konzentration.

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

Virtuelle Funktionen¶

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

Function BrickletCO2.GetAPIVersion() As Byte()¶

Ausgabeparameter:	apiVersion – Typ: Byte Array, 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.

Function BrickletCO2.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:

• BrickletCO2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD = 2
• BrickletCO2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD = 4
• BrickletCO2.FUNCTION_SET_DEBOUNCE_PERIOD = 6

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

• BrickletCO2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD = 2
• BrickletCO2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD = 4
• BrickletCO2.FUNCTION_SET_DEBOUNCE_PERIOD = 6

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

Konstanten¶

Const BrickletCO2.DEVICE_IDENTIFIER¶

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

Const BrickletCO2.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines CO2 Bricklet dar.