Visual Basic .NET - Industrial Digital In 4 Bricklet 2.0

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

 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 Industrial Digital In 4 Bricklet 2.0

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

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

        ' Get current value
        Dim value As Boolean() = idi4.GetValue()

        Console.WriteLine("Channel 0: " + value(0).ToString())
        Console.WriteLine("Channel 1: " + value(1).ToString())
        Console.WriteLine("Channel 2: " + value(2).ToString())
        Console.WriteLine("Channel 3: " + value(3).ToString())

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

Edge Count

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

Module ExampleEdgeCount
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

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

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

        ' Configure rising edge count (channel 3) with 10ms debounce
        idi4.SetEdgeCountConfiguration(3, 0, 10)

        ' Get edge count 10 times with 1s delay
        Dim i As Integer
        For i = 0 To 9
            Thread.Sleep(1000)

            ' Get current edge count
            Dim count As Long = idi4.GetEdgeCount(3, False)
            Console.WriteLine("Count: " + count.ToString())
        Next i

        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
34
35
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 Industrial Digital In 4 Bricklet 2.0

    ' Callback subroutine for value callback
    Sub ValueCB(ByVal sender As BrickletIndustrialDigitalIn4V2, ByVal channel As Byte, _
                ByVal changed As Boolean, ByVal value As Boolean)
        Console.WriteLine("Channel: " + channel.ToString())
        Console.WriteLine("Changed: " + changed.ToString())
        Console.WriteLine("Value: " + value.ToString())
        Console.WriteLine("")
    End Sub

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

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

        ' Register value callback to subroutine ValueCB
        AddHandler idi4.ValueCallback, AddressOf ValueCB

        ' Set period for value (channel 1) callback to 0.1s (100ms)
        idi4.SetValueCallbackConfiguration(1, 100, False)

        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 BrickletIndustrialDigitalIn4V2(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim industrialDigitalIn4V2 As New BrickletIndustrialDigitalIn4V2("YOUR_DEVICE_UID", ipcon)

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

Function BrickletIndustrialDigitalIn4V2.GetValue() As Boolean()

Returns the input value as bools, true refers to high and false refers to low.

Sub BrickletIndustrialDigitalIn4V2.SetChannelLEDConfig(ByVal channel As Byte, ByVal config As Byte)

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED is on if the channel is high and off otherwise.

By default all channel LEDs are configured as "Channel Status".

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
Function BrickletIndustrialDigitalIn4V2.GetChannelLEDConfig(ByVal channel As Byte) As Byte

Returns the channel LED configuration as set by SetChannelLEDConfig()

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Advanced Functions

Function BrickletIndustrialDigitalIn4V2.GetEdgeCount(ByVal channel As Byte, ByVal resetCounter As Boolean) As Long

Returns the current value of the edge counter for the selected channel. You can configure the edges that are counted with SetEdgeCountConfiguration().

If you set the reset counter to true, the count is set back to 0 directly after it is read.

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
Sub BrickletIndustrialDigitalIn4V2.SetEdgeCountConfiguration(ByVal channel As Byte, ByVal edgeType As Byte, ByVal debounce As Byte)

Configures the edge counter for a specific channel.

The edge type parameter configures if rising edges, falling edges or both are counted. Possible edge types are:

  • 0 = rising (default)
  • 1 = falling
  • 2 = both

The debounce time is given in ms.

Configuring an edge counter resets its value to 0.

If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you.

Default values: 0 (edge type) and 100ms (debounce time)

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2
Sub BrickletIndustrialDigitalIn4V2.GetEdgeCountConfiguration(ByVal channel As Byte, ByRef edgeType As Byte, ByRef debounce As Byte)

Returns the edge type and debounce time for the selected channel as set by SetEdgeCountConfiguration().

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2
Function BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.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:

  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDigitalIn4V2.FUNCTION_RESET = 243
  • BrickletIndustrialDigitalIn4V2.FUNCTION_WRITE_UID = 248
Sub BrickletIndustrialDigitalIn4V2.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.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:

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

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
Sub BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.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:

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

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.ReadUID() As Long

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

Sub BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.SetValueCallbackConfiguration(ByVal channel As Byte, ByVal period As Long, ByVal valueHasToChange As Boolean)

This callback can be configured per channel.

The period in ms is the period with which the ValueCallback 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.

The default value is (0, false).

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
Sub BrickletIndustrialDigitalIn4V2.GetValueCallbackConfiguration(ByVal channel As Byte, ByRef period As Long, ByRef valueHasToChange As Boolean)

Returns the callback configuration for the given channel as set by SetValueCallbackConfiguration().

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
Sub BrickletIndustrialDigitalIn4V2.SetAllValueCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)

The period in ms is the period with which the AllValueCallback 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.

The default value is (0, false).

Sub BrickletIndustrialDigitalIn4V2.GetAllValueCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)

Returns the callback configuration as set by SetAllValueCallbackConfiguration().

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

AddHandler industrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.ValueCallback(ByVal sender As BrickletIndustrialDigitalIn4V2, ByVal channel As Byte, ByVal changed As Boolean, ByVal value As Boolean)

This callback is triggered periodically according to the configuration set by SetValueCallbackConfiguration().

The parameters are the channel, a value-changed indicator and the actual value for the channel. The changed parameter is true if the value has changed since the last callback.

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
Event BrickletIndustrialDigitalIn4V2.AllValueCallback(ByVal sender As BrickletIndustrialDigitalIn4V2, ByVal changed() As Boolean, ByVal value() As Boolean)

This callback is triggered periodically according to the configuration set by SetAllValueCallbackConfiguration().

The parameters are the same as GetValue(). Additional the changed parameter is true if the value has changed since the last callback.

Constants

Const BrickletIndustrialDigitalIn4V2.DEVICE_IDENTIFIER

This constant is used to identify a Industrial Digital In 4 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 BrickletIndustrialDigitalIn4V2.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Digital In 4 Bricklet 2.0.