Software / API Bindings / Visual Basic .NET / API Reference and Examples / Bricklets (Discontinued) / Analog In Bricklet 2.0

Visual Basic .NET - Analog In Bricklet 2.0¶

This is the description of the Visual Basic .NET API bindings for the Analog In Bricklet 2.0. General information and technical specifications for the Analog In Bricklet 2.0 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)

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 Analog In Bricklet 2.0

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim ai As New BrickletAnalogInV2(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 = ai.GetVoltage()
        Console.WriteLine("Voltage: " + (voltage/1000.0).ToString() + " V")

        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 Analog In Bricklet 2.0

    ' Callback subroutine for voltage callback
    Sub VoltageCB(ByVal sender As BrickletAnalogInV2, ByVal voltage As Integer)
        Console.WriteLine("Voltage: " + (voltage/1000.0).ToString() + " V")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim ai As New BrickletAnalogInV2(UID, ipcon) ' Create device object

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

        ' Register voltage callback to subroutine VoltageCB
        AddHandler ai.VoltageCallback, AddressOf VoltageCB

        ' Set period for voltage callback to 1s (1000ms)
        ' Note: The voltage callback is only called every second
        '       if the voltage has changed since the last call!
        ai.SetVoltageCallbackPeriod(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 Analog In Bricklet 2.0

    ' Callback subroutine for voltage reached callback
    Sub VoltageReachedCB(ByVal sender As BrickletAnalogInV2, ByVal voltage As Integer)
        Console.WriteLine("Voltage: " + (voltage/1000.0).ToString() + " V")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim ai As New BrickletAnalogInV2(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)
        ai.SetDebouncePeriod(10000)

        ' Register voltage reached callback to subroutine VoltageReachedCB
        AddHandler ai.VoltageReachedCallback, AddressOf VoltageReachedCB

        ' Configure threshold for voltage "smaller than 5 V"
        ai.SetVoltageCallbackThreshold("<"C, 5*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 BrickletAnalogInV2(ByVal uid As String, ByVal ipcon As IPConnection)¶

Creates an object with the unique device ID uid:

Dim analogInV2 As New BrickletAnalogInV2("YOUR_DEVICE_UID", ipcon)

This object can then be used after the IP Connection is connected.

Function BrickletAnalogInV2.GetVoltage() As Integer¶

Returns:	voltage – Type: Integer, Unit: 1 mV, Range: [0 to 42000]

Returns the measured voltage. The resolution is approximately 10mV.

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

Advanced Functions¶

Function BrickletAnalogInV2.GetAnalogValue() As Integer¶

Returns:	value – Type: Integer, Range: [0 to 2¹² - 1]

Returns the value as read by a 12-bit analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the AnalogValueCallback callback and set the period with SetAnalogValueCallbackPeriod().

Sub BrickletAnalogInV2.SetMovingAverage(ByVal average As Byte)¶

Parameters:	average – Type: Byte, Range: [1 to 50], Default: 50

Sets the length of a moving averaging for the voltage.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

Function BrickletAnalogInV2.GetMovingAverage() As Byte¶

Returns:	average – Type: Byte, Range: [1 to 50], Default: 50

Returns the length of the moving average as set by SetMovingAverage().

Sub BrickletAnalogInV2.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)¶

Output Parameters:

Output Parameters:	uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Char, Range: ["a"C to "h"C, "z"C] hardwareVersion – Type: Byte Array, Length: 3 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] firmwareVersion – Type: Byte Array, Length: 3 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] deviceIdentifier – Type: Integer, Range: [0 to 2¹⁶ - 1]

uid – Type: String, Length: up to 8
connectedUid – Type: String, Length: up to 8
position – Type: Char, Range: ["a"C to "h"C, "z"C]
hardwareVersion – Type: Byte Array, Length: 3

0: major – Type: Byte, Range: [0 to 255]
1: minor – Type: Byte, Range: [0 to 255]
2: revision – Type: Byte, Range: [0 to 255]

firmwareVersion – Type: Byte Array, Length: 3

0: major – Type: Byte, Range: [0 to 255]
1: minor – Type: Byte, Range: [0 to 255]
2: revision – Type: Byte, Range: [0 to 255]

deviceIdentifier – Type: Integer, Range: [0 to 2¹⁶ - 1]

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

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

Callback Configuration Functions¶

Sub BrickletAnalogInV2.SetVoltageCallbackPeriod(ByVal period As Long)¶

Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period 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.

Function BrickletAnalogInV2.GetVoltageCallbackPeriod() As Long¶

Returns:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by SetVoltageCallbackPeriod().

Sub BrickletAnalogInV2.SetAnalogValueCallbackPeriod(ByVal period As Long)¶

Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

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

The AnalogValueCallback callback is only triggered if the analog value has changed since the last triggering.

Function BrickletAnalogInV2.GetAnalogValueCallbackPeriod() As Long¶

Returns:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by SetAnalogValueCallbackPeriod().

Sub BrickletAnalogInV2.SetVoltageCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)¶

Parameters:	option – Type: Char, Range: See constants, Default: "x"C min – Type: Integer, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: Integer, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0

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 following constants are available for this function:

For option:

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

Sub BrickletAnalogInV2.GetVoltageCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)¶

Output Parameters:	option – Type: Char, Range: See constants, Default: "x"C min – Type: Integer, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: Integer, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0

Returns the threshold as set by SetVoltageCallbackThreshold().

The following constants are available for this function:

For option:

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

Sub BrickletAnalogInV2.SetAnalogValueCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)¶

Parameters:	option – Type: Char, Range: See constants, Default: "x"C min – Type: Integer, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: Integer, Range: [0 to 2¹⁶ - 1], Default: 0

Sets the thresholds for the AnalogValueReachedCallback callback.

The following options are possible:

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

The following constants are available for this function:

For option:

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

Sub BrickletAnalogInV2.GetAnalogValueCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)¶

Output Parameters:	option – Type: Char, Range: See constants, Default: "x"C min – Type: Integer, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: Integer, Range: [0 to 2¹⁶ - 1], Default: 0

Returns the threshold as set by SetAnalogValueCallbackThreshold().

The following constants are available for this function:

For option:

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

Sub BrickletAnalogInV2.SetDebouncePeriod(ByVal debounce As Long)¶

Parameters:	debounce – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Sets the period with which the threshold callbacks

VoltageReachedCallback,
AnalogValueReachedCallback

are triggered, if the thresholds

SetVoltageCallbackThreshold(),
SetAnalogValueCallbackThreshold()

keep being reached.

Function BrickletAnalogInV2.GetDebouncePeriod() As Long¶

Returns:	debounce – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

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

AddHandler analogInV2.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 BrickletAnalogInV2.VoltageCallback(ByVal sender As BrickletAnalogInV2, ByVal voltage As Integer)¶

Callback Parameters:	sender – Type: BrickletAnalogInV2 voltage – Type: Integer, Unit: 1 mV, Range: [0 to 42000]

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

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

Event BrickletAnalogInV2.AnalogValueCallback(ByVal sender As BrickletAnalogInV2, ByVal value As Integer)¶

Callback Parameters:	sender – Type: BrickletAnalogInV2 value – Type: Integer, Range: [0 to 2¹² - 1]

This callback is triggered periodically with the period that is set by SetAnalogValueCallbackPeriod(). The parameter is the analog value of the sensor.

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

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

Callback Parameters:	sender – Type: BrickletAnalogInV2 voltage – Type: Integer, Unit: 1 mV, Range: [0 to 42000]

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 BrickletAnalogInV2.AnalogValueReachedCallback(ByVal sender As BrickletAnalogInV2, ByVal value As Integer)¶

Callback Parameters:	sender – Type: BrickletAnalogInV2 value – Type: Integer, Range: [0 to 2¹² - 1]

This callback is triggered when the threshold as set by SetAnalogValueCallbackThreshold() is reached. The parameter is the analog value of the sensor.

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

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

Function BrickletAnalogInV2.GetAPIVersion() As Byte()¶

Output Parameters:	apiVersion – Type: Byte Array, Length: 3 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255]

Returns the version of the API definition 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 BrickletAnalogInV2.GetResponseExpected(ByVal functionId As Byte) As Boolean¶

Parameters:	functionId – Type: Byte, Range: See constants
Returns:	responseExpected – Type: 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

BrickletAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
BrickletAnalogInV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
BrickletAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
BrickletAnalogInV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
BrickletAnalogInV2.FUNCTION_SET_DEBOUNCE_PERIOD = 11
BrickletAnalogInV2.FUNCTION_SET_MOVING_AVERAGE = 13

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

Parameters:	functionId – Type: Byte, Range: See constants responseExpected – Type: 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.

The following constants are available for this function:

For functionId:

BrickletAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
BrickletAnalogInV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
BrickletAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
BrickletAnalogInV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
BrickletAnalogInV2.FUNCTION_SET_DEBOUNCE_PERIOD = 11
BrickletAnalogInV2.FUNCTION_SET_MOVING_AVERAGE = 13

Sub BrickletAnalogInV2.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameters:	responseExpected – Type: Boolean

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

Constants¶

Const BrickletAnalogInV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Analog In Bricklet 2.0.

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 BrickletAnalogInV2.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Analog In Bricklet 2.0.