LabVIEW - Industrial Analog Out Bricklet

This is the description of the LabVIEW API bindings for the Industrial Analog Out Bricklet. General information and technical specifications for the Industrial Analog Out Bricklet are summarized in its hardware description.

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

Examples

The example code below is Public Domain (CC0 1.0).

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

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

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

BrickletIndustrialAnalogOut.Enable()

Enables the output of voltage and current.

The default is disabled.

BrickletIndustrialAnalogOut.Disable()

Disables the output of voltage and current.

The default is disabled.

BrickletIndustrialAnalogOut.IsEnabled() → enabled
Output:
  • enabled -- Boolean

Returns true if output of voltage and current is enabled, false otherwise.

BrickletIndustrialAnalogOut.SetVoltage(voltage)
Input:
  • voltage -- Int32

Sets the output voltage in mV.

The output voltage and output current are linked. Changing the output voltage also changes the output current.

BrickletIndustrialAnalogOut.GetVoltage() → voltage
Output:
  • voltage -- Int32

Returns the voltage as set by SetVoltage().

BrickletIndustrialAnalogOut.SetCurrent(current)
Input:
  • current -- Int32

Sets the output current in µA.

The output current and output voltage are linked. Changing the output current also changes the output voltage.

BrickletIndustrialAnalogOut.GetCurrent() → current
Output:
  • current -- Int32

Returns the current as set by SetCurrent().

Advanced Functions

BrickletIndustrialAnalogOut.SetConfiguration(voltageRange, currentRange)
Input:
  • voltageRange -- Byte
  • currentRange -- Byte

Configures the voltage and current range.

Possible voltage ranges are:

  • 0V to 5V
  • 0V to 10V (default)

Possible current ranges are:

  • 4mA to 20mA (default)
  • 0mA to 20mA
  • 0mA to 24mA

The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.

The following constants are available for this function:

  • BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1
  • BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2
BrickletIndustrialAnalogOut.GetConfiguration() → voltageRange, currentRange
Output:
  • voltageRange -- Byte
  • currentRange -- Byte

Returns the configuration as set by SetConfiguration().

The following constants are available for this function:

  • BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1
  • BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2
BrickletIndustrialAnalogOut.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.

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

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

  • BrickletIndustrialAnalogOut.FUNCTION_ENABLE = 1
  • BrickletIndustrialAnalogOut.FUNCTION_DISABLE = 2
  • BrickletIndustrialAnalogOut.FUNCTION_SET_VOLTAGE = 4
  • BrickletIndustrialAnalogOut.FUNCTION_SET_CURRENT = 6
  • BrickletIndustrialAnalogOut.FUNCTION_SET_CONFIGURATION = 8
BrickletIndustrialAnalogOut.SetResponseExpectedAll(responseExpected)
Input:
  • responseExpected -- Boolean

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

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

Constants

BrickletIndustrialAnalogOut.DEVICE_IDENTIFIER

This constant is used to identify a Industrial Analog Out 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.

BrickletIndustrialAnalogOut.DEVICE_DISPLAY_NAME

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