Shell - Voltage/Current Bricklet¶

Simple¶

Download (example-simple.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Voltage/Current Bricklet

# Get current voltage
tinkerforge call voltage-current-bricklet $uid get-voltage

# Get current current
tinkerforge call voltage-current-bricklet $uid get-current

Callback¶

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Voltage/Current Bricklet

# Handle incoming current callbacks
tinkerforge dispatch voltage-current-bricklet $uid current &

# Set period for current callback to 1s (1000ms)
# Note: The current callback is only called every second
#       if the current has changed since the last call!
tinkerforge call voltage-current-bricklet $uid set-current-callback-period 1000

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Threshold¶

Download (example-threshold.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Voltage/Current Bricklet

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call voltage-current-bricklet $uid set-debounce-period 10000

# Handle incoming power reached callbacks
tinkerforge dispatch voltage-current-bricklet $uid power-reached &

# Configure threshold for power "greater than 10 W"
tinkerforge call voltage-current-bricklet $uid set-power-callback-threshold threshold-option-greater 10000 0

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Command Structure¶

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call voltage-current-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The call command is used to call a function of the Voltage/Current Bricklet. It can take several options:

• --help shows help for the specific call command and exits
• --list-functions shows a list of known functions of the Voltage/Current Bricklet and exits

tinkerforge dispatch voltage-current-bricklet [<option>..] <uid> <callback>¶

Parameters:	<uid> – Type: String <callback> – Type: String

The dispatch command is used to dispatch a callback of the Voltage/Current Bricklet. It can take several options:

• --help shows help for the specific dispatch command and exits
• --list-callbacks shows a list of known callbacks of the Voltage/Current Bricklet and exits

tinkerforge call voltage-current-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The <function> to be called can take different options depending of its kind. All functions can take the following options:

• --help shows help for the specific function and exits

Getter functions can take the following options:

• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

• --expect-response requests response and waits for it

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 sent and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch voltage-current-bricklet <uid> <callback> [<option>..]¶

Parameters:	<uid> – Type: String <callback> – Type: String

The <callback> to be dispatched can take several options:

• --help shows help for the specific callback and exits
• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions¶

tinkerforge call voltage-current-bricklet <uid> get-current¶

Output:	current – Type: Int, Unit: 1 mA, Range: [-20000 to 20000]

Returns the current.

If you want to get the current periodically, it is recommended to use the current callback and set the period with set-current-callback-period.

tinkerforge call voltage-current-bricklet <uid> get-voltage¶

Output:	voltage – Type: Int, Unit: 1 mV, Range: [0 to 36000]

Returns the voltage.

If you want to get the voltage periodically, it is recommended to use the voltage callback and set the period with set-voltage-callback-period.

tinkerforge call voltage-current-bricklet <uid> get-power¶

Output:	power – Type: Int, Unit: 1 mW, Range: [0 to 720000]

Returns the power.

If you want to get the power periodically, it is recommended to use the power callback and set the period with set-power-callback-period.

tinkerforge call voltage-current-bricklet <uid> set-configuration <averaging> <voltage-conversion-time> <current-conversion-time>¶

Parameters:	<averaging> – Type: Int, Range: See symbols, Default: 3 <voltage-conversion-time> – Type: Int, Range: See symbols, Default: 4 <current-conversion-time> – Type: Int, Range: See symbols, Default: 4
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.

The following symbols are available for this function:

For <averaging>:

• averaging-1 = 0
• averaging-4 = 1
• averaging-16 = 2
• averaging-64 = 3
• averaging-128 = 4
• averaging-256 = 5
• averaging-512 = 6
• averaging-1024 = 7

For <voltage-conversion-time>:

• conversion-time-140us = 0
• conversion-time-204us = 1
• conversion-time-332us = 2
• conversion-time-588us = 3
• conversion-time-1-1ms = 4
• conversion-time-2-116ms = 5
• conversion-time-4-156ms = 6
• conversion-time-8-244ms = 7

For <current-conversion-time>:

• conversion-time-140us = 0
• conversion-time-204us = 1
• conversion-time-332us = 2
• conversion-time-588us = 3
• conversion-time-1-1ms = 4
• conversion-time-2-116ms = 5
• conversion-time-4-156ms = 6
• conversion-time-8-244ms = 7

tinkerforge call voltage-current-bricklet <uid> get-configuration¶

Output:	averaging – Type: Int, Range: See symbols, Default: 3 voltage-conversion-time – Type: Int, Range: See symbols, Default: 4 current-conversion-time – Type: Int, Range: See symbols, Default: 4

Returns the configuration as set by set-configuration.

The following symbols are available for this function:

For averaging:

• averaging-1 = 0
• averaging-4 = 1
• averaging-16 = 2
• averaging-64 = 3
• averaging-128 = 4
• averaging-256 = 5
• averaging-512 = 6
• averaging-1024 = 7

For voltage-conversion-time:

• conversion-time-140us = 0
• conversion-time-204us = 1
• conversion-time-332us = 2
• conversion-time-588us = 3
• conversion-time-1-1ms = 4
• conversion-time-2-116ms = 5
• conversion-time-4-156ms = 6
• conversion-time-8-244ms = 7

For current-conversion-time:

• conversion-time-140us = 0
• conversion-time-204us = 1
• conversion-time-332us = 2
• conversion-time-588us = 3
• conversion-time-1-1ms = 4
• conversion-time-2-116ms = 5
• conversion-time-4-156ms = 6
• conversion-time-8-244ms = 7

Advanced Functions¶

tinkerforge call voltage-current-bricklet <uid> set-calibration <gain-multiplier> <gain-divisor>¶

Parameters:	<gain-multiplier> – Type: Int, Range: [0 to 216 - 1] <gain-divisor> – Type: Int, Range: [0 to 216 - 1]
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.

tinkerforge call voltage-current-bricklet <uid> get-calibration¶

Output:	gain-multiplier – Type: Int, Range: [0 to 216 - 1] gain-divisor – Type: Int, Range: [0 to 216 - 1]

Returns the calibration as set by set-calibration.

tinkerforge call voltage-current-bricklet <uid> get-identity¶

Output:

uid – Type: String, Length: up to 8 connected-uid – Type: String, Length: up to 8 position – Type: Char, Range: [a to h, z] hardware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] firmware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] device-identifier – Type: Int, 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). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. 

Callback Configuration Functions¶

tinkerforge call voltage-current-bricklet <uid> set-current-callback-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

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

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

tinkerforge call voltage-current-bricklet <uid> get-current-callback-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-current-callback-period.

tinkerforge call voltage-current-bricklet <uid> set-voltage-callback-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

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

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

tinkerforge call voltage-current-bricklet <uid> get-voltage-callback-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-voltage-callback-period.

tinkerforge call voltage-current-bricklet <uid> set-power-callback-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

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

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

tinkerforge call voltage-current-bricklet <uid> get-power-callback-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by get-power-callback-period.

tinkerforge call voltage-current-bricklet <uid> set-current-callback-threshold <option> <min> <max>¶

Parameters:	<option> – Type: Char, Range: See symbols, Default: x <min> – Type: Int, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0 <max> – Type: Int, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0
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 following symbols are available for this function:

For <option>:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call voltage-current-bricklet <uid> get-current-callback-threshold¶

Output:	option – Type: Char, Range: See symbols, Default: x min – Type: Int, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0 max – Type: Int, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by set-current-callback-threshold.

The following symbols are available for this function:

For option:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call voltage-current-bricklet <uid> set-voltage-callback-threshold <option> <min> <max>¶

Parameters:	<option> – Type: Char, Range: See symbols, Default: x <min> – Type: Int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0 <max> – Type: Int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0
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 following symbols are available for this function:

For <option>:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call voltage-current-bricklet <uid> get-voltage-callback-threshold¶

Output:	option – Type: Char, Range: See symbols, Default: x min – Type: Int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0 max – Type: Int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by set-voltage-callback-threshold.

The following symbols are available for this function:

For option:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call voltage-current-bricklet <uid> set-power-callback-threshold <option> <min> <max>¶

Parameters:	<option> – Type: Char, Range: See symbols, Default: x <min> – Type: Int, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0 <max> – Type: Int, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0
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 following symbols are available for this function:

For <option>:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call voltage-current-bricklet <uid> get-power-callback-threshold¶

Output:	option – Type: Char, Range: See symbols, Default: x min – Type: Int, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0 max – Type: Int, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by set-power-callback-threshold.

The following symbols are available for this function:

For option:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call voltage-current-bricklet <uid> set-debounce-period <debounce>¶

Parameters:	<debounce> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Output:	no output

Sets the period with which the threshold callbacks

• current-reached,
• voltage-reached,
• power-reached

are triggered, if the thresholds

• set-current-callback-threshold,
• set-voltage-callback-threshold,
• set-power-callback-threshold

keep being reached.

tinkerforge call voltage-current-bricklet <uid> get-debounce-period¶

Output:	debounce – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by set-debounce-period.

Callbacks¶

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.

tinkerforge dispatch voltage-current-bricklet <uid> current¶

Output:	current – Type: Int, Unit: 1 mA, Range: [-20000 to 20000]

This callback is triggered periodically with the period that is set by set-current-callback-period. The parameter is the current of the sensor.

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

tinkerforge dispatch voltage-current-bricklet <uid> voltage¶

Output:	voltage – Type: Int, Unit: 1 mV, Range: [0 to 36000]

This callback is triggered periodically with the period that is set by set-voltage-callback-period. The parameter is the voltage of the sensor.

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

tinkerforge dispatch voltage-current-bricklet <uid> power¶

Output:	power – Type: Int, Unit: 1 mW, Range: [0 to 720000]

This callback is triggered periodically with the period that is set by set-power-callback-period. The parameter is the power of the sensor.

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

tinkerforge dispatch voltage-current-bricklet <uid> current-reached¶

Output:	current – Type: Int, Unit: 1 mA, Range: [-20000 to 20000]

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.

tinkerforge dispatch voltage-current-bricklet <uid> voltage-reached¶

Output:	voltage – Type: Int, Unit: 1 mV, Range: [0 to 36000]

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.

tinkerforge dispatch voltage-current-bricklet <uid> power-reached¶

Output:	power – Type: Int, Unit: 1 mA, Range: [-20000 to 20000]

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.