Visual Basic .NET - Temperature IR Bricklet

Dies ist die Beschreibung der Visual Basic .NET API Bindings für das Temperature IR Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Temperature IR Bricklet 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
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 Temperature IR Bricklet

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

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

        ' Get current ambient temperature
        Dim ambientTemperature As Short = tir.GetAmbientTemperature()
        Console.WriteLine("Ambient Temperature: " + (ambientTemperature/10.0).ToString() + " °C")

        ' Get current object temperature
        Dim objectTemperature As Short = tir.GetObjectTemperature()
        Console.WriteLine("Object Temperature: " + (objectTemperature/10.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 Temperature IR Bricklet

    ' Callback subroutine for object temperature callback
    Sub ObjectTemperatureCB(ByVal sender As BrickletTemperatureIR, _
                            ByVal temperature As Short)
        Console.WriteLine("Object Temperature: " + (temperature/10.0).ToString() + " °C")
    End Sub

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

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

        ' Register object temperature callback to subroutine ObjectTemperatureCB
        AddHandler tir.ObjectTemperatureCallback, AddressOf ObjectTemperatureCB

        ' Set period for object temperature callback to 1s (1000ms)
        ' Note: The object temperature callback is only called every second
        '       if the object temperature has changed since the last call!
        tir.SetObjectTemperatureCallbackPeriod(1000)

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

Water Boiling

Download (ExampleWaterBoiling.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
38
39
40
41
Imports System
Imports Tinkerforge

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

    ' Callback subroutine for object temperature reached callback
    Sub ObjectTemperatureReachedCB(ByVal sender As BrickletTemperatureIR, _
                                   ByVal temperature As Short)
        Console.WriteLine("Object Temperature: " + (temperature/10.0).ToString() + " °C")
        Console.WriteLine("The water is boiling!")
    End Sub

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

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

        ' Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
        tir.SetEmissivity(64224)

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

        ' Register object temperature reached callback to subroutine
        ' ObjectTemperatureReachedCB
        AddHandler tir.ObjectTemperatureReachedCallback, _
                   AddressOf ObjectTemperatureReachedCB

        ' Configure threshold for object temperature "greater than 100 °C"
        tir.SetObjectTemperatureCallbackThreshold(">"C, 100*10, 0)

        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 BrickletTemperatureIR(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim temperatureIR As New BrickletTemperatureIR("YOUR_DEVICE_UID", ipcon)

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

Function BrickletTemperatureIR.GetAmbientTemperature() As Short

Gibt die Umgebungstemperatur des Sensors zurück. Der Wertebereich ist von -400 bis 1250 und wird in °C/10 angegeben, z.B. bedeutet ein Wert von 423 eine gemessene Umgebungstemperatur von 42,3 °C.

Wenn die Umgebungstemperatur periodisch abgefragt werden soll, wird empfohlen den AmbientTemperatureCallback Callback zu nutzen und die Periode mit SetAmbientTemperatureCallbackPeriod() vorzugeben.

Function BrickletTemperatureIR.GetObjectTemperature() As Short

Gibt die Objekttemperatur des Sensors zurück, z.B. die Temperatur der Oberfläche auf welche der Sensor zielt. Der Wertebereich ist von -700 bis 3800 und wird in °C/10 angegeben, z.B. bedeutet ein Wert von 3001 eine gemessene Temperatur von 300,1 °C auf der Oberfläche des Objektes.

Die Temperatur von unterschiedlichen Materialien ist abhängig von ihrem Emissionsgrad. Der Emissionsgrad des Materials kann mit SetEmissivity() gesetzt werden.

Wenn die Objekttemperatur periodisch abgefragt werden soll, wird empfohlen den ObjectTemperatureCallback Callback zu nutzen und die Periode mit SetObjectTemperatureCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

Sub BrickletTemperatureIR.SetEmissivity(ByVal emissivity As Integer)

Setzt den Emissionsgrad, welcher zur Berechnung der Oberflächentemperatur benutzt wird, wie von GetObjectTemperature() zurückgegeben.

Der Emissionsgrad wird normalerweise als Wert zwischen 0,0 und 1,0 angegeben. Eine Liste von Emissionsgraden unterschiedlicher Materialien ist hier zu finden.

Der Parameter von SetEmissivity() muss mit eine Faktor von 65535 (16-Bit) vorgegeben werden. Beispiel: Ein Emissionsgrad von 0,1 kann mit dem Wert 6553 gesetzt werden, ein Emissionsgrad von 0,5 mit dem Wert 32767 und so weiter.

Bemerkung

Wenn eine exakte Messung der Objekttemperatur notwendig ist, ist es entscheidend eine exakten Emissionsgrad anzugeben.

Der Standard Emissionsgrad ist 1,0 (Wert von 65535) und der minimale Emissionsgrad welcher der Sensor verarbeiten kann ist 0,1 (Wert von 6553).

Function BrickletTemperatureIR.GetEmissivity() As Integer

Gibt den Emissionsgrad zurück, wie von SetEmissivity() gesetzt.

Function BrickletTemperatureIR.GetAPIVersion() As Byte()

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 BrickletTemperatureIR.GetResponseExpected(ByVal functionId As Byte) As 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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

Sub BrickletTemperatureIR.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As 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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletTemperatureIR.FUNCTION_SET_EMISSIVITY = 3
  • BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
  • BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
  • BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
  • BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
  • BrickletTemperatureIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13
Sub BrickletTemperatureIR.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

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

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 BrickletTemperatureIR.SetAmbientTemperatureCallbackPeriod(ByVal period As Long)

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

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

Der Standardwert ist 0.

Function BrickletTemperatureIR.GetAmbientTemperatureCallbackPeriod() As Long

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

Sub BrickletTemperatureIR.SetObjectTemperatureCallbackPeriod(ByVal period As Long)

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

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

Der Standardwert ist 0.

Function BrickletTemperatureIR.GetObjectTemperatureCallbackPeriod() As Long

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

Sub BrickletTemperatureIR.SetAmbientTemperatureCallbackThreshold(ByVal option As Char, ByVal min As Short, ByVal max As Short)

Setzt den Schwellwert für den AmbientTemperatureReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

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

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = "x"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletTemperatureIR.GetAmbientTemperatureCallbackThreshold(ByRef option As Char, ByRef min As Short, ByRef max As Short)

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

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

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = "x"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletTemperatureIR.SetObjectTemperatureCallbackThreshold(ByVal option As Char, ByVal min As Short, ByVal max As Short)

Setzt den Schwellwert für den ObjectTemperatureReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

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

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = "x"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletTemperatureIR.GetObjectTemperatureCallbackThreshold(ByRef option As Char, ByRef min As Short, ByRef max As Short)

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

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

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = "x"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletTemperatureIR.SetDebouncePeriod(ByVal debounce As Long)

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

Function BrickletTemperatureIR.GetDebouncePeriod() As Long

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

AddHandler temperatureIR.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 BrickletTemperatureIR.AmbientTemperatureCallback(ByVal sender As BrickletTemperatureIR, ByVal temperature As Short)

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

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

Event BrickletTemperatureIR.ObjectTemperatureCallback(ByVal sender As BrickletTemperatureIR, ByVal temperature As Short)

Dieser Callback wird mit der Periode, wie gesetzt mit SetObjectTemperatureCallbackPeriod(), ausgelöst. Der Parameter ist die Objekttemperatur des Sensors.

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

Event BrickletTemperatureIR.AmbientTemperatureReachedCallback(ByVal sender As BrickletTemperatureIR, ByVal temperature As Short)

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von SetAmbientTemperatureCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Umgebungstemperatur des Sensors.

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

Event BrickletTemperatureIR.ObjectTemperatureReachedCallback(ByVal sender As BrickletTemperatureIR, ByVal temperature As Short)

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von SetObjectTemperatureCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Objekttemperatur des Sensors.

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

Konstanten

Const BrickletTemperatureIR.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Temperature IR Bricklet zu identifizieren.

Die GetIdentity() Funktion und der EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

Const BrickletTemperatureIR.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Temperature IR Bricklet dar.