LabVIEW - Current12 Bricklet

This is the description of the LabVIEW API bindings for the Current12 Bricklet. General information and technical specifications for the Current12 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

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

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

BrickletCurrent12.GetCurrent() → current
Output:
  • current -- Int16

Returns the current of the sensor. The value is in mA and between -12500mA and 12500mA.

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

Advanced Functions

BrickletCurrent12.Calibrate()

Calibrates the 0 value of the sensor. You have to call this function when there is no current present.

The zero point of the current sensor is depending on the exact properties of the analog-to-digital converter, the length of the Bricklet cable and the temperature. Thus, if you change the Brick or the environment in which the Bricklet is used, you might have to recalibrate.

The resulting calibration will be saved on the EEPROM of the Current Bricklet.

BrickletCurrent12.IsOverCurrent() → over
Output:
  • over -- Boolean

Returns true if more than 12.5A were measured.

Note

To reset this value you have to power cycle the Bricklet.

BrickletCurrent12.GetAnalogValue() → value
Output:
  • value -- Int32

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

Note

The value returned by GetCurrent() is averaged over several samples to yield less noise, while GetAnalogValue() gives back raw unfiltered analog values. The only reason to use GetAnalogValue() is, if you need the full resolution of the analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the AnalogValueCallback callback and set the period with SetAnalogValueCallbackPeriod().

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

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

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

  • BrickletCurrent12.FUNCTION_CALIBRATE = 2
  • BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 5
  • BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 9
  • BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • BrickletCurrent12.FUNCTION_SET_DEBOUNCE_PERIOD = 13
BrickletCurrent12.SetResponseExpectedAll(responseExpected)
Input:
  • responseExpected -- Boolean

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

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

BrickletCurrent12.SetCurrentCallbackPeriod(period)
Input:
  • period -- Int64

Sets the period in ms with which the CurrentCallback callback is triggered periodically. 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.

BrickletCurrent12.GetCurrentCallbackPeriod() → period
Output:
  • period -- Int64

Returns the period as set by SetCurrentCallbackPeriod().

BrickletCurrent12.SetAnalogValueCallbackPeriod(period)
Input:
  • period -- Int64

Sets the period in ms with which the AnalogValueCallback callback is triggered periodically. A value of 0 turns the callback off.

The AnalogValueCallback callback is only triggered if the analog value has changed since the last triggering.

The default value is 0.

BrickletCurrent12.GetAnalogValueCallbackPeriod() → period
Output:
  • period -- Int64

Returns the period as set by SetAnalogValueCallbackPeriod().

BrickletCurrent12.SetCurrentCallbackThreshold(option, min, max)
Input:
  • option -- Char
  • min -- Int16
  • max -- Int16

Sets the thresholds for the CurrentReachedCallback callback.

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:

  • BrickletCurrent12.THRESHOLD_OPTION_OFF = 'x'
  • BrickletCurrent12.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCurrent12.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCurrent12.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCurrent12.THRESHOLD_OPTION_GREATER = '>'
BrickletCurrent12.GetCurrentCallbackThreshold() → option, min, max
Output:
  • option -- Char
  • min -- Int16
  • max -- Int16

Returns the threshold as set by SetCurrentCallbackThreshold().

The following constants are available for this function:

  • BrickletCurrent12.THRESHOLD_OPTION_OFF = 'x'
  • BrickletCurrent12.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCurrent12.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCurrent12.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCurrent12.THRESHOLD_OPTION_GREATER = '>'
BrickletCurrent12.SetAnalogValueCallbackThreshold(option, min, max)
Input:
  • option -- Char
  • min -- Int32
  • max -- Int32

Sets the thresholds for the AnalogValueReachedCallback callback.

The following options are possible:

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

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

The following constants are available for this function:

  • BrickletCurrent12.THRESHOLD_OPTION_OFF = 'x'
  • BrickletCurrent12.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCurrent12.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCurrent12.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCurrent12.THRESHOLD_OPTION_GREATER = '>'
BrickletCurrent12.GetAnalogValueCallbackThreshold() → option, min, max
Output:
  • option -- Char
  • min -- Int32
  • max -- Int32

Returns the threshold as set by SetAnalogValueCallbackThreshold().

The following constants are available for this function:

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

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

BrickletCurrent12.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 BrickletCurrent12.CurrentCallback(sender, current)
Input:
  • sender -- .NET Refnum (BrickletCurrent12)
  • current -- Int16

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 BrickletCurrent12.AnalogValueCallback(sender, value)
Input:
  • sender -- .NET Refnum (BrickletCurrent12)
  • value -- Int32

This callback is triggered periodically with the period that is set by SetAnalogValueCallbackPeriod(). The parameter is the analog value of the sensor.

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

event BrickletCurrent12.CurrentReachedCallback(sender, current)
Input:
  • sender -- .NET Refnum (BrickletCurrent12)
  • current -- Int16

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().

event BrickletCurrent12.AnalogValueReachedCallback(sender, value)
Input:
  • sender -- .NET Refnum (BrickletCurrent12)
  • value -- Int32

This callback is triggered when the threshold as set by SetAnalogValueCallbackThreshold() is reached. The parameter is the analog value of the sensor.

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

event BrickletCurrent12.OverCurrentCallback(sender)
Input:
  • sender -- .NET Refnum (BrickletCurrent12)

This callback is triggered when an over current is measured (see IsOverCurrent()).

Constants

BrickletCurrent12.DEVICE_IDENTIFIER

This constant is used to identify a Current12 Bricklet.

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

BrickletCurrent12.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Current12 Bricklet.