Dies ist die Beschreibung der Visual Basic .NET API Bindings für das Voltage/Current Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Voltage/Current Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 Voltage/Current Bricklet
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim vc As New BrickletVoltageCurrent(UID, ipcon) ' Create device object
ipcon.Connect(HOST, PORT) ' Connect to brickd
' Don't use device before ipcon is connected
' Get current voltage
Dim voltage As Integer = vc.GetVoltage()
Console.WriteLine("Voltage: " + (voltage/1000.0).ToString() + " V")
' Get current current
Dim current As Integer = vc.GetCurrent()
Console.WriteLine("Current: " + (current/1000.0).ToString() + " A")
Console.WriteLine("Press key to exit")
Console.ReadLine()
ipcon.Disconnect()
End Sub
End Module
|
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 Voltage/Current Bricklet
' Callback subroutine for current callback
Sub CurrentCB(ByVal sender As BrickletVoltageCurrent, ByVal current As Integer)
Console.WriteLine("Current: " + (current/1000.0).ToString() + " A")
End Sub
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim vc As New BrickletVoltageCurrent(UID, ipcon) ' Create device object
ipcon.Connect(HOST, PORT) ' Connect to brickd
' Don't use device before ipcon is connected
' Register current callback to subroutine CurrentCB
AddHandler vc.CurrentCallback, AddressOf CurrentCB
' Set period for current callback to 1s (1000ms)
' Note: The current callback is only called every second
' if the current has changed since the last call!
vc.SetCurrentCallbackPeriod(1000)
Console.WriteLine("Press key to exit")
Console.ReadLine()
ipcon.Disconnect()
End Sub
End Module
|
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 Voltage/Current Bricklet
' Callback subroutine for power reached callback
Sub PowerReachedCB(ByVal sender As BrickletVoltageCurrent, ByVal power As Integer)
Console.WriteLine("Power: " + (power/1000.0).ToString() + " W")
End Sub
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim vc As New BrickletVoltageCurrent(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)
vc.SetDebouncePeriod(10000)
' Register power reached callback to subroutine PowerReachedCB
AddHandler vc.PowerReachedCallback, AddressOf PowerReachedCB
' Configure threshold for power "greater than 10 W"
vc.SetPowerCallbackThreshold(">"C, 10*1000, 0)
Console.WriteLine("Press key to exit")
Console.ReadLine()
ipcon.Disconnect()
End Sub
End Module
|
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.
BrickletVoltageCurrent
(ByVal uid As String, ByVal ipcon As IPConnection)¶Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
Dim voltageCurrent As New BrickletVoltageCurrent("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletVoltageCurrent.
GetCurrent
() As Integer¶Rückgabe: |
|
---|
Gibt die gemessenen Stromstärke zurück.
Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen
den CurrentCallback
Callback zu nutzen und die Periode mit
SetCurrentCallbackPeriod()
vorzugeben.
BrickletVoltageCurrent.
GetVoltage
() As Integer¶Rückgabe: |
|
---|
Gibt die gemessenen Spannung zurück.
Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen
den VoltageCallback
Callback zu nutzen und die Periode mit
SetVoltageCallbackPeriod()
vorzugeben.
BrickletVoltageCurrent.
GetPower
() As Integer¶Rückgabe: |
|
---|
Gibt die gemessenen Leistung zurück.
Wenn die Leistung periodisch abgefragt werden soll, wird empfohlen
den PowerCallback
Callback zu nutzen und die Periode mit
SetPowerCallbackPeriod()
vorzugeben.
BrickletVoltageCurrent.
SetConfiguration
(ByVal averaging As Byte, ByVal voltageConversionTime As Byte, ByVal currentConversionTime As Byte)¶Parameter: |
|
---|
Setzt die Konfiguration des Voltage/Current Bricklet. Es ist möglich die Anzahl für die Durchschnittsbildung, und die Wandlungszeit für Spannung und Stromstärke zu definieren.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für averaging:
Für voltageConversionTime:
Für currentConversionTime:
BrickletVoltageCurrent.
GetConfiguration
(ByRef averaging As Byte, ByRef voltageConversionTime As Byte, ByRef currentConversionTime As Byte)¶Ausgabeparameter: |
|
---|
Gibt die Konfiguration zurück, wie von SetConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für averaging:
Für voltageConversionTime:
Für currentConversionTime:
BrickletVoltageCurrent.
SetCalibration
(ByVal gainMultiplier As Integer, ByVal gainDivisor As Integer)¶Parameter: |
|
---|
Da der Shunt-Widerstand über den die Stromstärke gemessen wird keine perfekte Genauigkeit hat, ist es nötig einen Multiplikator und einen Divisor zu setzen, falls sehr genaue Messwerte nötig sind.
Zum Beispiel: Wenn eine Messung von 1000mA erwartet wird, das Voltage/Current Bricklet aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden.
BrickletVoltageCurrent.
GetCalibration
(ByRef gainMultiplier As Integer, ByRef gainDivisor As Integer)¶Ausgabeparameter: |
|
---|
Gibt die Kalibrierung zurück, wie von SetCalibration()
gesetzt.
BrickletVoltageCurrent.
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: |
|
---|
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.
BrickletVoltageCurrent.
SetCurrentCallbackPeriod
(ByVal period As Long)¶Parameter: |
|
---|
Setzt die Periode mit welcher der CurrentCallback
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der CurrentCallback
Callback wird nur ausgelöst, wenn sich die Stromstärke seit
der letzten Auslösung geändert hat.
BrickletVoltageCurrent.
GetCurrentCallbackPeriod
() As Long¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetCurrentCallbackPeriod()
gesetzt
BrickletVoltageCurrent.
SetVoltageCallbackPeriod
(ByVal period As Long)¶Parameter: |
|
---|
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.
BrickletVoltageCurrent.
GetVoltageCallbackPeriod
() As Long¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetVoltageCallbackPeriod()
gesetzt
BrickletVoltageCurrent.
SetPowerCallbackPeriod
(ByVal period As Long)¶Parameter: |
|
---|
Setzt die Periode mit welcher der PowerCallback
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der PowerCallback
Callback wird nur ausgelöst, wenn sich die Leistung seit der
letzten Auslösung geändert hat.
BrickletVoltageCurrent.
GetPowerCallbackPeriod
() As Long¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von GetPowerCallbackPeriod()
gesetzt
BrickletVoltageCurrent.
SetCurrentCallbackThreshold
(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)¶Parameter: |
|
---|
Setzt den Schwellwert für den CurrentReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Stromstärke außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Stromstärke innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Stromstärke kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Stromstärke größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletVoltageCurrent.
GetCurrentCallbackThreshold
(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)¶Ausgabeparameter: |
|
---|
Gibt den Schwellwert zurück, wie von SetCurrentCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletVoltageCurrent.
SetVoltageCallbackThreshold
(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)¶Parameter: |
|
---|
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:
BrickletVoltageCurrent.
GetVoltageCallbackThreshold
(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)¶Ausgabeparameter: |
|
---|
Gibt den Schwellwert zurück, wie von SetVoltageCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletVoltageCurrent.
SetPowerCallbackThreshold
(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)¶Parameter: |
|
---|
Setzt den Schwellwert für den PowerReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Leistung außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Leistung innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Leistung kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Leistung größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletVoltageCurrent.
GetPowerCallbackThreshold
(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)¶Ausgabeparameter: |
|
---|
Gibt den Schwellwert zurück, wie von SetPowerCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletVoltageCurrent.
SetDebouncePeriod
(ByVal debounce As Long)¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
BrickletVoltageCurrent.
GetDebouncePeriod
() As Long¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod()
gesetzt.
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 BrickletVoltageCurrent, ByVal value As Short) Console.WriteLine("Value: {0}", value) End Sub AddHandler voltageCurrent.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.
BrickletVoltageCurrent.
CurrentCallback
(ByVal sender As BrickletVoltageCurrent, ByVal current As Integer)¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetCurrentCallbackPeriod()
, ausgelöst. Der Parameter ist
die Stromstärke des Sensors.
Der CurrentCallback
Callback wird nur ausgelöst, wenn sich die Stromstärke seit
der letzten Auslösung geändert hat.
BrickletVoltageCurrent.
VoltageCallback
(ByVal sender As BrickletVoltageCurrent, ByVal voltage As Integer)¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetVoltageCallbackPeriod()
, ausgelöst. Der Parameter ist
die Spannung des Sensors.
Der VoltageCallback
Callback wird nur ausgelöst, wenn sich die Spannung seit der
letzten Auslösung geändert hat.
BrickletVoltageCurrent.
PowerCallback
(ByVal sender As BrickletVoltageCurrent, ByVal power As Integer)¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetPowerCallbackPeriod()
, ausgelöst. Der Parameter ist die
Leistung des Sensors.
Der PowerCallback
Callback wird nur ausgelöst, wenn sich die Leistung seit der
letzten Auslösung geändert hat.
BrickletVoltageCurrent.
CurrentReachedCallback
(ByVal sender As BrickletVoltageCurrent, ByVal current As Integer)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetCurrentCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die Stromstärke des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
BrickletVoltageCurrent.
VoltageReachedCallback
(ByVal sender As BrickletVoltageCurrent, ByVal voltage As Integer)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetVoltageCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die Spannung des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
BrickletVoltageCurrent.
PowerReachedCallback
(ByVal sender As BrickletVoltageCurrent, ByVal power As Integer)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetPowerCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die Spannung des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
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.
BrickletVoltageCurrent.
GetAPIVersion
() As Byte()¶Ausgabeparameter: |
|
---|
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.
BrickletVoltageCurrent.
GetResponseExpected
(ByVal functionId As Byte) As Boolean¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
BrickletVoltageCurrent.
SetResponseExpected
(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶Parameter: |
|
---|
Ä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:
BrickletVoltageCurrent.
SetResponseExpectedAll
(ByVal responseExpected As Boolean)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletVoltageCurrent.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Voltage/Current 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.
BrickletVoltageCurrent.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Voltage/Current Bricklet dar.