Visual Basic .NET - Temperature Bricklet¶

Simple¶

Download (ExampleSimple.vb)

 1Imports System
 2Imports Tinkerforge
 3
 4Module ExampleSimple
 5    Const HOST As String = "localhost"
 6    Const PORT As Integer = 4223
 7    Const UID As String = "XYZ" ' Change XYZ to the UID of your Temperature Bricklet
 8
 9    Sub Main()
10        Dim ipcon As New IPConnection() ' Create IP connection
11        Dim t As New BrickletTemperature(UID, ipcon) ' Create device object
12
13        ipcon.Connect(HOST, PORT) ' Connect to brickd
14        ' Don't use device before ipcon is connected
15
16        ' Get current temperature
17        Dim temperature As Short = t.GetTemperature()
18        Console.WriteLine("Temperature: " + (temperature/100.0).ToString() + " °C")
19
20        Console.WriteLine("Press key to exit")
21        Console.ReadLine()
22        ipcon.Disconnect()
23    End Sub
24End Module

Callback¶

Download (ExampleCallback.vb)

 1Imports System
 2Imports Tinkerforge
 3
 4Module ExampleCallback
 5    Const HOST As String = "localhost"
 6    Const PORT As Integer = 4223
 7    Const UID As String = "XYZ" ' Change XYZ to the UID of your Temperature Bricklet
 8
 9    ' Callback subroutine for temperature callback
10    Sub TemperatureCB(ByVal sender As BrickletTemperature, ByVal temperature As Short)
11        Console.WriteLine("Temperature: " + (temperature/100.0).ToString() + " °C")
12    End Sub
13
14    Sub Main()
15        Dim ipcon As New IPConnection() ' Create IP connection
16        Dim t As New BrickletTemperature(UID, ipcon) ' Create device object
17
18        ipcon.Connect(HOST, PORT) ' Connect to brickd
19        ' Don't use device before ipcon is connected
20
21        ' Register temperature callback to subroutine TemperatureCB
22        AddHandler t.TemperatureCallback, AddressOf TemperatureCB
23
24        ' Set period for temperature callback to 1s (1000ms)
25        ' Note: The temperature callback is only called every second
26        '       if the temperature has changed since the last call!
27        t.SetTemperatureCallbackPeriod(1000)
28
29        Console.WriteLine("Press key to exit")
30        Console.ReadLine()
31        ipcon.Disconnect()
32    End Sub
33End Module

Threshold¶

Download (ExampleThreshold.vb)

 1Imports System
 2Imports Tinkerforge
 3
 4Module ExampleThreshold
 5    Const HOST As String = "localhost"
 6    Const PORT As Integer = 4223
 7    Const UID As String = "XYZ" ' Change XYZ to the UID of your Temperature Bricklet
 8
 9    ' Callback subroutine for temperature reached callback
10    Sub TemperatureReachedCB(ByVal sender As BrickletTemperature, _
11                             ByVal temperature As Short)
12        Console.WriteLine("Temperature: " + (temperature/100.0).ToString() + " °C")
13        Console.WriteLine("It is too hot, we need air conditioning!")
14    End Sub
15
16    Sub Main()
17        Dim ipcon As New IPConnection() ' Create IP connection
18        Dim t As New BrickletTemperature(UID, ipcon) ' Create device object
19
20        ipcon.Connect(HOST, PORT) ' Connect to brickd
21        ' Don't use device before ipcon is connected
22
23        ' Get threshold callbacks with a debounce time of 10 seconds (10000ms)
24        t.SetDebouncePeriod(10000)
25
26        ' Register temperature reached callback to subroutine TemperatureReachedCB
27        AddHandler t.TemperatureReachedCallback, AddressOf TemperatureReachedCB
28
29        ' Configure threshold for temperature "greater than 30 °C"
30        t.SetTemperatureCallbackThreshold(">"C, 30*100, 0)
31
32        Console.WriteLine("Press key to exit")
33        Console.ReadLine()
34        ipcon.Disconnect()
35    End Sub
36End Module

Grundfunktionen¶

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

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

Dim temperature As New BrickletTemperature("YOUR_DEVICE_UID", ipcon)

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

Function BrickletTemperature.GetTemperature() As Short¶

Rückgabe:	temperature – Typ: Short, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

Gibt die Temperatur des Sensors 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 BrickletTemperature.SetI2CMode(ByVal mode As Byte)¶

Parameter:	mode – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den I2C Modus. Mögliche Modi sind:

• 0: Fast (400kHz)

• 1: Slow (100kHz)

Wenn Probleme mit offensichtlichen Ausreißern in den Temperature Bricklet Messungen auftreten, können diese eventuell aufgrund von elektromagnetischen Störungen sein. In diesem Fall kann es helfen die I2C Geschwindigkeit zu verringern.

Falls in einem System ein hoher Durchsatz an Nachrichten erwünscht ist, sollte die I2C Geschwindigkeit allerdings nicht verringert werden.

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

Für mode:

• BrickletTemperature.I2C_MODE_FAST = 0

• BrickletTemperature.I2C_MODE_SLOW = 1

Added in version 2.0.1$nbsp;(Plugin).

Function BrickletTemperature.GetI2CMode() As Byte¶

Rückgabe:	mode – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt den I2C Modus zurück, wie von SetI2CMode() gesetzt.

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

Für mode:

• BrickletTemperature.I2C_MODE_FAST = 0

• BrickletTemperature.I2C_MODE_SLOW = 1

Added in version 2.0.1$nbsp;(Plugin).

Sub BrickletTemperature.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 BrickletTemperature.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 BrickletTemperature.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 BrickletTemperature.SetTemperatureCallbackThreshold(ByVal option As Char, ByVal min As Short, ByVal max As Short)¶

Parameter:	option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C min – Typ: Short, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: Short, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 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:

• BrickletTemperature.THRESHOLD_OPTION_OFF = "x"C

• BrickletTemperature.THRESHOLD_OPTION_OUTSIDE = "o"C

• BrickletTemperature.THRESHOLD_OPTION_INSIDE = "i"C

• BrickletTemperature.THRESHOLD_OPTION_SMALLER = "<"C

• BrickletTemperature.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletTemperature.GetTemperatureCallbackThreshold(ByRef option As Char, ByRef min As Short, ByRef max As Short)¶

Ausgabeparameter:	option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C min – Typ: Short, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: Short, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 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:

• BrickletTemperature.THRESHOLD_OPTION_OFF = "x"C

• BrickletTemperature.THRESHOLD_OPTION_OUTSIDE = "o"C

• BrickletTemperature.THRESHOLD_OPTION_INSIDE = "i"C

• BrickletTemperature.THRESHOLD_OPTION_SMALLER = "<"C

• BrickletTemperature.THRESHOLD_OPTION_GREATER = ">"C

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

AddHandler temperature.ExampleCallback, AddressOf MyCallback

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

Event BrickletTemperature.TemperatureCallback(ByVal sender As BrickletTemperature, ByVal temperature As Short)¶

Callback-Parameter:	sender – Typ: BrickletTemperature temperature – Typ: Short, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

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

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

Event BrickletTemperature.TemperatureReachedCallback(ByVal sender As BrickletTemperature, ByVal temperature As Short)¶

Callback-Parameter:	sender – Typ: BrickletTemperature temperature – Typ: Short, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

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

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

• BrickletTemperature.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2

• BrickletTemperature.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4

• BrickletTemperature.FUNCTION_SET_DEBOUNCE_PERIOD = 6

• BrickletTemperature.FUNCTION_SET_I2C_MODE = 10

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

• BrickletTemperature.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2

• BrickletTemperature.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4

• BrickletTemperature.FUNCTION_SET_DEBOUNCE_PERIOD = 6

• BrickletTemperature.FUNCTION_SET_I2C_MODE = 10

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

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

Diese Konstante stellt den Anzeigenamen eines Temperature Bricklet dar.