LabVIEW - Voltage/Current Bricklet 2.0

This is the description of the LabVIEW API bindings for the Voltage/Current Bricklet 2.0. General information and technical specifications for the Voltage/Current Bricklet 2.0 are summarized in its hardware description.

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

API

Generally, every function 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

BrickletVoltageCurrentV2(uid, ipcon) → voltageCurrentV2
Input:
  • uid – Type: String
  • ipcon – Type: .NET Refnum (IPConnection)
Output:
  • voltageCurrentV2 – Type: .NET Refnum (BrickletVoltageCurrentV2)

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

BrickletVoltageCurrentV2.GetCurrent() → current
Output:
  • current – Type: Int32, Unit: 1 mA, Range: [-20000 to 20000]

Returns the current.

If you want to get the value periodically, it is recommended to use the CurrentCallback callback. You can set the callback configuration with SetCurrentCallbackConfiguration().

BrickletVoltageCurrentV2.GetVoltage() → voltage
Output:
  • voltage – Type: Int32, Unit: 1 mV, Range: [0 to 36000]

Returns the voltage.

If you want to get the value periodically, it is recommended to use the VoltageCallback callback. You can set the callback configuration with SetVoltageCallbackConfiguration().

BrickletVoltageCurrentV2.GetPower() → power
Output:
  • power – Type: Int32, Unit: 1 mW, Range: [0 to 720000]

Returns the power.

If you want to get the value periodically, it is recommended to use the PowerCallback callback. You can set the callback configuration with SetPowerCallbackConfiguration().

BrickletVoltageCurrentV2.SetConfiguration(averaging, voltageConversionTime, currentConversionTime)
Input:
  • averaging – Type: Byte, Range: See constants, Default: 3
  • voltageConversionTime – Type: Byte, Range: See constants, Default: 4
  • currentConversionTime – Type: Byte, Range: See constants, Default: 4

Sets the configuration of the Voltage/Current Bricklet 2.0. It is possible to configure number of averages as well as voltage and current conversion time.

The following constants are available for this function:

For averaging:

  • BrickletVoltageCurrentV2.AVERAGING_1 = 0
  • BrickletVoltageCurrentV2.AVERAGING_4 = 1
  • BrickletVoltageCurrentV2.AVERAGING_16 = 2
  • BrickletVoltageCurrentV2.AVERAGING_64 = 3
  • BrickletVoltageCurrentV2.AVERAGING_128 = 4
  • BrickletVoltageCurrentV2.AVERAGING_256 = 5
  • BrickletVoltageCurrentV2.AVERAGING_512 = 6
  • BrickletVoltageCurrentV2.AVERAGING_1024 = 7

For voltageConversionTime:

  • BrickletVoltageCurrentV2.CONVERSION_TIME_140US = 0
  • BrickletVoltageCurrentV2.CONVERSION_TIME_204US = 1
  • BrickletVoltageCurrentV2.CONVERSION_TIME_332US = 2
  • BrickletVoltageCurrentV2.CONVERSION_TIME_588US = 3
  • BrickletVoltageCurrentV2.CONVERSION_TIME_1_1MS = 4
  • BrickletVoltageCurrentV2.CONVERSION_TIME_2_116MS = 5
  • BrickletVoltageCurrentV2.CONVERSION_TIME_4_156MS = 6
  • BrickletVoltageCurrentV2.CONVERSION_TIME_8_244MS = 7

For currentConversionTime:

  • BrickletVoltageCurrentV2.CONVERSION_TIME_140US = 0
  • BrickletVoltageCurrentV2.CONVERSION_TIME_204US = 1
  • BrickletVoltageCurrentV2.CONVERSION_TIME_332US = 2
  • BrickletVoltageCurrentV2.CONVERSION_TIME_588US = 3
  • BrickletVoltageCurrentV2.CONVERSION_TIME_1_1MS = 4
  • BrickletVoltageCurrentV2.CONVERSION_TIME_2_116MS = 5
  • BrickletVoltageCurrentV2.CONVERSION_TIME_4_156MS = 6
  • BrickletVoltageCurrentV2.CONVERSION_TIME_8_244MS = 7
BrickletVoltageCurrentV2.GetConfiguration() → averaging, voltageConversionTime, currentConversionTime
Output:
  • averaging – Type: Byte, Range: See constants, Default: 3
  • voltageConversionTime – Type: Byte, Range: See constants, Default: 4
  • currentConversionTime – Type: Byte, Range: See constants, Default: 4

Returns the configuration as set by SetConfiguration().

The following constants are available for this function:

For averaging:

  • BrickletVoltageCurrentV2.AVERAGING_1 = 0
  • BrickletVoltageCurrentV2.AVERAGING_4 = 1
  • BrickletVoltageCurrentV2.AVERAGING_16 = 2
  • BrickletVoltageCurrentV2.AVERAGING_64 = 3
  • BrickletVoltageCurrentV2.AVERAGING_128 = 4
  • BrickletVoltageCurrentV2.AVERAGING_256 = 5
  • BrickletVoltageCurrentV2.AVERAGING_512 = 6
  • BrickletVoltageCurrentV2.AVERAGING_1024 = 7

For voltageConversionTime:

  • BrickletVoltageCurrentV2.CONVERSION_TIME_140US = 0
  • BrickletVoltageCurrentV2.CONVERSION_TIME_204US = 1
  • BrickletVoltageCurrentV2.CONVERSION_TIME_332US = 2
  • BrickletVoltageCurrentV2.CONVERSION_TIME_588US = 3
  • BrickletVoltageCurrentV2.CONVERSION_TIME_1_1MS = 4
  • BrickletVoltageCurrentV2.CONVERSION_TIME_2_116MS = 5
  • BrickletVoltageCurrentV2.CONVERSION_TIME_4_156MS = 6
  • BrickletVoltageCurrentV2.CONVERSION_TIME_8_244MS = 7

For currentConversionTime:

  • BrickletVoltageCurrentV2.CONVERSION_TIME_140US = 0
  • BrickletVoltageCurrentV2.CONVERSION_TIME_204US = 1
  • BrickletVoltageCurrentV2.CONVERSION_TIME_332US = 2
  • BrickletVoltageCurrentV2.CONVERSION_TIME_588US = 3
  • BrickletVoltageCurrentV2.CONVERSION_TIME_1_1MS = 4
  • BrickletVoltageCurrentV2.CONVERSION_TIME_2_116MS = 5
  • BrickletVoltageCurrentV2.CONVERSION_TIME_4_156MS = 6
  • BrickletVoltageCurrentV2.CONVERSION_TIME_8_244MS = 7

Advanced Functions

BrickletVoltageCurrentV2.SetCalibration(voltageMultiplier, voltageDivisor, currentMultiplier, currentDivisor)
Input:
  • voltageMultiplier – Type: Int32, Range: [0 to 216 - 1]
  • voltageDivisor – Type: Int32, Range: [0 to 216 - 1]
  • currentMultiplier – Type: Int32, Range: [0 to 216 - 1]
  • currentDivisor – Type: Int32, Range: [0 to 216 - 1]

Since the ADC and the shunt resistor used for the measurements are not perfect they need to be calibrated by a multiplier and a divisor if a very precise reading is needed.

For example, if you are expecting a current of 1000mA and you are measuring 1023mA, you can calibrate the Voltage/Current Bricklet by setting the current multiplier to 1000 and the divisor to 1023. The same applies for the voltage.

The calibration will be saved on the EEPROM of the Voltage/Current Bricklet and only needs to be done once.

BrickletVoltageCurrentV2.GetCalibration() → voltageMultiplier, voltageDivisor, currentMultiplier, currentDivisor
Output:
  • voltageMultiplier – Type: Int32, Range: [0 to 216 - 1]
  • voltageDivisor – Type: Int32, Range: [0 to 216 - 1]
  • currentMultiplier – Type: Int32, Range: [0 to 216 - 1]
  • currentDivisor – Type: Int32, Range: [0 to 216 - 1]

Returns the calibration as set by SetCalibration().

BrickletVoltageCurrentV2.GetSPITFPErrorCount() → errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow
Output:
  • errorCountAckChecksum – Type: Int64, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: Int64, Range: [0 to 232 - 1]
  • errorCountFrame – Type: Int64, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: Int64, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

BrickletVoltageCurrentV2.SetBootloaderMode(mode) → status
Input:
  • mode – Type: Byte, Range: See constants
Output:
  • status – Type: Byte, Range: See constants

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

  • BrickletVoltageCurrentV2.BOOTLOADER_STATUS_OK = 0
  • BrickletVoltageCurrentV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletVoltageCurrentV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletVoltageCurrentV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletVoltageCurrentV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletVoltageCurrentV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletVoltageCurrentV2.GetBootloaderMode() → mode
Output:
  • mode – Type: Byte, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

For mode:

  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletVoltageCurrentV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletVoltageCurrentV2.SetWriteFirmwarePointer(pointer)
Input:
  • pointer – Type: Int64, Unit: 1 B, Range: [0 to 232 - 1]

Sets the firmware pointer for WriteFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletVoltageCurrentV2.WriteFirmware(data) → status
Input:
  • data – Type: Byte[64], Range: [0 to 255]
Output:
  • status – Type: Byte, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletVoltageCurrentV2.SetStatusLEDConfig(config)
Input:
  • config – Type: Byte, Range: See constants, Default: 3

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_ON = 1
  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletVoltageCurrentV2.GetStatusLEDConfig() → config
Output:
  • config – Type: Byte, Range: See constants, Default: 3

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

For config:

  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_ON = 1
  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletVoltageCurrentV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletVoltageCurrentV2.GetChipTemperature() → temperature
Output:
  • temperature – Type: Int16, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

BrickletVoltageCurrentV2.Reset()

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletVoltageCurrentV2.WriteUID(uid)
Input:
  • uid – Type: Int64, Range: [0 to 232 - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletVoltageCurrentV2.ReadUID() → uid
Output:
  • uid – Type: Int64, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

BrickletVoltageCurrentV2.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Output:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: Char, Range: ["a" to "h", "i", "z"]
  • hardwareVersion – Type: Byte[3]
    • 0: major – Type: Byte, Range: [0 to 255]
    • 1: minor – Type: Byte, Range: [0 to 255]
    • 2: revision – Type: Byte, Range: [0 to 255]
  • firmwareVersion – Type: Byte[3]
    • 0: major – Type: Byte, Range: [0 to 255]
    • 1: minor – Type: Byte, Range: [0 to 255]
    • 2: revision – Type: Byte, Range: [0 to 255]
  • deviceIdentifier – Type: Int32, Range: [0 to 216 - 1]

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

BrickletVoltageCurrentV2.SetCurrentCallbackConfiguration(period, valueHasToChange, option, min, max)
Input:
  • period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: Boolean, Default: F
  • option – Type: Char, Range: See constants, Default: "x"
  • min – Type: Int32, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Int32, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0

The period is the period with which the CurrentCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CurrentCallback callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OFF = "x"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_GREATER = ">"
BrickletVoltageCurrentV2.GetCurrentCallbackConfiguration() → period, valueHasToChange, option, min, max
Output:
  • period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: Boolean, Default: F
  • option – Type: Char, Range: See constants, Default: "x"
  • min – Type: Int32, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Int32, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by SetCurrentCallbackConfiguration().

The following constants are available for this function:

For option:

  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OFF = "x"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_GREATER = ">"
BrickletVoltageCurrentV2.SetVoltageCallbackConfiguration(period, valueHasToChange, option, min, max)
Input:
  • period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: Boolean, Default: F
  • option – Type: Char, Range: See constants, Default: "x"
  • min – Type: Int32, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Int32, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0

The period is the period with which the VoltageCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the VoltageCallback callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OFF = "x"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_GREATER = ">"
BrickletVoltageCurrentV2.GetVoltageCallbackConfiguration() → period, valueHasToChange, option, min, max
Output:
  • period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: Boolean, Default: F
  • option – Type: Char, Range: See constants, Default: "x"
  • min – Type: Int32, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Int32, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by SetVoltageCallbackConfiguration().

The following constants are available for this function:

For option:

  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OFF = "x"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_GREATER = ">"
BrickletVoltageCurrentV2.SetPowerCallbackConfiguration(period, valueHasToChange, option, min, max)
Input:
  • period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: Boolean, Default: F
  • option – Type: Char, Range: See constants, Default: "x"
  • min – Type: Int32, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Int32, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0

The period is the period with which the PowerCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the PowerCallback callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OFF = "x"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_GREATER = ">"
BrickletVoltageCurrentV2.GetPowerCallbackConfiguration() → period, valueHasToChange, option, min, max
Output:
  • period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: Boolean, Default: F
  • option – Type: Char, Range: See constants, Default: "x"
  • min – Type: Int32, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Int32, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by SetPowerCallbackConfiguration().

The following constants are available for this function:

For option:

  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OFF = "x"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletVoltageCurrentV2.THRESHOLD_OPTION_GREATER = ">"

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 BrickletVoltageCurrentV2.CurrentCallback → sender, current
Callback Output:
  • sender – Type: .NET Refnum (BrickletVoltageCurrentV2)
  • current – Type: Int32, Unit: 1 mA, Range: [-20000 to 20000]

This callback is triggered periodically according to the configuration set by SetCurrentCallbackConfiguration().

The parameter is the same as GetCurrent().

event BrickletVoltageCurrentV2.VoltageCallback → sender, voltage
Callback Output:
  • sender – Type: .NET Refnum (BrickletVoltageCurrentV2)
  • voltage – Type: Int32, Unit: 1 mV, Range: [0 to 36000]

This callback is triggered periodically according to the configuration set by SetVoltageCallbackConfiguration().

The parameter is the same as GetVoltage().

event BrickletVoltageCurrentV2.PowerCallback → sender, power
Callback Output:
  • sender – Type: .NET Refnum (BrickletVoltageCurrentV2)
  • power – Type: Int32, Unit: 1 mW, Range: [0 to 720000]

This callback is triggered periodically according to the configuration set by SetPowerCallbackConfiguration().

The parameter is the same as GetPower().

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletVoltageCurrentV2.GetAPIVersion() → apiVersion
Output:
  • apiVersion – Type: Byte[3]
    • 0: major – Type: Byte, Range: [0 to 255]
    • 1: minor – Type: Byte, Range: [0 to 255]
    • 2: revision – Type: Byte, Range: [0 to 255]

Returns the version of the API definition 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.

BrickletVoltageCurrentV2.GetResponseExpected(functionId) → responseExpected
Input:
  • functionId – Type: Byte, Range: See constants
Output:
  • responseExpected – Type: 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.

The following constants are available for this function:

For functionId:

  • BrickletVoltageCurrentV2.FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
  • BrickletVoltageCurrentV2.FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 6
  • BrickletVoltageCurrentV2.FUNCTION_SET_POWER_CALLBACK_CONFIGURATION = 10
  • BrickletVoltageCurrentV2.FUNCTION_SET_CONFIGURATION = 13
  • BrickletVoltageCurrentV2.FUNCTION_SET_CALIBRATION = 15
  • BrickletVoltageCurrentV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletVoltageCurrentV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletVoltageCurrentV2.FUNCTION_RESET = 243
  • BrickletVoltageCurrentV2.FUNCTION_WRITE_UID = 248
BrickletVoltageCurrentV2.SetResponseExpected(functionId, responseExpected)
Input:
  • functionId – Type: Byte, Range: See constants
  • responseExpected – Type: 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 constants are available for this function:

For functionId:

  • BrickletVoltageCurrentV2.FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
  • BrickletVoltageCurrentV2.FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 6
  • BrickletVoltageCurrentV2.FUNCTION_SET_POWER_CALLBACK_CONFIGURATION = 10
  • BrickletVoltageCurrentV2.FUNCTION_SET_CONFIGURATION = 13
  • BrickletVoltageCurrentV2.FUNCTION_SET_CALIBRATION = 15
  • BrickletVoltageCurrentV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletVoltageCurrentV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletVoltageCurrentV2.FUNCTION_RESET = 243
  • BrickletVoltageCurrentV2.FUNCTION_WRITE_UID = 248
BrickletVoltageCurrentV2.SetResponseExpectedAll(responseExpected)
Input:
  • responseExpected – Type: Boolean

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

Constants

BrickletVoltageCurrentV2.DEVICE_IDENTIFIER

This constant is used to identify a Voltage/Current Bricklet 2.0.

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.

BrickletVoltageCurrentV2.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Voltage/Current Bricklet 2.0.