LabVIEW - IO-16 Bricklet

This is the description of the LabVIEW API bindings for the IO-16 Bricklet. General information and technical specifications for the IO-16 Bricklet are summarized in its hardware description.

An installation guide for the LabVIEW API bindings is part of their general description.

API

Generally, every method of the LabVIEW bindings that outputs a value can report a Tinkerforge.TimeoutException. This error gets reported if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

Basic Functions

BrickletIO16(uid, ipcon) → io16
Input:
  • uid -- String
  • ipcon -- .NET Refnum (IPConnection)
Output:
  • io16 -- .NET Refnum (BrickletIO16)

Creates an object with the unique device ID uid. This object can then be used after the IP Connection is connected (see examples above).

BrickletIO16.SetPort(port, valueMask)
Input:
  • port -- Char
  • valueMask -- Byte

Sets the output value (high or low) for a port ("a" or "b") with a bitmask (8bit). A 1 in the bitmask means high and a 0 in the bitmask means low.

For example: The value 15 or 0b00001111 will turn the pins 0-3 high and the pins 4-7 low for the specified port.

Note

This function does nothing for pins that are configured as input. Pull-up resistors can be switched on with SetPortConfiguration().

BrickletIO16.GetPort(port) → valueMask
Input:
  • port -- Char
Output:
  • valueMask -- Byte

Returns a bitmask of the values that are currently measured on the specified port. This function works if the pin is configured to input as well as if it is configured to output.

BrickletIO16.SetPortConfiguration(port, selectionMask, direction, value)
Input:
  • port -- Char
  • selectionMask -- Byte
  • direction -- Char
  • value -- Boolean

Configures the value and direction of a specified port. Possible directions are 'i' and 'o' for input and output.

If the direction is configured as output, the value is either high or low (set as true or false).

If the direction is configured as input, the value is either pull-up or default (set as true or false).

For example:

  • ('a', 255, 'i', true) or ('a', 0b11111111, 'i', true) will set all pins of port A as input pull-up.
  • ('a', 128, 'i', false) or ('a', 0b10000000, 'i', false) will set pin 7 of port A as input default (floating if nothing is connected).
  • ('b', 3, 'o', false) or ('b', 0b00000011, 'o', false) will set pins 0 and 1 of port B as output low.
  • ('b', 4, 'o', true) or ('b', 0b00000100, 'o', true) will set pin 2 of port B as output high.

The default configuration is input with pull-up.

The following constants are available for this function:

  • BrickletIO16.DIRECTION_IN = 'i'
  • BrickletIO16.DIRECTION_OUT = 'o'
BrickletIO16.GetPortConfiguration(port) → directionMask, valueMask
Input:
  • port -- Char
Output:
  • directionMask -- Byte
  • valueMask -- Byte

Returns a direction bitmask and a value bitmask for the specified port. A 1 in the direction bitmask means input and a 0 in the bitmask means output.

For example: A return value of (15, 51) or (0b00001111, 0b00110011) for direction and value means that:

  • pins 0 and 1 are configured as input pull-up,
  • pins 2 and 3 are configured as input default,
  • pins 4 and 5 are configured as output high
  • and pins 6 and 7 are configured as output low.
BrickletIO16.GetEdgeCount(pin, resetCounter) → count
Input:
  • pin -- Byte
  • resetCounter -- Boolean
Output:
  • count -- Int64

Returns the current value of the edge counter for the selected pin on port A. You can configure the edges that are counted with SetEdgeCountConfig().

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

New in version 2.0.3 (Plugin).

Advanced Functions

BrickletIO16.SetPortMonoflop(port, selectionMask, valueMask, time)
Input:
  • port -- Char
  • selectionMask -- Byte
  • valueMask -- Byte
  • time -- Int64

Configures a monoflop of the pins specified by the second parameter as 8 bit long bitmask. The specified pins must be configured for output. Non-output pins will be ignored.

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

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

If this function is called with the parameters ('a', 9, 1, 1500) or ('a', 0b00001001, 0b00000001, 1500): Pin 0 will get high and pin 3 will get low on port 'a'. 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 an IO-16 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 set to high. Pin 0 will be high all the time. If now the RS485 connection is lost, then pin 0 will get low in at most two seconds.

BrickletIO16.GetPortMonoflop(port, pin) → value, time, timeRemaining
Input:
  • port -- Char
  • pin -- Byte
Output:
  • value -- Byte
  • time -- Int64
  • timeRemaining -- Int64

Returns (for the given pin) the current value and the time as set by SetPortMonoflop() 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.

BrickletIO16.SetSelectedValues(port, selectionMask, valueMask)
Input:
  • port -- Char
  • selectionMask -- Byte
  • valueMask -- Byte

Sets the output value (high or low) for a port ("a" or "b" with a bitmask, according to the selection mask. The bitmask is 8 bit long and a 1 in the bitmask means high and a 0 in the bitmask means low.

For example: The parameters ('a', 192, 128) or ('a', 0b11000000, 0b10000000) will turn pin 7 high and pin 6 low on port A, pins 0-6 will remain untouched.

Note

This function does nothing for pins that are configured as input. Pull-up resistors can be switched on with SetPortConfiguration().

BrickletIO16.SetEdgeCountConfig(pin, edgeType, debounce)
Input:
  • pin -- Byte
  • edgeType -- Byte
  • debounce -- Byte

Configures the edge counter for the selected pin of port A. Pins 0 and 1 are available for edge counting.

The edge type parameter configures if rising edges, falling edges or both are counted if the pin is configured for input. 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:

  • BrickletIO16.EDGE_TYPE_RISING = 0
  • BrickletIO16.EDGE_TYPE_FALLING = 1
  • BrickletIO16.EDGE_TYPE_BOTH = 2

New in version 2.0.3 (Plugin).

BrickletIO16.GetEdgeCountConfig(pin) → edgeType, debounce
Input:
  • pin -- Byte
Output:
  • edgeType -- Byte
  • debounce -- Byte

Returns the edge type and debounce time for the selected pin of port A as set by SetEdgeCountConfig().

The following constants are available for this function:

  • BrickletIO16.EDGE_TYPE_RISING = 0
  • BrickletIO16.EDGE_TYPE_FALLING = 1
  • BrickletIO16.EDGE_TYPE_BOTH = 2

New in version 2.0.3 (Plugin).

BrickletIO16.GetAPIVersion() → apiVersion
Output:
  • apiVersion -- Byte[3]

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.

BrickletIO16.GetResponseExpected(functionId) → responseExpected
Input:
  • functionId -- Byte
Output:
  • responseExpected -- 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.

BrickletIO16.SetResponseExpected(functionId, responseExpected)
Input:
  • functionId -- Byte
  • responseExpected -- 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:

  • BrickletIO16.FUNCTION_SET_PORT = 1
  • BrickletIO16.FUNCTION_SET_PORT_CONFIGURATION = 3
  • BrickletIO16.FUNCTION_SET_DEBOUNCE_PERIOD = 5
  • BrickletIO16.FUNCTION_SET_PORT_INTERRUPT = 7
  • BrickletIO16.FUNCTION_SET_PORT_MONOFLOP = 10
  • BrickletIO16.FUNCTION_SET_SELECTED_VALUES = 13
  • BrickletIO16.FUNCTION_SET_EDGE_COUNT_CONFIG = 15
BrickletIO16.SetResponseExpectedAll(responseExpected)
Input:
  • responseExpected -- Boolean

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

BrickletIO16.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Output:
  • uid -- String
  • connectedUid -- String
  • position -- Char
  • hardwareVersion -- Byte[3]
  • firmwareVersion -- Byte[3]
  • deviceIdentifier -- Int32

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

BrickletIO16.SetDebouncePeriod(debounce)
Input:
  • debounce -- Int64

Sets the debounce period of the InterruptCallback callback in ms.

For example: If you set this value to 100, you will get the interrupt maximal every 100ms. This is necessary if something that bounces is connected to the IO-16 Bricklet, such as a button.

The default value is 100.

BrickletIO16.GetDebouncePeriod() → debounce
Output:
  • debounce -- Int64

Returns the debounce period as set by SetDebouncePeriod().

BrickletIO16.SetPortInterrupt(port, interruptMask)
Input:
  • port -- Char
  • interruptMask -- Byte

Sets the pins on which an interrupt is activated with a bitmask. Interrupts are triggered on changes of the voltage level of the pin, i.e. changes from high to low and low to high.

For example: ('a', 129) or ('a', 0b10000001) will enable the interrupt for pins 0 and 7 of port a.

The interrupt is delivered with the InterruptCallback callback.

BrickletIO16.GetPortInterrupt(port) → interruptMask
Input:
  • port -- Char
Output:
  • interruptMask -- Byte

Returns the interrupt bitmask for the specified port as set by SetPortInterrupt().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object. 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 BrickletIO16.InterruptCallback(sender, port, interruptMask, valueMask)
Input:
  • sender -- .NET Refnum (BrickletIO16)
  • port -- Char
  • interruptMask -- Byte
  • valueMask -- Byte

This callback is triggered whenever a change of the voltage level is detected on pins where the interrupt was activated with SetPortInterrupt().

The values are the port, a bitmask that specifies which interrupts occurred and the current value bitmask of the port.

For example:

  • ('a', 1, 1) or ('a', 0b00000001, 0b00000001) means that on port A an interrupt on pin 0 occurred and currently pin 0 is high and pins 1-7 are low.
  • ('b', 129, 254) or ('b', 0b10000001, 0b11111110) means that on port B interrupts on pins 0 and 7 occurred and currently pin 0 is low and pins 1-7 are high.
event BrickletIO16.MonoflopDoneCallback(sender, port, selectionMask, valueMask)
Input:
  • sender -- .NET Refnum (BrickletIO16)
  • port -- Char
  • selectionMask -- Byte
  • valueMask -- Byte

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

Constants

BrickletIO16.DEVICE_IDENTIFIER

This constant is used to identify a IO-16 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.

BrickletIO16.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a IO-16 Bricklet.