This is the description of the Shell 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 Shell API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 9 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
# get current current and voltage (unit is mA and mV)
tinkerforge call voltage-current-bricklet $uid get-current
tinkerforge call voltage-current-bricklet $uid get-voltage
|
Download (example-callback.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
# set period for illuminance callback to 1s (1000ms)
# note: the illuminance callback is only called every second if the
# illuminance has changed since the last call!
tinkerforge call voltage-current-bricklet $uid set-current-callback-period 1000
# handle incoming illuminance callbacks (unit is mA)
tinkerforge dispatch voltage-current-bricklet $uid current
|
Download (example-threshold.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
# get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call voltage-current-bricklet $uid set-debounce-period 10000
# configure threshold for "greater than 1A" (unit is mA)
tinkerforge call voltage-current-bricklet $uid set-current-callback-threshold greater 1000 0
# handle incoming current-reached callbacks (unit is mA)
tinkerforge dispatch voltage-current-bricklet $uid current-reached\
--execute "echo Current is greater than 1A: {current} mA"
|
Possible exit codes for all tinkerforge commands are:
The common options of the call and dispatch commands are documented here. The specific command structure is shown below.
Parameters: |
|
---|
The call command is used to call a function of the Voltage/Current Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the Voltage/Current Bricklet. It can take several options:
Parameters: |
|
---|
The <function> to be called can take different options depending of its kind. All functions can take the following options:
Getter functions can take the following options:
Setter functions can take the following options:
The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is send and errors are silently ignored, because they cannot be detected.
Parameters: |
|
---|
The <callback> to be dispatched can take several options:
Output: |
|
---|
Returns the current. The value is in mA and between -20000mA and 20000mA.
If you want to get the current periodically, it is recommended to use the callback current and set the period with set-current-callback-period.
Output: |
|
---|
Returns the voltage. The value is in mV and between 0mV and 36000mV.
If you want to get the voltage periodically, it is recommended to use the callback voltage and set the period with set-voltage-callback-period.
Output: |
|
---|
Returns the power. The value is in mW and between 0mV and 720000mW.
If you want to get the power periodically, it is recommended to use the callback power and set the period with set-power-callback-period.
Parameters: |
|
---|---|
Output: | no output |
Sets the configuration of the Voltage/Current Bricklet. It is possible to configure number of averages as well as voltage and current conversion time.
Averaging:
Value | Number of Averages |
---|---|
0 | 1 |
1 | 4 |
2 | 16 |
3 | 64 |
4 | 128 |
5 | 256 |
6 | 512 |
>=7 | 1024 |
Voltage/Current conversion:
Value | Conversion time |
---|---|
0 | 140µs |
1 | 204µs |
2 | 332µs |
3 | 588µs |
4 | 1.1ms |
5 | 2.116ms |
6 | 4.156ms |
>=7 | 8.244ms |
The default values are 3, 4 and 4 (64, 1.1ms, 1.1ms) for averaging, voltage conversion and current conversion.
The following symbols are available for this function:
Output: |
|
---|
Returns the configuration as set by set-configuration.
The following symbols are available for this function:
Parameters: |
|
---|---|
Output: | no output |
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.
Output: |
|
---|
Returns the calibration as set by set-calibration.
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' or 'd'.
The device identifier numbers can be found here.
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the current callback is triggered periodically. A value of 0 turns the callback off.
current is only triggered if the current has changed since the last triggering.
The default value is 0.
Output: |
|
---|
Returns the period as set by set-current-callback-period.
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the voltage callback is triggered periodically. A value of 0 turns the callback off.
voltage is only triggered if the voltage has changed since the last triggering.
The default value is 0.
Output: |
|
---|
Returns the period as set by set-voltage-callback-period.
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the power callback is triggered periodically. A value of 0 turns the callback off.
power is only triggered if the power has changed since the last triggering.
The default value is 0.
Output: |
|
---|
Returns the period as set by get-power-callback-period.
Parameters: |
|
---|---|
Output: | no output |
Sets the thresholds for the current-reached 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 symbols are available for this function:
Output: |
|
---|
Returns the threshold as set by set-current-callback-threshold.
The following symbols are available for this function:
Parameters: |
|
---|---|
Output: | no output |
Sets the thresholds for the voltage-reached 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 default value is ('x', 0, 0).
The following symbols are available for this function:
Output: |
|
---|
Returns the threshold as set by set-voltage-callback-threshold.
The following symbols are available for this function:
Parameters: |
|
---|---|
Output: | no output |
Sets the thresholds for the power-reached 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 default value is ('x', 0, 0).
The following symbols are available for this function:
Output: |
|
---|
Returns the threshold as set by set-power-callback-threshold.
The following symbols are available for this function:
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the threshold callbacks
are triggered, if the thresholds
keep being reached.
The default value is 100.
Output: |
|
---|
Returns the debounce period as set by set-debounce-period.
Callbacks can be used to receive time critical or recurring data from the device:
tinkerforge dispatch voltage-current-bricklet <uid> example
The available callbacks 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.
Output: |
|
---|
This callback is triggered periodically with the period that is set by set-current-callback-period. The parameter is the current of the sensor.
current is only triggered if the current has changed since the last triggering.
Output: |
|
---|
This callback is triggered periodically with the period that is set by set-voltage-callback-period. The parameter is the voltage of the sensor.
voltage is only triggered if the voltage has changed since the last triggering.
Output: |
|
---|
This callback is triggered periodically with the period that is set by set-power-callback-period. The parameter is the power of the sensor.
power is only triggered if the power has changed since the last triggering.
Output: |
|
---|
This callback is triggered when the threshold as set by set-current-callback-threshold 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 set-debounce-period.
Output: |
|
---|
This callback is triggered when the threshold as set by set-voltage-callback-threshold 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 set-debounce-period.
Output: |
|
---|
This callback is triggered when the threshold as set by set-power-callback-threshold 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 set-debounce-period.