This is the description of the LabVIEW API bindings for the Voltage/Current Bricklet. General information and technical specifications for the Voltage/Current Bricklet are summarized in its hardware description.
An installation guide for the LabVIEW API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
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.*
.
BrickletVoltageCurrent
(uid, ipcon) → voltageCurrent¶Input: |
|
---|---|
Output: |
|
Creates an object with the unique device ID uid
.
This object can then be used after the IP Connection is connected.
BrickletVoltageCurrent.
GetCurrent
() → current¶Output: |
|
---|
Returns the current.
If you want to get the current periodically, it is recommended to use the
CurrentCallback
callback and set the period with
SetCurrentCallbackPeriod()
.
BrickletVoltageCurrent.
GetVoltage
() → voltage¶Output: |
|
---|
Returns the voltage.
If you want to get the voltage periodically, it is recommended to use the
VoltageCallback
callback and set the period with
SetVoltageCallbackPeriod()
.
BrickletVoltageCurrent.
GetPower
() → power¶Output: |
|
---|
Returns the power.
If you want to get the power periodically, it is recommended to use the
PowerCallback
callback and set the period with
SetPowerCallbackPeriod()
.
BrickletVoltageCurrent.
SetConfiguration
(averaging, voltageConversionTime, currentConversionTime)¶Input: |
|
---|
Sets the configuration of the Voltage/Current Bricklet. 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:
For voltageConversionTime:
For currentConversionTime:
BrickletVoltageCurrent.
GetConfiguration
() → averaging, voltageConversionTime, currentConversionTime¶Output: |
|
---|
Returns the configuration as set by SetConfiguration()
.
The following constants are available for this function:
For averaging:
For voltageConversionTime:
For currentConversionTime:
BrickletVoltageCurrent.
SetCalibration
(gainMultiplier, gainDivisor)¶Input: |
|
---|
Since the shunt resistor that is used to measure the current is not perfectly precise, it needs to be calibrated by a multiplier and divisor if a very precise reading is needed.
For example, if you are expecting a measurement of 1000mA and you are measuring 1023mA, you can calibrate the Voltage/Current Bricklet by setting the multiplier to 1000 and the divisor to 1023.
BrickletVoltageCurrent.
GetCalibration
() → gainMultiplier, gainDivisor¶Output: |
|
---|
Returns the calibration as set by SetCalibration()
.
BrickletVoltageCurrent.
GetIdentity
() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier¶Output: |
|
---|
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). A Bricklet connected to an Isolator Bricklet is always at position 'z'.
The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.
BrickletVoltageCurrent.
SetCurrentCallbackPeriod
(period)¶Input: |
|
---|
Sets the period 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.
BrickletVoltageCurrent.
GetCurrentCallbackPeriod
() → period¶Output: |
|
---|
Returns the period as set by SetCurrentCallbackPeriod()
.
BrickletVoltageCurrent.
SetVoltageCallbackPeriod
(period)¶Input: |
|
---|
Sets the period with which the VoltageCallback
callback is triggered
periodically. A value of 0 turns the callback off.
The VoltageCallback
callback is only triggered if the voltage has changed since
the last triggering.
BrickletVoltageCurrent.
GetVoltageCallbackPeriod
() → period¶Output: |
|
---|
Returns the period as set by SetVoltageCallbackPeriod()
.
BrickletVoltageCurrent.
SetPowerCallbackPeriod
(period)¶Input: |
|
---|
Sets the period with which the PowerCallback
callback is triggered
periodically. A value of 0 turns the callback off.
The PowerCallback
callback is only triggered if the power has changed since the
last triggering.
BrickletVoltageCurrent.
GetPowerCallbackPeriod
() → period¶Output: |
|
---|
Returns the period as set by GetPowerCallbackPeriod()
.
BrickletVoltageCurrent.
SetCurrentCallbackThreshold
(option, min, max)¶Input: |
|
---|
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 following constants are available for this function:
For option:
BrickletVoltageCurrent.
GetCurrentCallbackThreshold
() → option, min, max¶Output: |
|
---|
Returns the threshold as set by SetCurrentCallbackThreshold()
.
The following constants are available for this function:
For option:
BrickletVoltageCurrent.
SetVoltageCallbackThreshold
(option, min, max)¶Input: |
|
---|
Sets the thresholds for the VoltageReachedCallback
callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the voltage is outside the min and max values |
'i' | Callback is triggered when the voltage is inside the min and max values |
'<' | Callback is triggered when the voltage is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the voltage is greater than the min value (max is ignored) |
The following constants are available for this function:
For option:
BrickletVoltageCurrent.
GetVoltageCallbackThreshold
() → option, min, max¶Output: |
|
---|
Returns the threshold as set by SetVoltageCallbackThreshold()
.
The following constants are available for this function:
For option:
BrickletVoltageCurrent.
SetPowerCallbackThreshold
(option, min, max)¶Input: |
|
---|
Sets the thresholds for the PowerReachedCallback
callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the power is outside the min and max values |
'i' | Callback is triggered when the power is inside the min and max values |
'<' | Callback is triggered when the power is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the power is greater than the min value (max is ignored) |
The following constants are available for this function:
For option:
BrickletVoltageCurrent.
GetPowerCallbackThreshold
() → option, min, max¶Output: |
|
---|
Returns the threshold as set by SetPowerCallbackThreshold()
.
The following constants are available for this function:
For option:
BrickletVoltageCurrent.
SetDebouncePeriod
(debounce)¶Input: |
|
---|
Sets the period with which the threshold callbacks
are triggered, if the thresholds
keep being reached.
BrickletVoltageCurrent.
GetDebouncePeriod
() → debounce¶Output: |
|
---|
Returns the debounce period as set by SetDebouncePeriod()
.
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.
BrickletVoltageCurrent.
CurrentCallback
→ sender, current¶Callback Output: |
|
---|
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.
BrickletVoltageCurrent.
VoltageCallback
→ sender, voltage¶Callback Output: |
|
---|
This callback is triggered periodically with the period that is set by
SetVoltageCallbackPeriod()
. The parameter is the voltage of
the sensor.
The VoltageCallback
callback is only triggered if the voltage has changed since
the last triggering.
BrickletVoltageCurrent.
PowerCallback
→ sender, power¶Callback Output: |
|
---|
This callback is triggered periodically with the period that is set by
SetPowerCallbackPeriod()
. The parameter is the power of the
sensor.
The PowerCallback
callback is only triggered if the power has changed since the
last triggering.
BrickletVoltageCurrent.
CurrentReachedCallback
→ sender, current¶Callback Output: |
|
---|
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()
.
BrickletVoltageCurrent.
VoltageReachedCallback
→ sender, voltage¶Callback Output: |
|
---|
This callback is triggered when the threshold as set by
SetVoltageCallbackThreshold()
is reached.
The parameter is the voltage of the sensor.
If the threshold keeps being reached, the callback is triggered periodically
with the period as set by SetDebouncePeriod()
.
BrickletVoltageCurrent.
PowerReachedCallback
→ sender, power¶Callback Output: |
|
---|
This callback is triggered when the threshold as set by
SetPowerCallbackThreshold()
is reached.
The parameter is the power of the sensor.
If the threshold keeps being reached, the callback is triggered periodically
with the period as set by SetDebouncePeriod()
.
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.
BrickletVoltageCurrent.
GetAPIVersion
() → apiVersion¶Output: |
|
---|
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.
BrickletVoltageCurrent.
GetResponseExpected
(functionId) → responseExpected¶Input: |
|
---|---|
Output: |
|
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 sent and errors are silently ignored, because they cannot be detected.
The following constants are available for this function:
For functionId:
BrickletVoltageCurrent.
SetResponseExpected
(functionId, responseExpected)¶Input: |
|
---|
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 sent and errors are silently ignored, because they cannot be detected.
The following constants are available for this function:
For functionId:
BrickletVoltageCurrent.
SetResponseExpectedAll
(responseExpected)¶Input: |
|
---|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
BrickletVoltageCurrent.
DEVICE_IDENTIFIER
¶This constant is used to identify a Voltage/Current 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.
BrickletVoltageCurrent.
DEVICE_DISPLAY_NAME
¶This constant represents the human readable name of a Voltage/Current Bricklet.