Shell - Current12 Bricklet¶

Simple¶

Download (example-simple.sh)

1
2
3
4
5
6
7

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

uid=XYZ # Change XYZ to the UID of your Current12 Bricklet

# Get current current
tinkerforge call current12-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 Current12 Bricklet

# Handle incoming current callbacks
tinkerforge dispatch current12-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 current12-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 Current12 Bricklet

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

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

# Configure threshold for current "greater than 5 A"
tinkerforge call current12-bricklet $uid set-current-callback-threshold threshold-option-greater 5000 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 current12-bricklet [<option>..] <uid> <function> [<argument>..]¶

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

The call command is used to call a function of the Current12 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 Current12 Bricklet and exits

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

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

The dispatch command is used to dispatch a callback of the Current12 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 Current12 Bricklet and exits

tinkerforge call current12-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 current12-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 current12-bricklet <uid> get-current¶

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

Returns the current of the sensor.

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.

Advanced Functions¶

tinkerforge call current12-bricklet <uid> calibrate¶

Output:	no output

Calibrates the 0 value of the sensor. You have to call this function when there is no current present.

The zero point of the current sensor is depending on the exact properties of the analog-to-digital converter, the length of the Bricklet cable and the temperature. Thus, if you change the Brick or the environment in which the Bricklet is used, you might have to recalibrate.

The resulting calibration will be saved on the EEPROM of the Current Bricklet.

tinkerforge call current12-bricklet <uid> is-over-current¶

Output:	over – Type: Bool

Returns true if more than 12.5A were measured.

Note

To reset this value you have to power cycle the Bricklet.

tinkerforge call current12-bricklet <uid> get-analog-value¶

Output:	value – Type: Int, Range: [0 to 212 - 1]

Returns the value as read by a 12-bit analog-to-digital converter.

Note

The value returned by get-current is averaged over several samples to yield less noise, while get-analog-value gives back raw unfiltered analog values. The only reason to use get-analog-value is, if you need the full resolution of the analog-to-digital converter.

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

tinkerforge call current12-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 current12-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 current12-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 current12-bricklet <uid> set-analog-value-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 analog-value callback is triggered periodically. A value of 0 turns the callback off.

The analog-value callback is only triggered if the analog value has changed since the last triggering.

tinkerforge call current12-bricklet <uid> get-analog-value-callback-period¶

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

Returns the period as set by set-analog-value-callback-period.

tinkerforge call current12-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: [-215 to 215 - 1], Default: 0 <max> – Type: Int, Unit: 1 mA, Range: [-215 to 215 - 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 current12-bricklet <uid> get-current-callback-threshold¶

Output:	option – Type: Char, Range: See symbols, Default: x min – Type: Int, Unit: 1 mA, Range: [-215 to 215 - 1], Default: 0 max – Type: Int, Unit: 1 mA, Range: [-215 to 215 - 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 current12-bricklet <uid> set-analog-value-callback-threshold <option> <min> <max>¶

Parameters:	<option> – Type: Char, Range: See symbols, Default: x <min> – Type: Int, Range: [0 to 216 - 1], Default: 0 <max> – Type: Int, Range: [0 to 216 - 1], Default: 0
Output:	no output

Sets the thresholds for the analog-value-reached callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the analog value is outside the min and max values
'i'	Callback is triggered when the analog value is inside the min and max values
'<'	Callback is triggered when the analog value is smaller than the min value (max is ignored)
'>'	Callback is triggered when the analog value 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 current12-bricklet <uid> get-analog-value-callback-threshold¶

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

Returns the threshold as set by set-analog-value-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 current12-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,
• analog-value-reached

are triggered, if the thresholds

• set-current-callback-threshold,
• set-analog-value-callback-threshold

keep being reached.

tinkerforge call current12-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 current12-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch current12-bricklet <uid> current¶

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

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 current12-bricklet <uid> analog-value¶

Output:	value – Type: Int, Range: [0 to 212 - 1]

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

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

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

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

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 current12-bricklet <uid> analog-value-reached¶

Output:	value – Type: Int, Range: [0 to 212 - 1]

This callback is triggered when the threshold as set by set-analog-value-callback-threshold is reached. The parameter is the analog value 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 current12-bricklet <uid> over-current¶

Output:	no output

This callback is triggered when an over current is measured (see is-over-current).