Visual Basic .NET - Voltage/Current Bricklet¶

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.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (ExampleSimple.vb)

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

Callback¶

Download (ExampleCallback.vb)

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

Threshold¶

Download (ExampleThreshold.vb)

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

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

Function BrickletVoltageCurrent.GetCurrent() As Integer¶

Rückgabe:	current – Typ: Integer, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

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.

Function BrickletVoltageCurrent.GetVoltage() As Integer¶

Rückgabe:	voltage – Typ: Integer, Einheit: 1 mV, Wertebereich: [0 bis 36000]

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.

Function BrickletVoltageCurrent.GetPower() As Integer¶

Rückgabe:	power – Typ: Integer, Einheit: 1 mW, Wertebereich: [0 bis 720000]

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.

Sub BrickletVoltageCurrent.SetConfiguration(ByVal averaging As Byte, ByVal voltageConversionTime As Byte, ByVal currentConversionTime As Byte)¶

Parameter:	averaging – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3 voltageConversionTime – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 4 currentConversionTime – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 4

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:

BrickletVoltageCurrent.AVERAGING_1 = 0
BrickletVoltageCurrent.AVERAGING_4 = 1
BrickletVoltageCurrent.AVERAGING_16 = 2
BrickletVoltageCurrent.AVERAGING_64 = 3
BrickletVoltageCurrent.AVERAGING_128 = 4
BrickletVoltageCurrent.AVERAGING_256 = 5
BrickletVoltageCurrent.AVERAGING_512 = 6
BrickletVoltageCurrent.AVERAGING_1024 = 7

Für voltageConversionTime:

BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7

Für currentConversionTime:

BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7

Sub BrickletVoltageCurrent.GetConfiguration(ByRef averaging As Byte, ByRef voltageConversionTime As Byte, ByRef currentConversionTime As Byte)¶

Ausgabeparameter:	averaging – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3 voltageConversionTime – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 4 currentConversionTime – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 4

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

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

Für averaging:

BrickletVoltageCurrent.AVERAGING_1 = 0
BrickletVoltageCurrent.AVERAGING_4 = 1
BrickletVoltageCurrent.AVERAGING_16 = 2
BrickletVoltageCurrent.AVERAGING_64 = 3
BrickletVoltageCurrent.AVERAGING_128 = 4
BrickletVoltageCurrent.AVERAGING_256 = 5
BrickletVoltageCurrent.AVERAGING_512 = 6
BrickletVoltageCurrent.AVERAGING_1024 = 7

Für voltageConversionTime:

BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7

Für currentConversionTime:

BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7

Fortgeschrittene Funktionen¶

Sub BrickletVoltageCurrent.SetCalibration(ByVal gainMultiplier As Integer, ByVal gainDivisor As Integer)¶

Parameter:	gainMultiplier – Typ: Integer, Wertebereich: [0 bis 2¹⁶ - 1] gainDivisor – Typ: Integer, Wertebereich: [0 bis 2¹⁶ - 1]

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.

Sub BrickletVoltageCurrent.GetCalibration(ByRef gainMultiplier As Integer, ByRef gainDivisor As Integer)¶

Ausgabeparameter:	gainMultiplier – Typ: Integer, Wertebereich: [0 bis 2¹⁶ - 1] gainDivisor – Typ: Integer, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die Kalibrierung zurück, wie von SetCalibration() gesetzt.

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

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 2¹⁶ - 1]

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 2¹⁶ - 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 BrickletVoltageCurrent.SetCurrentCallbackPeriod(ByVal period As Long)¶

Parameter:	period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

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.

Function BrickletVoltageCurrent.GetCurrentCallbackPeriod() As Long¶

Rückgabe:	period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

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

Sub BrickletVoltageCurrent.SetVoltageCallbackPeriod(ByVal period As Long)¶

Parameter:	period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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 BrickletVoltageCurrent.GetVoltageCallbackPeriod() As Long¶

Rückgabe:	period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

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

Sub BrickletVoltageCurrent.SetPowerCallbackPeriod(ByVal period As Long)¶

Parameter:	period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

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.

Function BrickletVoltageCurrent.GetPowerCallbackPeriod() As Long¶

Rückgabe:	period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

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

Sub BrickletVoltageCurrent.SetCurrentCallbackThreshold(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 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

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.THRESHOLD_OPTION_OFF = "x"C
BrickletVoltageCurrent.THRESHOLD_OPTION_OUTSIDE = "o"C
BrickletVoltageCurrent.THRESHOLD_OPTION_INSIDE = "i"C
BrickletVoltageCurrent.THRESHOLD_OPTION_SMALLER = "<"C
BrickletVoltageCurrent.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletVoltageCurrent.GetCurrentCallbackThreshold(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 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

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

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

Für option:

BrickletVoltageCurrent.THRESHOLD_OPTION_OFF = "x"C
BrickletVoltageCurrent.THRESHOLD_OPTION_OUTSIDE = "o"C
BrickletVoltageCurrent.THRESHOLD_OPTION_INSIDE = "i"C
BrickletVoltageCurrent.THRESHOLD_OPTION_SMALLER = "<"C
BrickletVoltageCurrent.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletVoltageCurrent.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: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 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:

BrickletVoltageCurrent.THRESHOLD_OPTION_OFF = "x"C
BrickletVoltageCurrent.THRESHOLD_OPTION_OUTSIDE = "o"C
BrickletVoltageCurrent.THRESHOLD_OPTION_INSIDE = "i"C
BrickletVoltageCurrent.THRESHOLD_OPTION_SMALLER = "<"C
BrickletVoltageCurrent.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletVoltageCurrent.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: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 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:

BrickletVoltageCurrent.THRESHOLD_OPTION_OFF = "x"C
BrickletVoltageCurrent.THRESHOLD_OPTION_OUTSIDE = "o"C
BrickletVoltageCurrent.THRESHOLD_OPTION_INSIDE = "i"C
BrickletVoltageCurrent.THRESHOLD_OPTION_SMALLER = "<"C
BrickletVoltageCurrent.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletVoltageCurrent.SetPowerCallbackThreshold(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 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

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.THRESHOLD_OPTION_OFF = "x"C
BrickletVoltageCurrent.THRESHOLD_OPTION_OUTSIDE = "o"C
BrickletVoltageCurrent.THRESHOLD_OPTION_INSIDE = "i"C
BrickletVoltageCurrent.THRESHOLD_OPTION_SMALLER = "<"C
BrickletVoltageCurrent.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletVoltageCurrent.GetPowerCallbackThreshold(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 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

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

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

Für option:

BrickletVoltageCurrent.THRESHOLD_OPTION_OFF = "x"C
BrickletVoltageCurrent.THRESHOLD_OPTION_OUTSIDE = "o"C
BrickletVoltageCurrent.THRESHOLD_OPTION_INSIDE = "i"C
BrickletVoltageCurrent.THRESHOLD_OPTION_SMALLER = "<"C
BrickletVoltageCurrent.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletVoltageCurrent.SetDebouncePeriod(ByVal debounce As Long)¶

Parameter:	debounce – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

CurrentReachedCallback,
VoltageReachedCallback,
PowerReachedCallback

ausgelöst werden, wenn die Schwellwerte

SetCurrentCallbackThreshold(),
SetVoltageCallbackThreshold(),
SetPowerCallbackThreshold()

weiterhin erreicht bleiben.

Function BrickletVoltageCurrent.GetDebouncePeriod() As Long¶

Rückgabe:	debounce – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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 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.

Event BrickletVoltageCurrent.CurrentCallback(ByVal sender As BrickletVoltageCurrent, ByVal current As Integer)¶

Callback-Parameter:	sender – Typ: BrickletVoltageCurrent current – Typ: Integer, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

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.

Event BrickletVoltageCurrent.VoltageCallback(ByVal sender As BrickletVoltageCurrent, ByVal voltage As Integer)¶

Callback-Parameter:	sender – Typ: BrickletVoltageCurrent voltage – Typ: Integer, Einheit: 1 mV, Wertebereich: [0 bis 36000]

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.

Event BrickletVoltageCurrent.PowerCallback(ByVal sender As BrickletVoltageCurrent, ByVal power As Integer)¶

Callback-Parameter:	sender – Typ: BrickletVoltageCurrent power – Typ: Integer, Einheit: 1 mW, Wertebereich: [0 bis 720000]

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.

Event BrickletVoltageCurrent.CurrentReachedCallback(ByVal sender As BrickletVoltageCurrent, ByVal current As Integer)¶

Callback-Parameter:	sender – Typ: BrickletVoltageCurrent current – Typ: Integer, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

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.

Event BrickletVoltageCurrent.VoltageReachedCallback(ByVal sender As BrickletVoltageCurrent, ByVal voltage As Integer)¶

Callback-Parameter:	sender – Typ: BrickletVoltageCurrent voltage – Typ: Integer, Einheit: 1 mV, Wertebereich: [0 bis 36000]

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.

Event BrickletVoltageCurrent.PowerReachedCallback(ByVal sender As BrickletVoltageCurrent, ByVal power As Integer)¶

Callback-Parameter:	sender – Typ: BrickletVoltageCurrent power – Typ: Integer, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

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¶

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

BrickletVoltageCurrent.FUNCTION_SET_CONFIGURATION = 4
BrickletVoltageCurrent.FUNCTION_SET_CALIBRATION = 6
BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
BrickletVoltageCurrent.FUNCTION_SET_DEBOUNCE_PERIOD = 20

Sub BrickletVoltageCurrent.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.

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

Für functionId:

BrickletVoltageCurrent.FUNCTION_SET_CONFIGURATION = 4
BrickletVoltageCurrent.FUNCTION_SET_CALIBRATION = 6
BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
BrickletVoltageCurrent.FUNCTION_SET_DEBOUNCE_PERIOD = 20

Sub BrickletVoltageCurrent.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 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.

Const BrickletVoltageCurrent.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Voltage/Current Bricklet dar.