Visual Basic .NET - Voltage/Current Bricklet 2.0

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

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

 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 Voltage/Current Bricklet 2.0

    ' Callback subroutine for current callback
    Sub CurrentCB(ByVal sender As BrickletVoltageCurrentV2, 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 BrickletVoltageCurrentV2(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) without a threshold
        vc.SetCurrentCallbackConfiguration(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 Voltage/Current Bricklet 2.0

    ' Callback subroutine for power callback
    Sub PowerCB(ByVal sender As BrickletVoltageCurrentV2, 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 BrickletVoltageCurrentV2(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Register power callback to subroutine PowerCB
        AddHandler vc.PowerCallback, AddressOf PowerCB

        ' Configure threshold for power "greater than 10 W"
        ' with a debounce period of 1s (1000ms)
        vc.SetPowerCallbackConfiguration(1000, False, ">"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 BrickletVoltageCurrentV2(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim voltageCurrentV2 As New BrickletVoltageCurrentV2("YOUR_DEVICE_UID", ipcon)

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

Function BrickletVoltageCurrentV2.GetCurrent() As Integer

Gibt die gemessenen Stromstärke zurück. Der Wert ist in mA und im Bereich von -20000mA bis 20000mA.

Wenn der Wert periodisch benötigt wird, kann auch der CurrentCallback Callback verwendet werden. Der Callback wird mit der Funktion SetCurrentCallbackConfiguration() konfiguriert.

Function BrickletVoltageCurrentV2.GetVoltage() As Integer

Gibt die gemessenen Spannung zurück. Der Wert ist in mV und im Bereich von 0mV bis 36000mV.

Wenn der Wert periodisch benötigt wird, kann auch der VoltageCallback Callback verwendet werden. Der Callback wird mit der Funktion SetVoltageCallbackConfiguration() konfiguriert.

Function BrickletVoltageCurrentV2.GetPower() As Integer

Gibt die gemessenen Leistung zurück. Der Wert ist in mW und im Bereich von 0mW bis 720000mW.

Wenn der Wert periodisch benötigt wird, kann auch der PowerCallback Callback verwendet werden. Der Callback wird mit der Funktion SetPowerCallbackConfiguration() konfiguriert.

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

Setzt die Konfiguration des Voltage/Current Bricklet 2.0. Es ist möglich die Anzahl für die Durchschnittsbildung, und die Wandlungszeit für Spannung und Stromstärke zu definieren.

Durchschnittsbildung:

Wert Anzahl
0 1
1 4
2 16
3 64
4 128
5 256
6 512
>=7 1024

Wandlungszeit für Spannung/Stromstärke:

Wert Wandlungszeit
0 140µs
1 204µs
2 332µs
3 588µs
4 1.1ms
5 2.116ms
6 4.156ms
>=7 8.244ms

Die Standardwerte sind 3, 4 und 4 (64, 1.1ms, 1.1ms) für die Durchschnittsbildung und die Spannungs/Stromstärkenwandlungszeit.

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

  • BrickletVoltageCurrentV2.AVERAGING_1 = 0
  • BrickletVoltageCurrentV2.AVERAGING_4 = 1
  • BrickletVoltageCurrentV2.AVERAGING_16 = 2
  • BrickletVoltageCurrentV2.AVERAGING_64 = 3
  • BrickletVoltageCurrentV2.AVERAGING_128 = 4
  • BrickletVoltageCurrentV2.AVERAGING_256 = 5
  • BrickletVoltageCurrentV2.AVERAGING_512 = 6
  • BrickletVoltageCurrentV2.AVERAGING_1024 = 7
Sub BrickletVoltageCurrentV2.GetConfiguration(ByRef averaging As Byte, ByRef voltageConversionTime As Byte, ByRef currentConversionTime As Byte)

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

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

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

Fortgeschrittene Funktionen

Sub BrickletVoltageCurrentV2.SetCalibration(ByVal voltageMultiplier As Integer, ByVal voltageDivisor As Integer, ByVal currentMultiplier As Integer, ByVal currentDivisor As Integer)

Da der ADC und der Shunt-Widerstand für die Messungen verwendet werden nicht perfekt sind, 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 2.0 aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden. Das gleiches gilt für die Spannung.

Sub BrickletVoltageCurrentV2.GetCalibration(ByRef voltageMultiplier As Integer, ByRef voltageDivisor As Integer, ByRef currentMultiplier As Integer, ByRef currentDivisor As Integer)

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

Function BrickletVoltageCurrentV2.GetAPIVersion() As Byte()

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

Function BrickletVoltageCurrentV2.GetResponseExpected(ByVal functionId As Byte) As Boolean

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

Sub BrickletVoltageCurrentV2.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

  • BrickletVoltageCurrentV2.FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
  • BrickletVoltageCurrentV2.FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 6
  • BrickletVoltageCurrentV2.FUNCTION_SET_POWER_CALLBACK_CONFIGURATION = 10
  • BrickletVoltageCurrentV2.FUNCTION_SET_CONFIGURATION = 13
  • BrickletVoltageCurrentV2.FUNCTION_SET_CALIBRATION = 15
  • BrickletVoltageCurrentV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletVoltageCurrentV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletVoltageCurrentV2.FUNCTION_RESET = 243
  • BrickletVoltageCurrentV2.FUNCTION_WRITE_UID = 248
Sub BrickletVoltageCurrentV2.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletVoltageCurrentV2.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)

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 BrickletVoltageCurrentV2.SetBootloaderMode(ByVal mode As Byte) As Byte

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:

  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletVoltageCurrentV2.BOOTLOADER_STATUS_OK = 0
  • BrickletVoltageCurrentV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletVoltageCurrentV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletVoltageCurrentV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletVoltageCurrentV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletVoltageCurrentV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
Function BrickletVoltageCurrentV2.GetBootloaderMode() As Byte

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

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

  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
Sub BrickletVoltageCurrentV2.SetWriteFirmwarePointer(ByVal pointer As Long)

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 BrickletVoltageCurrentV2.WriteFirmware(ByVal data() As Byte) As Byte

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 BrickletVoltageCurrentV2.SetStatusLEDConfig(ByVal config As Byte)

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:

  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_ON = 1
  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletVoltageCurrentV2.GetStatusLEDConfig() As Byte

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

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

  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_ON = 1
  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletVoltageCurrentV2.GetChipTemperature() As Short

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 BrickletVoltageCurrentV2.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 bestehende führt zu undefiniertem Verhalten.

Sub BrickletVoltageCurrentV2.WriteUID(ByVal uid As Long)

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 BrickletVoltageCurrentV2.ReadUID() As Long

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

Sub BrickletVoltageCurrentV2.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklet.

Konfigurationsfunktionen für Callbacks

Sub BrickletVoltageCurrentV2.SetCurrentCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

Die Periode in ms ist die Periode mit der der CurrentCallback 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 CurrentCallback 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:

  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletVoltageCurrentV2.GetCurrentCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

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

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

  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletVoltageCurrentV2.SetVoltageCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

Die Periode in ms ist die Periode mit der der VoltageCallback 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 VoltageCallback 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:

  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletVoltageCurrentV2.GetVoltageCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

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

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

  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletVoltageCurrentV2.SetPowerCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

Die Periode in ms ist die Periode mit der der PowerCallback 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 PowerCallback 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:

  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletVoltageCurrentV2.GetPowerCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

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

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

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

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

AddHandler voltageCurrentV2.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 BrickletVoltageCurrentV2.CurrentCallback(ByVal sender As BrickletVoltageCurrentV2, ByVal current As Integer)

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

Der Parameter ist der gleiche wie GetCurrent().

Event BrickletVoltageCurrentV2.VoltageCallback(ByVal sender As BrickletVoltageCurrentV2, ByVal voltage As Integer)

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

Der Parameter ist der gleiche wie GetVoltage().

Event BrickletVoltageCurrentV2.PowerCallback(ByVal sender As BrickletVoltageCurrentV2, ByVal power As Integer)

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

Der Parameter ist der gleiche wie GetPower().

Konstanten

Const BrickletVoltageCurrentV2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Voltage/Current Bricklet 2.0 zu identifizieren.

Die GetIdentity() Funktion und der EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

Const BrickletVoltageCurrentV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Voltage/Current Bricklet 2.0 dar.