Visual Basic .NET - PTC Bricklet

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

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim ptc As New BrickletPTC(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 = ptc.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
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 PTC Bricklet

    ' Callback subroutine for temperature callback
    Sub TemperatureCB(ByVal sender As BrickletPTC, 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 ptc As New BrickletPTC(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 ptc.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!
        ptc.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
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 PTC Bricklet

    ' Callback subroutine for temperature reached callback
    Sub TemperatureReachedCB(ByVal sender As BrickletPTC, 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 ptc As New BrickletPTC(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)
        ptc.SetDebouncePeriod(10000)

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

        ' Configure threshold for temperature "greater than 30 °C"
        ptc.SetTemperatureCallbackThreshold(">"C, 30*100, 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 BrickletPTC(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim ptc As New BrickletPTC("YOUR_DEVICE_UID", ipcon)

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

Function BrickletPTC.GetTemperature() As Integer

Gibt die Temperatur des verbundenen Sensors zurück. Der Wertebereich ist von -246 bis 849 °C und wird in °C/100 angegeben, z.B. bedeutet ein Wert von 4223 eine gemessene Temperatur von 42,23 °C.

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

Function BrickletPTC.IsSensorConnected() As Boolean

Gibt true zurück wenn ein Sensor korrekt verbunden ist.

Falls diese Funktion false zurück gibt, ist entweder kein Pt100 oder Pt1000 Sensor verbunden, der Sensor ist inkorrekt verbunden oder der Sensor selbst ist fehlerhaft.

Sub BrickletPTC.SetWireMode(ByVal mode As Byte)

Stellt die Leiter-Konfiguration des Sensors ein. Mögliche Werte sind 2, 3 und 4, dies entspricht 2-, 3- und 4-Leiter-Sensoren. Der Wert muss er Jumper-Konfiguration am Bricklet entsprechen.

Der Standardwert ist 2 = 2-Leiter.

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

  • BrickletPTC.WIRE_MODE_2 = 2
  • BrickletPTC.WIRE_MODE_3 = 3
  • BrickletPTC.WIRE_MODE_4 = 4
Function BrickletPTC.GetWireMode() As Byte

Gibt die Leiter-Konfiguration zurück, wie von SetWireMode() gesetzt.

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

  • BrickletPTC.WIRE_MODE_2 = 2
  • BrickletPTC.WIRE_MODE_3 = 3
  • BrickletPTC.WIRE_MODE_4 = 4

Fortgeschrittene Funktionen

Function BrickletPTC.GetResistance() As Integer

Gibt den Wert zurück, wie vom "MAX31865 Präzisions Delta-Sigma ADC" berechnet.

Der Wert kann mit den folgenden Formeln in einen Widerstand konvertiert werden:

  • Pt100: Widerstand = (Wert * 390) / 32768
  • Pt1000: Widerstand = (Wert * 3900) / 32768

Wenn der Widerstand periodisch abgefragt werden soll, wird empfohlen den ResistanceCallback Callback zu nutzen und die Periode mit SetResistanceCallbackPeriod() vorzugeben.

Sub BrickletPTC.SetNoiseRejectionFilter(ByVal filter As Byte)

Setzt den Entstörfilter auf 50Hz (0) oder 60Hz (1). Störungen von 50Hz oder 60Hz Stromquellen (inklusive Oberwellen der Stromquellen-Grundfrequenz) werden um 82dB abgeschwächt.

Der Standardwert ist 0 = 50Hz.

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

  • BrickletPTC.FILTER_OPTION_50HZ = 0
  • BrickletPTC.FILTER_OPTION_60HZ = 1
Function BrickletPTC.GetNoiseRejectionFilter() As Byte

Gibt die Einstellung des Entstörfilters zurück, wie von SetNoiseRejectionFilter() gesetzt.

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

  • BrickletPTC.FILTER_OPTION_50HZ = 0
  • BrickletPTC.FILTER_OPTION_60HZ = 1
Function BrickletPTC.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 BrickletPTC.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 BrickletPTC.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:

  • BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
  • BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
  • BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
  • BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
  • BrickletPTC.FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletPTC.FUNCTION_SET_NOISE_REJECTION_FILTER = 17
  • BrickletPTC.FUNCTION_SET_WIRE_MODE = 20
  • BrickletPTC.FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22
Sub BrickletPTC.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

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

Setzt die Periode in ms 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.

Der Standardwert ist 0.

Function BrickletPTC.GetTemperatureCallbackPeriod() As Long

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

Sub BrickletPTC.SetResistanceCallbackPeriod(ByVal period As Long)

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

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

Der Standardwert ist 0.

Function BrickletPTC.GetResistanceCallbackPeriod() As Long

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

Sub BrickletPTC.SetTemperatureCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

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)

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

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

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

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

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

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

Setzt den Schwellwert für den ResistanceReachedCallback 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)

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

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

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

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

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

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

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

Function BrickletPTC.GetDebouncePeriod() As Long

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

Sub BrickletPTC.SetSensorConnectedCallbackConfiguration(ByVal enabled As Boolean)

Wenn dieser Callback aktiviert ist, wird der SensorConnectedCallback Callback jedes mal ausgelöst, wenn ein Pt-Sensor verbunden/getrennt wird.

Standardmäßig ist dieser Callback deaktiviert.

Neu in Version 2.0.2 (Plugin).

Function BrickletPTC.GetSensorConnectedCallbackConfiguration() As Boolean

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

Neu in Version 2.0.2 (Plugin).

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

AddHandler ptc.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 BrickletPTC.TemperatureCallback(ByVal sender As BrickletPTC, ByVal temperature As Integer)

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

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

Event BrickletPTC.TemperatureReachedCallback(ByVal sender As BrickletPTC, ByVal temperature As Integer)

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

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

Event BrickletPTC.ResistanceCallback(ByVal sender As BrickletPTC, ByVal resistance As Integer)

Dieser Callback wird mit der Periode, wie gesetzt mit SetResistanceCallbackPeriod(), ausgelöst. Der Parameter ist der Widerstand des verbundenen Sensors.

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

Event BrickletPTC.ResistanceReachedCallback(ByVal sender As BrickletPTC, ByVal resistance As Integer)

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetResistanceCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Widerstand des verbundenen Sensors.

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

Event BrickletPTC.SensorConnectedCallback(ByVal sender As BrickletPTC, ByVal connected As Boolean)

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

Der Parameter ist der gleiche wie bei IsSensorConnected().

Neu in Version 2.0.2 (Plugin).

Konstanten

Const BrickletPTC.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein PTC 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 BrickletPTC.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines PTC Bricklet dar.