Visual Basic .NET - Industrial Digital Out 4 Bricklet

This is the description of the Visual Basic .NET API bindings for the Industrial Digital Out 4 Bricklet. General information and technical specifications for the Industrial Digital Out 4 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
29
30
31
32
33
34
Imports System
Imports System.Threading
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 Out 4 Bricklet

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

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

        ' Set pins alternating high/low 10 times with 100ms delay
        Dim i As Integer
        For i = 0 To 9
            Thread.Sleep(100)
            ido4.SetValue(1 << 0)
            Thread.Sleep(100)
            ido4.SetValue(1 << 1)
            Thread.Sleep(100)
            ido4.SetValue(1 << 2)
            Thread.Sleep(100)
            ido4.SetValue(1 << 3)
        Next i

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

Creates an object with the unique device ID uid:

Dim industrialDigitalOut4 As New BrickletIndustrialDigitalOut4("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletIndustrialDigitalOut4.SetValue(ByVal valueMask As Integer)

Sets the output value with a bitmask (16bit). A 1 in the bitmask means high and a 0 in the bitmask means low.

For example: The value 3 or 0b0011 will turn pins 0-1 high and the other pins low.

If no groups are used (see SetGroup()), the pins correspond to the markings on the Digital Out 4 Bricklet.

If groups are used, the pins correspond to the element in the group. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

Function BrickletIndustrialDigitalOut4.GetValue() As Integer

Returns the bitmask as set by SetValue().

Sub BrickletIndustrialDigitalOut4.SetSelectedValues(ByVal selectionMask As Integer, ByVal valueMask As Integer)

Sets the output value with a bitmask, according to the selection mask. The bitmask is 16 bit long, true refers to high and false refers to low.

For example: The values (3, 1) or (0b0011, 0b0001) will turn pin 0 high, pin 1 low the other pins remain untouched.

If no groups are used (see SetGroup()), the pins correspond to the markings on the Digital Out 4 Bricklet.

If groups are used, the pins correspond to the element in the group. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

Advanced Functions

Sub BrickletIndustrialDigitalOut4.SetMonoflop(ByVal selectionMask As Integer, ByVal valueMask As Integer, ByVal time As Long)

Configures a monoflop of the pins specified by the first parameter bitmask.

The second parameter is a bitmask with the desired value of the specified pins. A 1 in the bitmask means high and a 0 in the bitmask means low.

The third parameter indicates the time (in ms) that the pins should hold the value.

If this function is called with the parameters (9, 1, 1500) or (0b1001, 0b0001, 1500): Pin 0 will get high and pin 3 will get low. In 1.5s pin 0 will get low and pin 3 will get high again.

A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and a Digital Out 4 Bricklet connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds and pin 0 high. Pin 0 will be high all the time. If now the RS485 connection is lost, then pin 0 will turn low in at most two seconds.

Sub BrickletIndustrialDigitalOut4.GetMonoflop(ByVal pin As Byte, ByRef value As Integer, ByRef time As Long, ByRef timeRemaining As Long)

Returns (for the given pin) the current value and the time as set by SetMonoflop() as well as the remaining time until the value flips.

If the timer is not running currently, the remaining time will be returned as 0.

Sub BrickletIndustrialDigitalOut4.SetGroup(ByVal group() As Char)

Sets a group of Digital Out 4 Bricklets that should work together. You can find Bricklets that can be grouped together with GetAvailableForGroup().

The group consists of 4 elements. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

Each element can either be one of the ports ('a' to 'd') or 'n' if it should not be used.

For example: If you have two Digital Out 4 Bricklets connected to port A and port B respectively, you could call with ['a', 'b', 'n', 'n'].

Now the pins on the Digital Out 4 on port A are assigned to 0-3 and the pins on the Digital Out 4 on port B are assigned to 4-7. It is now possible to call SetValue() and control two Bricklets at the same time.

Function BrickletIndustrialDigitalOut4.GetGroup() As Char()

Returns the group as set by SetGroup()

Function BrickletIndustrialDigitalOut4.GetAvailableForGroup() As Byte

Returns a bitmask of ports that are available for grouping. For example the value 5 or 0b0101 means: Port A and port C are connected to Bricklets that can be grouped together.

Function BrickletIndustrialDigitalOut4.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 BrickletIndustrialDigitalOut4.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 BrickletIndustrialDigitalOut4.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:

  • BrickletIndustrialDigitalOut4.FUNCTION_SET_VALUE = 1
  • BrickletIndustrialDigitalOut4.FUNCTION_SET_MONOFLOP = 3
  • BrickletIndustrialDigitalOut4.FUNCTION_SET_GROUP = 5
  • BrickletIndustrialDigitalOut4.FUNCTION_SET_SELECTED_VALUES = 9
Sub BrickletIndustrialDigitalOut4.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

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

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

AddHandler industrialDigitalOut4.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 BrickletIndustrialDigitalOut4.MonoflopDoneCallback(ByVal sender As BrickletIndustrialDigitalOut4, ByVal selectionMask As Integer, ByVal valueMask As Integer)

This callback is triggered whenever a monoflop timer reaches 0. The parameters contain the involved pins and the current value of the pins (the value after the monoflop).

Constants

Const BrickletIndustrialDigitalOut4.DEVICE_IDENTIFIER

This constant is used to identify a Industrial Digital Out 4 Bricklet.

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 BrickletIndustrialDigitalOut4.DEVICE_DISPLAY_NAME

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