This is the description of the Shell API bindings for the Current12 Bricklet. General information and technical specifications for the Current12 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 | #!/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
|
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
|
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
|
Possible exit codes for all tinkerforge
commands are:
argparse
module is missingThe common options of the call
and dispatch
commands are documented
here. The specific command structure is shown below.
call
current12-bricklet
[<option>..] <uid> <function> [<argument>..]¶Parameters: |
|
---|
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 exitsdispatch
current12-bricklet
[<option>..] <uid> <callback>¶Parameters: |
|
---|
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 exitscurrent12-bricklet
<uid> <function>
[<option>..] [<argument>..]¶Parameters: |
|
---|
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 exitsGetter 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 itThe --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.
current12-bricklet
<uid> <callback>
[<option>..]¶Parameters: |
|
---|
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)current12-bricklet
<uid> get-current
¶Output: |
|
---|
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
.
current12-bricklet
<uid> calibrate
¶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.
current12-bricklet
<uid> is-over-current
¶Output: |
|
---|
Returns true if more than 12.5A were measured.
Note
To reset this value you have to power cycle the Bricklet.
current12-bricklet
<uid> get-analog-value
¶Output: |
|
---|
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
.
current12-bricklet
<uid> get-identity
¶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.
current12-bricklet
<uid> set-current-callback-period
<period>¶Parameters: |
|
---|---|
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.
current12-bricklet
<uid> get-current-callback-period
¶Output: |
|
---|
Returns the period as set by set-current-callback-period
.
current12-bricklet
<uid> set-analog-value-callback-period
<period>¶Parameters: |
|
---|---|
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.
current12-bricklet
<uid> get-analog-value-callback-period
¶Output: |
|
---|
Returns the period as set by set-analog-value-callback-period
.
current12-bricklet
<uid> set-current-callback-threshold
<option> <min> <max>¶Parameters: |
|
---|---|
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>:
current12-bricklet
<uid> get-current-callback-threshold
¶Output: |
|
---|
Returns the threshold as set by set-current-callback-threshold
.
The following symbols are available for this function:
For option:
current12-bricklet
<uid> set-analog-value-callback-threshold
<option> <min> <max>¶Parameters: |
|
---|---|
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>:
current12-bricklet
<uid> get-analog-value-callback-threshold
¶Output: |
|
---|
Returns the threshold as set by set-analog-value-callback-threshold
.
The following symbols are available for this function:
For option:
current12-bricklet
<uid> set-debounce-period
<debounce>¶Parameters: |
|
---|---|
Output: |
|
Sets the period with which the threshold callbacks
are triggered, if the thresholds
keep being reached.
current12-bricklet
<uid> get-debounce-period
¶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 current12-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.
current12-bricklet
<uid> current
¶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.
The current
callback is only triggered if the current has changed since
the last triggering.
current12-bricklet
<uid> analog-value
¶Output: |
|
---|
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.
current12-bricklet
<uid> current-reached
¶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
.
current12-bricklet
<uid> analog-value-reached
¶Output: |
|
---|
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
.
current12-bricklet
<uid> over-current
¶Output: |
|
---|
This callback is triggered when an over current is measured
(see is-over-current
).