Deutsch
English
Menu

Visual Basic .NET - Voltage Bricklet

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

 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 Voltage Bricklet
 8
 9    Sub Main()
10        Dim ipcon As New IPConnection() ' Create IP connection
11        Dim v As New BrickletVoltage(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 voltage
17        Dim voltage As Integer = v.GetVoltage()
18        Console.WriteLine("Voltage: " + (voltage/1000.0).ToString() + " V")
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 Voltage Bricklet
 8
 9    ' Callback subroutine for voltage callback
10    Sub VoltageCB(ByVal sender As BrickletVoltage, ByVal voltage As Integer)
11        Console.WriteLine("Voltage: " + (voltage/1000.0).ToString() + " V")
12    End Sub
13
14    Sub Main()
15        Dim ipcon As New IPConnection() ' Create IP connection
16        Dim v As New BrickletVoltage(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 voltage callback to subroutine VoltageCB
22        AddHandler v.VoltageCallback, AddressOf VoltageCB
23
24        ' Set period for voltage callback to 1s (1000ms)
25        ' Note: The voltage callback is only called every second
26        '       if the voltage has changed since the last call!
27        v.SetVoltageCallbackPeriod(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 Voltage Bricklet
 8
 9    ' Callback subroutine for voltage reached callback
10    Sub VoltageReachedCB(ByVal sender As BrickletVoltage, ByVal voltage As Integer)
11        Console.WriteLine("Voltage: " + (voltage/1000.0).ToString() + " V")
12    End Sub
13
14    Sub Main()
15        Dim ipcon As New IPConnection() ' Create IP connection
16        Dim v As New BrickletVoltage(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        ' Get threshold callbacks with a debounce time of 10 seconds (10000ms)
22        v.SetDebouncePeriod(10000)
23
24        ' Register voltage reached callback to subroutine VoltageReachedCB
25        AddHandler v.VoltageReachedCallback, AddressOf VoltageReachedCB
26
27        ' Configure threshold for voltage "greater than 5 V"
28        v.SetVoltageCallbackThreshold(">"C, 5*1000, 0)
29
30        Console.WriteLine("Press key to exit")
31        Console.ReadLine()
32        ipcon.Disconnect()
33    End Sub
34End 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 BrickletVoltage(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim voltage As New BrickletVoltage("YOUR_DEVICE_UID", ipcon)

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

Function BrickletVoltage.GetVoltage() As Integer
Rückgabe:
  • voltage – Typ: Integer, Einheit: 1 mV, Wertebereich: [0 bis 50000]

Gibt die gemessene Spannung des Sensors zurück.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den VoltageCallback Callback zu nutzen und die Periode mit SetVoltageCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

Function BrickletVoltage.GetAnalogValue() As Integer
Rückgabe:
  • value – Typ: Integer, Wertebereich: [0 bis 212 - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von GetVoltage() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während GetAnalogValue() unverarbeitete Analogwerte zurück gibt. Der einzige Grund GetAnalogValue() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den AnalogValueCallback Callback zu nutzen und die Periode mit SetAnalogValueCallbackPeriod() vorzugeben.

Sub BrickletVoltage.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 BrickletVoltage.SetVoltageCallbackPeriod(ByVal period As Long)
Parameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

Function BrickletVoltage.GetVoltageCallbackPeriod() As Long
Rückgabe:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Sub BrickletVoltage.SetAnalogValueCallbackPeriod(ByVal period As Long)
Parameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

Function BrickletVoltage.GetAnalogValueCallbackPeriod() As Long
Rückgabe:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Sub BrickletVoltage.SetVoltageCallbackThreshold(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 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: Integer, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den VoltageReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option

Beschreibung

‚x‘

Callback ist inaktiv

‚o‘

Callback wird ausgelöst, wenn die Spannung außerhalb des min und max Wertes ist

‚i‘

Callback wird ausgelöst, wenn die Spannung innerhalb des min und max Wertes ist

‚<‘

Callback wird ausgelöst, wenn die Spannung kleiner als der min Wert ist (max wird ignoriert)

‚>‘

Callback wird ausgelöst, wenn die Spannung größer als der min Wert ist (max wird ignoriert)

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

Für option:

  • BrickletVoltage.THRESHOLD_OPTION_OFF = „x“C

  • BrickletVoltage.THRESHOLD_OPTION_OUTSIDE = „o“C

  • BrickletVoltage.THRESHOLD_OPTION_INSIDE = „i“C

  • BrickletVoltage.THRESHOLD_OPTION_SMALLER = „<“C

  • BrickletVoltage.THRESHOLD_OPTION_GREATER = „>“C

Sub BrickletVoltage.GetVoltageCallbackThreshold(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 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: Integer, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

  • BrickletVoltage.THRESHOLD_OPTION_OFF = „x“C

  • BrickletVoltage.THRESHOLD_OPTION_OUTSIDE = „o“C

  • BrickletVoltage.THRESHOLD_OPTION_INSIDE = „i“C

  • BrickletVoltage.THRESHOLD_OPTION_SMALLER = „<“C

  • BrickletVoltage.THRESHOLD_OPTION_GREATER = „>“C

Sub BrickletVoltage.SetAnalogValueCallbackThreshold(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, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den AnalogValueReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option

Beschreibung

‚x‘

Callback ist inaktiv

‚o‘

Callback wird ausgelöst, wenn der Analogwert außerhalb des min und max Wertes ist

‚i‘

Callback wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes ist

‚<‘

Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert)

‚>‘

Callback wird ausgelöst, wenn der Analogwert größer als der min Wert ist (max wird ignoriert)

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

Für option:

  • BrickletVoltage.THRESHOLD_OPTION_OFF = „x“C

  • BrickletVoltage.THRESHOLD_OPTION_OUTSIDE = „o“C

  • BrickletVoltage.THRESHOLD_OPTION_INSIDE = „i“C

  • BrickletVoltage.THRESHOLD_OPTION_SMALLER = „<“C

  • BrickletVoltage.THRESHOLD_OPTION_GREATER = „>“C

Sub BrickletVoltage.GetAnalogValueCallbackThreshold(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, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

  • BrickletVoltage.THRESHOLD_OPTION_OFF = „x“C

  • BrickletVoltage.THRESHOLD_OPTION_OUTSIDE = „o“C

  • BrickletVoltage.THRESHOLD_OPTION_INSIDE = „i“C

  • BrickletVoltage.THRESHOLD_OPTION_SMALLER = „<“C

  • BrickletVoltage.THRESHOLD_OPTION_GREATER = „>“C

Sub BrickletVoltage.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 Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

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

AddHandler voltage.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 BrickletVoltage.VoltageCallback(ByVal sender As BrickletVoltage, ByVal voltage As Integer)
Callback-Parameter:
  • sender – Typ: BrickletVoltage
  • voltage – Typ: Integer, Einheit: 1 mV, Wertebereich: [0 bis 50000]

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

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

Event BrickletVoltage.AnalogValueCallback(ByVal sender As BrickletVoltage, ByVal value As Integer)
Callback-Parameter:
  • sender – Typ: BrickletVoltage
  • value – Typ: Integer, Wertebereich: [0 bis 212 - 1]

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

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

Event BrickletVoltage.VoltageReachedCallback(ByVal sender As BrickletVoltage, ByVal voltage As Integer)
Callback-Parameter:
  • sender – Typ: BrickletVoltage
  • voltage – Typ: Integer, Einheit: 1 mV, Wertebereich: [0 bis 50000]

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

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

Event BrickletVoltage.AnalogValueReachedCallback(ByVal sender As BrickletVoltage, ByVal value As Integer)
Callback-Parameter:
  • sender – Typ: BrickletVoltage
  • value – Typ: Integer, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Analogwert 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 BrickletVoltage.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 BrickletVoltage.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:

  • BrickletVoltage.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3

  • BrickletVoltage.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5

  • BrickletVoltage.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7

  • BrickletVoltage.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9

  • BrickletVoltage.FUNCTION_SET_DEBOUNCE_PERIOD = 11

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

  • BrickletVoltage.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3

  • BrickletVoltage.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5

  • BrickletVoltage.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7

  • BrickletVoltage.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9

  • BrickletVoltage.FUNCTION_SET_DEBOUNCE_PERIOD = 11

Sub BrickletVoltage.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 BrickletVoltage.DEVICE_IDENTIFIER

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

Diese Konstante stellt den Anzeigenamen eines Voltage Bricklet dar.