This is the description of the Visual Basic .NET API bindings for the Analog In Bricklet 3.0. General information and technical specifications for the Analog In Bricklet 3.0 are summarized in its hardware description.
An installation guide for the Visual Basic .NET API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | 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 3.0
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim ai As New BrickletAnalogInV3(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
|
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 Analog In Bricklet 3.0
' Callback subroutine for voltage callback
Sub VoltageCB(ByVal sender As BrickletAnalogInV3, 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 BrickletAnalogInV3(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) without a threshold
ai.SetVoltageCallbackConfiguration(1000, False, "x"C, 0, 0)
Console.WriteLine("Press key to exit")
Console.ReadLine()
ipcon.Disconnect()
End Sub
End Module
|
Download (ExampleThreshold.vb)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | 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 3.0
' Callback subroutine for voltage callback
Sub VoltageCB(ByVal sender As BrickletAnalogInV3, 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 BrickletAnalogInV3(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
' Configure threshold for voltage "smaller than 5 V"
' with a debounce period of 1s (1000ms)
ai.SetVoltageCallbackConfiguration(1000, False, "<"C, 5*1000, 0)
Console.WriteLine("Press key to exit")
Console.ReadLine()
ipcon.Disconnect()
End Sub
End Module
|
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.
BrickletAnalogInV3
(ByVal uid As String, ByVal ipcon As IPConnection)¶Creates an object with the unique device ID uid
:
Dim analogInV3 As New BrickletAnalogInV3("YOUR_DEVICE_UID", ipcon)
This object can then be used after the IP Connection is connected.
BrickletAnalogInV3.
GetVoltage
() As Integer¶Returns: |
|
---|
Returns the measured voltage. The resolution is approximately 10mV to 1mV
depending on the oversampling configuration (SetOversampling()
).
If you want to get the value periodically, it is recommended to use the
VoltageCallback
callback. You can set the callback configuration
with SetVoltageCallbackConfiguration()
.
BrickletAnalogInV3.
SetOversampling
(ByVal oversampling As Byte)¶Parameters: |
|
---|
Sets the oversampling between 32x and 16384x. The Bricklet takes one 12bit sample every 17.5µs. Thus an oversampling of 32x is equivalent to an integration time of 0.56ms and a oversampling of 16384x is equivalent to an integration time of 286ms.
The oversampling uses the moving average principle. A new value is always calculated once per millisecond.
With increased oversampling the noise decreases. With decreased oversampling the reaction time increases (changes in voltage will be measured faster).
The following constants are available for this function:
For oversampling:
BrickletAnalogInV3.
GetOversampling
() As Byte¶Returns: |
|
---|
Returns the oversampling value as set by SetOversampling()
.
The following constants are available for this function:
For oversampling:
BrickletAnalogInV3.
SetCalibration
(ByVal offset As Short, ByVal multiplier As Integer, ByVal divisor As Integer)¶Parameters: |
|
---|
Sets a calibration for the measured voltage value. The formula for the calibration is as follows:
Calibrated Value = (Value + Offset) * Multiplier / Divisor
We recommend that you use the Brick Viewer to calibrate the Bricklet. The calibration will be saved internally and only has to be done once.
BrickletAnalogInV3.
GetCalibration
(ByRef offset As Short, ByRef multiplier As Integer, ByRef divisor As Integer)¶Output Parameters: |
|
---|
Returns the calibration as set by SetCalibration()
.
BrickletAnalogInV3.
GetSPITFPErrorCount
(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)¶Output Parameters: |
|
---|
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.
BrickletAnalogInV3.
SetStatusLEDConfig
(ByVal config As Byte)¶Parameters: |
|
---|
Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.
You can also turn the LED permanently on/off or show a heartbeat.
If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
The following constants are available for this function:
For config:
BrickletAnalogInV3.
GetStatusLEDConfig
() As Byte¶Returns: |
|
---|
Returns the configuration as set by SetStatusLEDConfig()
The following constants are available for this function:
For config:
BrickletAnalogInV3.
GetChipTemperature
() As Short¶Returns: |
|
---|
Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!
The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.
BrickletAnalogInV3.
Reset
()¶Calling this function will reset the Bricklet. All configurations will be lost.
After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!
BrickletAnalogInV3.
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: |
|
---|
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.
BrickletAnalogInV3.
SetVoltageCallbackConfiguration
(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)¶Parameters: |
|
---|
The period is the period with which the VoltageCallback
callback is triggered
periodically. A value of 0 turns the callback off.
If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.
If it is set to false, the callback is continuously triggered with the period, independent of the value.
It is furthermore possible to constrain the callback with thresholds.
The option-parameter together with min/max sets a threshold for the VoltageCallback
callback.
The following options are possible:
Option | Description |
---|---|
'x' | Threshold is turned off |
'o' | Threshold is triggered when the value is outside the min and max values |
'i' | Threshold is triggered when the value is inside or equal to the min and max values |
'<' | Threshold is triggered when the value is smaller than the min value (max is ignored) |
'>' | Threshold is triggered when the value is greater than the min value (max is ignored) |
If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
The following constants are available for this function:
For option:
BrickletAnalogInV3.
GetVoltageCallbackConfiguration
(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)¶Output Parameters: |
|
---|
Returns the callback configuration as set by SetVoltageCallbackConfiguration()
.
The following constants are available for this function:
For option:
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 BrickletAnalogInV3, ByVal value As Short) Console.WriteLine("Value: {0}", value) End Sub AddHandler analogInV3.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.
BrickletAnalogInV3.
VoltageCallback
(ByVal sender As BrickletAnalogInV3, ByVal voltage As Integer)¶Callback Parameters: |
|
---|
This callback is triggered periodically according to the configuration set by
SetVoltageCallbackConfiguration()
.
The parameter is the same as GetVoltage()
.
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.
BrickletAnalogInV3.
GetAPIVersion
() As Byte()¶Output Parameters: |
|
---|
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.
BrickletAnalogInV3.
GetResponseExpected
(ByVal functionId As Byte) As Boolean¶Parameters: |
|
---|---|
Returns: |
|
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:
BrickletAnalogInV3.
SetResponseExpected
(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶Parameters: |
|
---|
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 sent and errors are silently ignored, because they cannot be detected.
The following constants are available for this function:
For functionId:
BrickletAnalogInV3.
SetResponseExpectedAll
(ByVal responseExpected As Boolean)¶Parameters: |
|
---|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.
BrickletAnalogInV3.
SetBootloaderMode
(ByVal mode As Byte) As Byte¶Parameters: |
|
---|---|
Returns: |
|
Sets the bootloader mode and returns the status after the requested mode change was instigated.
You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
The following constants are available for this function:
For mode:
For status:
BrickletAnalogInV3.
GetBootloaderMode
() As Byte¶Returns: |
|
---|
Returns the current bootloader mode, see SetBootloaderMode()
.
The following constants are available for this function:
For mode:
BrickletAnalogInV3.
SetWriteFirmwarePointer
(ByVal pointer As Long)¶Parameters: |
|
---|
Sets the firmware pointer for WriteFirmware()
. The pointer has
to be increased by chunks of size 64. The data is written to flash
every 4 chunks (which equals to one page of size 256).
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
BrickletAnalogInV3.
WriteFirmware
(ByVal data() As Byte) As Byte¶Parameters: |
|
---|---|
Returns: |
|
Writes 64 Bytes of firmware at the position as written by
SetWriteFirmwarePointer()
before. The firmware is written
to flash every 4 chunks.
You can only write firmware in bootloader mode.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
BrickletAnalogInV3.
WriteUID
(ByVal uid As Long)¶Parameters: |
|
---|
Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.
We recommend that you use Brick Viewer to change the UID.
BrickletAnalogInV3.
ReadUID
() As Long¶Returns: |
|
---|
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
BrickletAnalogInV3.
DEVICE_IDENTIFIER
¶This constant is used to identify a Analog In Bricklet 3.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.
BrickletAnalogInV3.
DEVICE_DISPLAY_NAME
¶This constant represents the human readable name of a Analog In Bricklet 3.0.