Visual Basic .NET - PTC Bricklet 2.0

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

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim ptc As New BrickletPTCV2(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
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 2.0

    ' Callback subroutine for temperature callback
    Sub TemperatureCB(ByVal sender As BrickletPTCV2, 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 BrickletPTCV2(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) without a threshold
        ptc.SetTemperatureCallbackConfiguration(1000, False, "x"C, 0, 0)

        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
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 2.0

    ' Callback subroutine for temperature callback
    Sub TemperatureCB(ByVal sender As BrickletPTCV2, 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 BrickletPTCV2(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

        ' Configure threshold for temperature "greater than 30 °C"
        ' with a debounce period of 1s (1000ms)
        ptc.SetTemperatureCallbackConfiguration(1000, False, ">"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 BrickletPTCV2(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim ptcV2 As New BrickletPTCV2("YOUR_DEVICE_UID", ipcon)

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

Function BrickletPTCV2.GetTemperature() As Integer
Rückgabe:
  • temperature – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

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 der Wert periodisch benötigt wird, kann auch der TemperatureCallback Callback verwendet werden. Der Callback wird mit der Funktion SetTemperatureCallbackConfiguration() konfiguriert.

Function BrickletPTCV2.GetResistance() As Integer
Rückgabe:
  • resistance – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

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 Wert periodisch benötigt wird, kann auch der ResistanceCallback Callback verwendet werden. Der Callback wird mit der Funktion SetResistanceCallbackConfiguration() konfiguriert.

Function BrickletPTCV2.IsSensorConnected() As Boolean
Rückgabe:
  • connected – Typ: 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.

Zum automatischen übertragen des Status kann auch der SensorConnectedCallback Callback verwendet werden. Der Callback wird mit der Funktion SetSensorConnectedCallbackConfiguration() konfiguriert.

Sub BrickletPTCV2.SetWireMode(ByVal mode As Byte)
Parameter:
  • mode – Typ: Byte, Wertebereich: Siehe Konstanten

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:

Für mode:

  • BrickletPTCV2.WIRE_MODE_2 = 2
  • BrickletPTCV2.WIRE_MODE_3 = 3
  • BrickletPTCV2.WIRE_MODE_4 = 4
Function BrickletPTCV2.GetWireMode() As Byte
Rückgabe:
  • mode – Typ: Byte, Wertebereich: Siehe Konstanten

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

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

Für mode:

  • BrickletPTCV2.WIRE_MODE_2 = 2
  • BrickletPTCV2.WIRE_MODE_3 = 3
  • BrickletPTCV2.WIRE_MODE_4 = 4
Sub BrickletPTCV2.SetMovingAverageConfiguration(ByVal movingAverageLengthResistance As Integer, ByVal movingAverageLengthTemperature As Integer)
Parameter:
  • movingAverageLengthResistance – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • movingAverageLengthTemperature – Typ: Integer, Wertebereich: [0 bis 216 - 1]

Setzt die Länge eines gleitenden Mittelwerts für den Widerstand und die Temperatur.

Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 1-1000.

Einer neue Wert wird alle 20ms gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von 20s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

Der Standardwert ist 1 für den Widerstand und 40 für die Temperatur. Die Standardwerte entsprechen den nicht-änderbaren Mittelwert-Einstellungen des alten PTC Bricklet 1.0.

Sub BrickletPTCV2.GetMovingAverageConfiguration(ByRef movingAverageLengthResistance As Integer, ByRef movingAverageLengthTemperature As Integer)
Ausgabeparameter:
  • movingAverageLengthResistance – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • movingAverageLengthTemperature – Typ: Integer, Wertebereich: [0 bis 216 - 1]

Gibt die Moving Average-Konfiguration zurück, wie von SetMovingAverageConfiguration() gesetzt.

Fortgeschrittene Funktionen

Sub BrickletPTCV2.SetNoiseRejectionFilter(ByVal filter As Byte)
Parameter:
  • filter – Typ: Byte, Wertebereich: Siehe Konstanten

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:

Für filter:

  • BrickletPTCV2.FILTER_OPTION_50HZ = 0
  • BrickletPTCV2.FILTER_OPTION_60HZ = 1
Function BrickletPTCV2.GetNoiseRejectionFilter() As Byte
Rückgabe:
  • filter – Typ: Byte, Wertebereich: Siehe Konstanten

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

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

Für filter:

  • BrickletPTCV2.FILTER_OPTION_50HZ = 0
  • BrickletPTCV2.FILTER_OPTION_60HZ = 1
Function BrickletPTCV2.GetAPIVersion() As Byte()
Rückgabe:
  • apiVersion – Typ: Byte Array, Länge: 3, Wertebereich: [0 bis 255]

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

  • BrickletPTCV2.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 2
  • BrickletPTCV2.FUNCTION_SET_RESISTANCE_CALLBACK_CONFIGURATION = 6
  • BrickletPTCV2.FUNCTION_SET_NOISE_REJECTION_FILTER = 9
  • BrickletPTCV2.FUNCTION_SET_WIRE_MODE = 12
  • BrickletPTCV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 14
  • BrickletPTCV2.FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 16
  • BrickletPTCV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletPTCV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletPTCV2.FUNCTION_RESET = 243
  • BrickletPTCV2.FUNCTION_WRITE_UID = 248
Sub BrickletPTCV2.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:

  • BrickletPTCV2.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 2
  • BrickletPTCV2.FUNCTION_SET_RESISTANCE_CALLBACK_CONFIGURATION = 6
  • BrickletPTCV2.FUNCTION_SET_NOISE_REJECTION_FILTER = 9
  • BrickletPTCV2.FUNCTION_SET_WIRE_MODE = 12
  • BrickletPTCV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 14
  • BrickletPTCV2.FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 16
  • BrickletPTCV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletPTCV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletPTCV2.FUNCTION_RESET = 243
  • BrickletPTCV2.FUNCTION_WRITE_UID = 248
Sub BrickletPTCV2.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.

Sub BrickletPTCV2.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)
Ausgabeparameter:
  • errorCountAckChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: Long, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

Function BrickletPTCV2.SetBootloaderMode(ByVal mode As Byte) As Byte
Parameter:
  • mode – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: Byte, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

  • BrickletPTCV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletPTCV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletPTCV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletPTCV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletPTCV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BrickletPTCV2.BOOTLOADER_STATUS_OK = 0
  • BrickletPTCV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletPTCV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletPTCV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletPTCV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletPTCV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
Function BrickletPTCV2.GetBootloaderMode() As Byte
Rückgabe:
  • mode – Typ: Byte, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

Für mode:

  • BrickletPTCV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletPTCV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletPTCV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletPTCV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletPTCV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
Sub BrickletPTCV2.SetWriteFirmwarePointer(ByVal pointer As Long)
Parameter:
  • pointer – Typ: Long, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für WriteFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Function BrickletPTCV2.WriteFirmware(ByVal data() As Byte) As Byte
Parameter:
  • data – Typ: Byte Array, Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: Byte, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Sub BrickletPTCV2.SetStatusLEDConfig(ByVal config As Byte)
Parameter:
  • config – Typ: Byte, Wertebereich: Siehe Konstanten

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

  • BrickletPTCV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletPTCV2.STATUS_LED_CONFIG_ON = 1
  • BrickletPTCV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletPTCV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletPTCV2.GetStatusLEDConfig() As Byte
Rückgabe:
  • config – Typ: Byte, Wertebereich: Siehe Konstanten

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

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

Für config:

  • BrickletPTCV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletPTCV2.STATUS_LED_CONFIG_ON = 1
  • BrickletPTCV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletPTCV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletPTCV2.GetChipTemperature() As Short
Rückgabe:
  • temperature – Typ: Short, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

Sub BrickletPTCV2.Reset()

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

Sub BrickletPTCV2.WriteUID(ByVal uid As Long)
Parameter:
  • uid – Typ: Long, Wertebereich: [0 bis 232 - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

Function BrickletPTCV2.ReadUID() As Long
Rückgabe:
  • uid – Typ: Long, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Sub BrickletPTCV2.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
  • hardwareVersion – Typ: Byte Array, Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: Byte Array, Länge: 3, 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 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 BrickletPTCV2.SetTemperatureCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)
Parameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Integer, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

Die Periode ist die Periode mit der der TemperatureCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den TemperatureCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

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

Für option:

  • BrickletPTCV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletPTCV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletPTCV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletPTCV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletPTCV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletPTCV2.GetTemperatureCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)
Ausgabeparameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Integer, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

Gibt die Callback-Konfiguration zurück, wie mittels SetTemperatureCallbackConfiguration() gesetzt.

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

Für option:

  • BrickletPTCV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletPTCV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletPTCV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletPTCV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletPTCV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletPTCV2.SetResistanceCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)
Parameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Integer, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

Die Periode ist die Periode mit der der ResistanceCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den ResistanceCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

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

Für option:

  • BrickletPTCV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletPTCV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletPTCV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletPTCV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletPTCV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletPTCV2.GetResistanceCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)
Ausgabeparameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Integer, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

Gibt die Callback-Konfiguration zurück, wie mittels SetResistanceCallbackConfiguration() gesetzt.

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

Für option:

  • BrickletPTCV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletPTCV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletPTCV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletPTCV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletPTCV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletPTCV2.SetSensorConnectedCallbackConfiguration(ByVal enabled As Boolean)
Parameter:
  • enabled – Typ: 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.

Function BrickletPTCV2.GetSensorConnectedCallbackConfiguration() As Boolean
Rückgabe:
  • enabled – Typ: Boolean

Gibt die Konfiguration zurück, wie von SetSensorConnectedCallbackConfiguration() 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 BrickletPTCV2, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler ptcV2.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 BrickletPTCV2.TemperatureCallback(ByVal sender As BrickletPTCV2, ByVal temperature As Integer)
Callback-Parameter:
  • sender – Typ: BrickletPTCV2
  • temperature – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

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

Der Parameter ist der gleiche wie GetTemperature().

Event BrickletPTCV2.ResistanceCallback(ByVal sender As BrickletPTCV2, ByVal resistance As Integer)
Callback-Parameter:
  • sender – Typ: BrickletPTCV2
  • resistance – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

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

Der Parameter ist der gleiche wie GetResistance().

Event BrickletPTCV2.SensorConnectedCallback(ByVal sender As BrickletPTCV2, ByVal connected As Boolean)
Callback-Parameter:
  • sender – Typ: BrickletPTCV2
  • connected – Typ: Boolean

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

Der Parameter ist der gleiche wie bei IsSensorConnected().

Konstanten

Const BrickletPTCV2.DEVICE_IDENTIFIER

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

Diese Konstante stellt den Anzeigenamen eines PTC Bricklet 2.0 dar.