LabVIEW - Industrial Dual 0-20mA Bricklet

This is the description of the LabVIEW API bindings for the Industrial Dual 0-20mA Bricklet. General information and technical specifications for the Industrial Dual 0-20mA 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.*.

Two sensors can be connected to the Bricklet. Functions that are related directly to a sensor have a sensor parameter to specify one of the two sensors. Valid values for the sensor parameter are 0 and 1.

Basic Functions

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

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

BrickletIndustrialDual020mA.GetCurrent(sensor) → current
Input:
  • sensor -- Byte
Output:
  • current -- Int32

Returns the current of the specified sensor (0 or 1). The value is in nA and between 0nA and 22505322nA (22.5mA).

It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works probably.

If the returned current is below 4mA, there is likely no sensor connected or the sensor may be defect. If the returned current is over 20mA, there might be a short circuit or the sensor may be defect.

If you want to get the current periodically, it is recommended to use the CurrentCallback callback and set the period with SetCurrentCallbackPeriod().

Advanced Functions

BrickletIndustrialDual020mA.SetSampleRate(rate)
Input:
  • rate -- Byte

Sets the sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively.

Value Description
0 240 samples per second, 12 bit resolution
1 60 samples per second, 14 bit resolution
2 15 samples per second, 16 bit resolution
3 4 samples per second, 18 bit resolution

The default value is 3 (4 samples per second with 18 bit resolution).

The following constants are available for this function:

  • BrickletIndustrialDual020mA.SAMPLE_RATE_240_SPS = 0
  • BrickletIndustrialDual020mA.SAMPLE_RATE_60_SPS = 1
  • BrickletIndustrialDual020mA.SAMPLE_RATE_15_SPS = 2
  • BrickletIndustrialDual020mA.SAMPLE_RATE_4_SPS = 3
BrickletIndustrialDual020mA.GetSampleRate() → rate
Output:
  • rate -- Byte

Returns the sample rate as set by SetSampleRate().

The following constants are available for this function:

  • BrickletIndustrialDual020mA.SAMPLE_RATE_240_SPS = 0
  • BrickletIndustrialDual020mA.SAMPLE_RATE_60_SPS = 1
  • BrickletIndustrialDual020mA.SAMPLE_RATE_15_SPS = 2
  • BrickletIndustrialDual020mA.SAMPLE_RATE_4_SPS = 3
BrickletIndustrialDual020mA.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.

BrickletIndustrialDual020mA.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.

BrickletIndustrialDual020mA.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:

  • BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
  • BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
  • BrickletIndustrialDual020mA.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletIndustrialDual020mA.FUNCTION_SET_SAMPLE_RATE = 8
BrickletIndustrialDual020mA.SetResponseExpectedAll(responseExpected)
Input:
  • responseExpected -- Boolean

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

BrickletIndustrialDual020mA.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

BrickletIndustrialDual020mA.SetCurrentCallbackPeriod(sensor, period)
Input:
  • sensor -- Byte
  • period -- Int64

Sets the period in ms with which the CurrentCallback callback is triggered periodically for the given sensor. A value of 0 turns the callback off.

The CurrentCallback callback is only triggered if the current has changed since the last triggering.

The default value is 0.

BrickletIndustrialDual020mA.GetCurrentCallbackPeriod(sensor) → period
Input:
  • sensor -- Byte
Output:
  • period -- Int64

Returns the period as set by SetCurrentCallbackPeriod().

BrickletIndustrialDual020mA.SetCurrentCallbackThreshold(sensor, option, min, max)
Input:
  • sensor -- Byte
  • option -- Char
  • min -- Int32
  • max -- Int32

Sets the thresholds for the CurrentReachedCallback callback for the given sensor.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the current is outside the min and max values
'i' Callback is triggered when the current is inside the min and max values
'<' Callback is triggered when the current is smaller than the min value (max is ignored)
'>' Callback is triggered when the current is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following constants are available for this function:

  • BrickletIndustrialDual020mA.THRESHOLD_OPTION_OFF = 'x'
  • BrickletIndustrialDual020mA.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletIndustrialDual020mA.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletIndustrialDual020mA.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletIndustrialDual020mA.THRESHOLD_OPTION_GREATER = '>'
BrickletIndustrialDual020mA.GetCurrentCallbackThreshold(sensor) → option, min, max
Input:
  • sensor -- Byte
Output:
  • option -- Char
  • min -- Int32
  • max -- Int32

Returns the threshold as set by SetCurrentCallbackThreshold().

The following constants are available for this function:

  • BrickletIndustrialDual020mA.THRESHOLD_OPTION_OFF = 'x'
  • BrickletIndustrialDual020mA.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletIndustrialDual020mA.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletIndustrialDual020mA.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletIndustrialDual020mA.THRESHOLD_OPTION_GREATER = '>'
BrickletIndustrialDual020mA.SetDebouncePeriod(debounce)
Input:
  • debounce -- Int64

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

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

Returns the debounce period as set by SetDebouncePeriod().

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 BrickletIndustrialDual020mA.CurrentCallback(sender, sensor, current)
Input:
  • sender -- .NET Refnum (BrickletIndustrialDual020mA)
  • sensor -- Byte
  • current -- Int32

This callback is triggered periodically with the period that is set by SetCurrentCallbackPeriod(). The parameter is the current of the sensor.

The CurrentCallback callback is only triggered if the current has changed since the last triggering.

event BrickletIndustrialDual020mA.CurrentReachedCallback(sender, sensor, current)
Input:
  • sender -- .NET Refnum (BrickletIndustrialDual020mA)
  • sensor -- Byte
  • current -- Int32

This callback is triggered when the threshold as set by SetCurrentCallbackThreshold() is reached. The parameter is the current of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().

Constants

BrickletIndustrialDual020mA.DEVICE_IDENTIFIER

This constant is used to identify a Industrial Dual 0-20mA 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.

BrickletIndustrialDual020mA.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Dual 0-20mA Bricklet.