Visual Basic .NET - Voltage/Current Bricklet

This is the description of the Visual Basic .NET API bindings for the Voltage/Current Bricklet. General information and technical specifications for the Voltage/Current Bricklet are summarized in its hardware description.

An installation guide for the Visual Basic .NET API bindings is part of their general description.

Examples

The example code below is 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

    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)

 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

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

API

Since Visual Basic .NET does not support multiple return values directly, we use the ByRef keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

Basic Functions

Class BrickletVoltageCurrent(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim voltageCurrent As New BrickletVoltageCurrent("YOUR_DEVICE_UID", ipcon)

This object can then be used after the IP Connection is connected (see examples above).

Function BrickletVoltageCurrent.GetCurrent() As Integer

Returns the current. The value is in mA and between -20000mA and 20000mA.

If you want to get the current periodically, it is recommended to use the CurrentCallback callback and set the period with SetCurrentCallbackPeriod().

Function BrickletVoltageCurrent.GetVoltage() As Integer

Returns the voltage. The value is in mV and between 0mV and 36000mV.

If you want to get the voltage periodically, it is recommended to use the VoltageCallback callback and set the period with SetVoltageCallbackPeriod().

Function BrickletVoltageCurrent.GetPower() As Integer

Returns the power. The value is in mW and between 0mV and 720000mW.

If you want to get the power periodically, it is recommended to use the PowerCallback callback and set the period with SetPowerCallbackPeriod().

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

Sets the configuration of the Voltage/Current Bricklet. It is possible to configure number of averages as well as voltage and current conversion time.

Averaging:

Value Number of Averages
0 1
1 4
2 16
3 64
4 128
5 256
6 512
>=7 1024

Voltage/Current conversion:

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

The default values are 3, 4 and 4 (64, 1.1ms, 1.1ms) for averaging, voltage conversion and current conversion.

The following constants are available for this function:

  • 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
Sub BrickletVoltageCurrent.GetConfiguration(ByRef averaging As Byte, ByRef voltageConversionTime As Byte, ByRef currentConversionTime As Byte)

Returns the configuration as set by SetConfiguration().

The following constants are available for this function:

  • 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

Advanced Functions

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

Since the shunt resistor that is used to measure the current is not perfectly precise, it needs to be calibrated by a multiplier and divisor if a very precise reading is needed.

For example, if you are expecting a measurement of 1000mA and you are measuring 1023mA, you can calibrate the Voltage/Current Bricklet by setting the multiplier to 1000 and the divisor to 1023.

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

Returns the calibration as set by SetCalibration().

Function BrickletVoltageCurrent.GetAPIVersion() As Byte()

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

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

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

  • 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)

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

  • 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)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

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)

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

Sub BrickletVoltageCurrent.SetCurrentCallbackPeriod(ByVal period As Long)

Sets the period in ms with which the CurrentCallback callback is triggered periodically. A value of 0 turns the callback off.

The CurrentCallback callback is only triggered if the current has changed since the last triggering.

The default value is 0.

Function BrickletVoltageCurrent.GetCurrentCallbackPeriod() As Long

Returns the period as set by SetCurrentCallbackPeriod().

Sub BrickletVoltageCurrent.SetVoltageCallbackPeriod(ByVal period As Long)

Sets the period in ms with which the VoltageCallback callback is triggered periodically. A value of 0 turns the callback off.

The VoltageCallback callback is only triggered if the voltage has changed since the last triggering.

The default value is 0.

Function BrickletVoltageCurrent.GetVoltageCallbackPeriod() As Long

Returns the period as set by SetVoltageCallbackPeriod().

Sub BrickletVoltageCurrent.SetPowerCallbackPeriod(ByVal period As Long)

Sets the period in ms with which the PowerCallback callback is triggered periodically. A value of 0 turns the callback off.

The PowerCallback callback is only triggered if the power has changed since the last triggering.

The default value is 0.

Function BrickletVoltageCurrent.GetPowerCallbackPeriod() As Long

Returns the period as set by GetPowerCallbackPeriod().

Sub BrickletVoltageCurrent.SetCurrentCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

Sets the thresholds for the CurrentReachedCallback callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the current is outside the min and max values
'i' Callback is triggered when the current is inside the min and max values
'<' Callback is triggered when the current is smaller than the min value (max is ignored)
'>' Callback is triggered when the current is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following constants are available for this function:

  • 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)

Returns the threshold as set by SetCurrentCallbackThreshold().

The following constants are available for this function:

  • 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)

Sets the thresholds for the VoltageReachedCallback callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the voltage is outside the min and max values
'i' Callback is triggered when the voltage is inside the min and max values
'<' Callback is triggered when the voltage is smaller than the min value (max is ignored)
'>' Callback is triggered when the voltage is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following constants are available for this function:

  • 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)

Returns the threshold as set by SetVoltageCallbackThreshold().

The following constants are available for this function:

  • 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)

Sets the thresholds for the PowerReachedCallback callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the power is outside the min and max values
'i' Callback is triggered when the power is inside the min and max values
'<' Callback is triggered when the power is smaller than the min value (max is ignored)
'>' Callback is triggered when the power is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following constants are available for this function:

  • 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)

Returns the threshold as set by SetPowerCallbackThreshold().

The following constants are available for this function:

  • 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)

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

Function BrickletVoltageCurrent.GetDebouncePeriod() As Long

Returns the debounce period as set by SetDebouncePeriod().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a procedure to an callback property of the device object:

Sub MyCallback(ByVal sender As BrickletVoltageCurrent, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler voltageCurrent.ExampleCallback, AddressOf MyCallback

The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

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

This callback is triggered periodically with the period that is set by SetCurrentCallbackPeriod(). The parameter is the current of the sensor.

The CurrentCallback callback is only triggered if the current has changed since the last triggering.

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

This callback is triggered periodically with the period that is set by SetVoltageCallbackPeriod(). The parameter is the voltage of the sensor.

The VoltageCallback callback is only triggered if the voltage has changed since the last triggering.

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

This callback is triggered periodically with the period that is set by SetPowerCallbackPeriod(). The parameter is the power of the sensor.

The PowerCallback callback is only triggered if the power has changed since the last triggering.

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

This callback is triggered when the threshold as set by SetCurrentCallbackThreshold() is reached. The parameter is the current of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().

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

This callback is triggered when the threshold as set by SetVoltageCallbackThreshold() is reached. The parameter is the voltage of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().

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

This callback is triggered when the threshold as set by SetPowerCallbackThreshold() is reached. The parameter is the power of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().

Constants

Const BrickletVoltageCurrent.DEVICE_IDENTIFIER

This constant is used to identify a Voltage/Current Bricklet.

The GetIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

Const BrickletVoltageCurrent.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Voltage/Current Bricklet.