Visual Basic .NET - Industrial Analog Out Bricklet 2.0

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

Download (ExampleSimpleCurrent.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
Imports System
Imports Tinkerforge

Module ExampleSimpleCurrent
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Industrial Analog Out Bricklet 2.0

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

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

        ' Set output current to 4.5mA
        iao.SetCurrent(4500)
        iao.SetEnabled(True)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        iao.SetEnabled(False)
        ipcon.Disconnect()
    End Sub
End Module

Simple Voltage

Download (ExampleSimpleVoltage.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
Imports System
Imports Tinkerforge

Module ExampleSimpleVoltage
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Industrial Analog Out Bricklet 2.0

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

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

        ' Set output voltage to 3.3V
        iao.SetVoltage(3300)
        iao.SetEnabled(True)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        iao.SetEnabled(False)
        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 BrickletIndustrialAnalogOutV2(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim industrialAnalogOutV2 As New BrickletIndustrialAnalogOutV2("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletIndustrialAnalogOutV2.SetEnabled(ByVal enabled As Boolean)

Enables/disables the output of voltage and current.

The default is disabled.

Function BrickletIndustrialAnalogOutV2.GetEnabled() As Boolean

Returns true if output of voltage and current is enabled, false otherwise.

Sub BrickletIndustrialAnalogOutV2.SetVoltage(ByVal voltage As Integer)

Sets the output voltage in mV.

The output voltage and output current are linked. Changing the output voltage also changes the output current.

Function BrickletIndustrialAnalogOutV2.GetVoltage() As Integer

Returns the voltage as set by SetVoltage().

Sub BrickletIndustrialAnalogOutV2.SetCurrent(ByVal current As Integer)

Sets the output current in µA.

The output current and output voltage are linked. Changing the output current also changes the output voltage.

Function BrickletIndustrialAnalogOutV2.GetCurrent() As Integer

Returns the current as set by SetCurrent().

Sub BrickletIndustrialAnalogOutV2.SetOutLEDConfig(ByVal config As Byte)

You can turn the Out LED off, on or show a heartbeat. You can also set the LED to "Out Status". In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the output value (voltage or current).

You can configure the channel status behavior with SetOutLEDStatusConfig().

By default the LED is configured as "Out Status"

The following constants are available for this function:

  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_OFF = 0
  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_ON = 1
  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_OUT_STATUS = 3
Function BrickletIndustrialAnalogOutV2.GetOutLEDConfig() As Byte

Returns the Out LED configuration as set by SetOutLEDConfig()

The following constants are available for this function:

  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_OFF = 0
  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_ON = 1
  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_OUT_STATUS = 3
Sub BrickletIndustrialAnalogOutV2.SetOutLEDStatusConfig(ByVal min As Integer, ByVal max As Integer, ByVal config As Byte)

Sets the Out LED status config. This config is used if the Out LED is configured as "Out Status", see SetOutLEDConfig().

For each channel you can choose between threshold and intensity mode.

In threshold mode you can define a positive or a negative threshold. For a positive threshold set the "min" parameter to the threshold value in mV or µA above which the LED should turn on and set the "max" parameter to 0. Example: If you set a positive threshold of 5V, the LED will turn on as soon as the output value exceeds 5V and turn off again if it goes below 5V. For a negative threshold set the "max" parameter to the threshold value in mV or µA below which the LED should turn on and set the "min" parameter to 0. Example: If you set a negative threshold of 5V, the LED will turn on as soon as the output value goes below 5V and the LED will turn off when the output value exceeds 5V.

In intensity mode you can define a range mV or µA that is used to scale the brightness of the LED. Example with min=2V, max=8V: The LED is off at 2V and below, on at 8V and above and the brightness is linearly scaled between the values 2V and 8V. If the min value is greater than the max value, the LED brightness is scaled the other way around.

By default the channel LED status config is set to intensity with min=0V and max=10V.

The following constants are available for this function:

  • BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_INTENSITY = 1
Sub BrickletIndustrialAnalogOutV2.GetOutLEDStatusConfig(ByRef min As Integer, ByRef max As Integer, ByRef config As Byte)

Returns the Out LED status configuration as set by SetOutLEDStatusConfig().

The following constants are available for this function:

  • BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_INTENSITY = 1

Advanced Functions

Sub BrickletIndustrialAnalogOutV2.SetConfiguration(ByVal voltageRange As Byte, ByVal currentRange As Byte)

Configures the voltage and current range.

Possible voltage ranges are:

  • 0V to 5V
  • 0V to 10V (default)

Possible current ranges are:

  • 4mA to 20mA (default)
  • 0mA to 20mA
  • 0mA to 24mA

The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.

The following constants are available for this function:

  • BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_10V = 1
  • BrickletIndustrialAnalogOutV2.CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_24MA = 2
Sub BrickletIndustrialAnalogOutV2.GetConfiguration(ByRef voltageRange As Byte, ByRef currentRange As Byte)

Returns the configuration as set by SetConfiguration().

The following constants are available for this function:

  • BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_10V = 1
  • BrickletIndustrialAnalogOutV2.CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_24MA = 2
Function BrickletIndustrialAnalogOutV2.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 BrickletIndustrialAnalogOutV2.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.

See SetResponseExpected() for the list of function ID constants available for this function.

Sub BrickletIndustrialAnalogOutV2.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 function ID constants are available for this function:

  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_ENABLED = 1
  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_VOLTAGE = 3
  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_CURRENT = 5
  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_CONFIGURATION = 7
  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_OUT_LED_CONFIG = 9
  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialAnalogOutV2.FUNCTION_RESET = 243
  • BrickletIndustrialAnalogOutV2.FUNCTION_WRITE_UID = 248
Sub BrickletIndustrialAnalogOutV2.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

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

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

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.

Function BrickletIndustrialAnalogOutV2.SetBootloaderMode(ByVal mode As Byte) As Byte

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:

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

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

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

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.

Function BrickletIndustrialAnalogOutV2.WriteFirmware(ByVal data() As Byte) As Byte

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.

Sub BrickletIndustrialAnalogOutV2.SetStatusLEDConfig(ByVal config As Byte)

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:

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

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

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

Returns the temperature in °C 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.

Sub BrickletIndustrialAnalogOutV2.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!

Sub BrickletIndustrialAnalogOutV2.WriteUID(ByVal uid As Long)

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.

Function BrickletIndustrialAnalogOutV2.ReadUID() As Long

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

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

Constants

Const BrickletIndustrialAnalogOutV2.DEVICE_IDENTIFIER

This constant is used to identify a Industrial Analog Out Bricklet 2.0.

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

Const BrickletIndustrialAnalogOutV2.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Analog Out Bricklet 2.0.