Visual Basic .NET - Thermocouple 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 Thermocouple Bricklet

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

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

        ' Get current temperature
        Dim temperature As Integer = t.GetTemperature()
        Console.WriteLine("Temperature: " + (temperature/100.0).ToString() + " °C")

        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 Thermocouple Bricklet

    ' Callback subroutine for temperature callback
    Sub TemperatureCB(ByVal sender As BrickletThermocouple, _
                      ByVal temperature As Integer)
        Console.WriteLine("Temperature: " + (temperature/100.0).ToString() + " °C")
    End Sub

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

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

        ' Register temperature callback to subroutine TemperatureCB
        AddHandler t.TemperatureCallback, AddressOf TemperatureCB

        ' Set period for temperature callback to 1s (1000ms)
        ' Note: The temperature callback is only called every second
        '       if the temperature has changed since the last call!
        t.SetTemperatureCallbackPeriod(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

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 Thermocouple Bricklet

    ' Callback subroutine for temperature reached callback
    Sub TemperatureReachedCB(ByVal sender As BrickletThermocouple, _
                             ByVal temperature As Integer)
        Console.WriteLine("Temperature: " + (temperature/100.0).ToString() + " °C")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim t As New BrickletThermocouple(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)
        t.SetDebouncePeriod(10000)

        ' Register temperature reached callback to subroutine TemperatureReachedCB
        AddHandler t.TemperatureReachedCallback, AddressOf TemperatureReachedCB

        ' Configure threshold for temperature "greater than 30 °C"
        t.SetTemperatureCallbackThreshold(">"C, 30*100, 0)

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

Grundfunktionen¶

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

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

Dim thermocouple As New BrickletThermocouple("YOUR_DEVICE_UID", ipcon)

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

Function BrickletThermocouple.GetTemperature() As Integer¶

Rückgabe:	temperature – Typ: Integer, Einheit: 1/100 °C, Wertebereich: [-21000 bis 180000]

Gibt die Temperatur des Thermoelements zurück.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den TemperatureCallback Callback zu nutzen und die Periode mit SetTemperatureCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

Sub BrickletThermocouple.SetConfiguration(ByVal averaging As Byte, ByVal thermocoupleType As Byte, ByVal filter As Byte)¶

Parameter:	averaging – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 16 thermocoupleType – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3 filter – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Konfiguriert werden können Averaging-Größe, Thermoelement-Typ und Frequenz-Filterung.

Mögliche Averaging-Größen sind 1, 2, 4, 8 und 16 Samples.

Als Thermoelement-Typ stehen B, E, J, K, N, R, S und T zur Verfügung. Falls ein anderes Thermoelement benutzt werden soll, können G8 und G32 genutzt werden. Mit diesen Typen wird der Wert nicht in °C/100 zurückgegeben sondern er wird durch folgende Formeln bestimmt:

• G8: Wert = 8 * 1.6 * 2^17 * Vin
• G32: Wert = 32 * 1.6 * 2^17 * Vin

dabei ist Vin die Eingangsspannung des Thermoelements.

Der Frequenz-Filter kann auf 50Hz und 60Hz konfiguriert werden. Er sollte abhängig von der lokalen Netzfrequenz gewählt werden.

Die Konvertierungszeit ist abhängig von der Averaging-Größe und der Frequenz-Filter-Konfiguration. Sie kann wie folgt bestimmt werden:

• 60Hz: Zeit = 82 + (Samples - 1) * 16.67
• 50Hz: Zeit = 98 + (Samples - 1) * 20

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

Für averaging:

• BrickletThermocouple.AVERAGING_1 = 1
• BrickletThermocouple.AVERAGING_2 = 2
• BrickletThermocouple.AVERAGING_4 = 4
• BrickletThermocouple.AVERAGING_8 = 8
• BrickletThermocouple.AVERAGING_16 = 16

Für thermocoupleType:

• BrickletThermocouple.TYPE_B = 0
• BrickletThermocouple.TYPE_E = 1
• BrickletThermocouple.TYPE_J = 2
• BrickletThermocouple.TYPE_K = 3
• BrickletThermocouple.TYPE_N = 4
• BrickletThermocouple.TYPE_R = 5
• BrickletThermocouple.TYPE_S = 6
• BrickletThermocouple.TYPE_T = 7
• BrickletThermocouple.TYPE_G8 = 8
• BrickletThermocouple.TYPE_G32 = 9

Für filter:

• BrickletThermocouple.FILTER_OPTION_50HZ = 0
• BrickletThermocouple.FILTER_OPTION_60HZ = 1

Sub BrickletThermocouple.GetConfiguration(ByRef averaging As Byte, ByRef thermocoupleType As Byte, ByRef filter As Byte)¶

Ausgabeparameter:	averaging – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 16 thermocoupleType – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3 filter – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für averaging:

• BrickletThermocouple.AVERAGING_1 = 1
• BrickletThermocouple.AVERAGING_2 = 2
• BrickletThermocouple.AVERAGING_4 = 4
• BrickletThermocouple.AVERAGING_8 = 8
• BrickletThermocouple.AVERAGING_16 = 16

Für thermocoupleType:

• BrickletThermocouple.TYPE_B = 0
• BrickletThermocouple.TYPE_E = 1
• BrickletThermocouple.TYPE_J = 2
• BrickletThermocouple.TYPE_K = 3
• BrickletThermocouple.TYPE_N = 4
• BrickletThermocouple.TYPE_R = 5
• BrickletThermocouple.TYPE_S = 6
• BrickletThermocouple.TYPE_T = 7
• BrickletThermocouple.TYPE_G8 = 8
• BrickletThermocouple.TYPE_G32 = 9

Für filter:

• BrickletThermocouple.FILTER_OPTION_50HZ = 0
• BrickletThermocouple.FILTER_OPTION_60HZ = 1

Sub BrickletThermocouple.GetErrorState(ByRef overUnder As Boolean, ByRef openCircuit As Boolean)¶

Ausgabeparameter:	overUnder – Typ: Boolean openCircuit – Typ: Boolean

Gibt den aktuellen Error-Status zurück. Es gibt zwei mögliche Status:

• Over/Under Voltage und
• Open Circuit.

Over/Under Voltage bei Spannungen unter 0V oder über 3.3V ausgelöst. In diesem Fall ist mit hoher Wahrscheinlichkeit das Thermoelement defekt. Ein Open Circuit-Error deutet darauf hin, das kein Thermoelement angeschlossen ist.

Der ErrorStateCallback Callback wird automatisch jedes mal ausgelöst, wenn sich der Error-Status ändert.

Sub BrickletThermocouple.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 BrickletThermocouple.SetTemperatureCallbackPeriod(ByVal period As Long)¶

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

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

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

Function BrickletThermocouple.GetTemperatureCallbackPeriod() As Long¶

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

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

Sub BrickletThermocouple.SetTemperatureCallbackThreshold(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/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Setzt den Schwellwert für den TemperatureReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

Sub BrickletThermocouple.GetTemperatureCallbackThreshold(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/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

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

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

• TemperatureReachedCallback

ausgelöst wird, wenn der Schwellwert

• SetTemperatureCallbackThreshold()

weiterhin erreicht bleibt.

Function BrickletThermocouple.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 BrickletThermocouple, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler thermocouple.ExampleCallback, AddressOf MyCallback

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

Event BrickletThermocouple.TemperatureCallback(ByVal sender As BrickletThermocouple, ByVal temperature As Integer)¶

Callback-Parameter:	sender – Typ: BrickletThermocouple temperature – Typ: Integer, Einheit: 1/100 °C, Wertebereich: [-21000 bis 180000]

Dieser Callback wird mit der Periode, wie gesetzt mit SetTemperatureCallbackPeriod(), ausgelöst. Der Parameter ist die Temperatur des Thermoelements.

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

Event BrickletThermocouple.TemperatureReachedCallback(ByVal sender As BrickletThermocouple, ByVal temperature As Integer)¶

Callback-Parameter:	sender – Typ: BrickletThermocouple temperature – Typ: Integer, Einheit: 1/100 °C, Wertebereich: [-21000 bis 180000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetTemperatureCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Temperatur des Thermoelements.

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

Event BrickletThermocouple.ErrorStateCallback(ByVal sender As BrickletThermocouple, ByVal overUnder As Boolean, ByVal openCircuit As Boolean)¶

Callback-Parameter:	sender – Typ: BrickletThermocouple overUnder – Typ: Boolean openCircuit – Typ: Boolean

Dieser Callback wird ausgelöst, wenn der Error-Status sich verändert (siehe GetErrorState()).

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 BrickletThermocouple.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 BrickletThermocouple.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:

• BrickletThermocouple.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
• BrickletThermocouple.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
• BrickletThermocouple.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletThermocouple.FUNCTION_SET_CONFIGURATION = 10

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

• BrickletThermocouple.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
• BrickletThermocouple.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
• BrickletThermocouple.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletThermocouple.FUNCTION_SET_CONFIGURATION = 10

Sub BrickletThermocouple.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 BrickletThermocouple.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Thermocouple 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 BrickletThermocouple.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Thermocouple Bricklet dar.