This is the description of the Shell API bindings for the Current25 Bricklet. General information and technical specifications for the Current25 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 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
# get current current (unit is mA)
tinkerforge call current25-bricklet $uid get-current
|
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 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 current25-bricklet $uid set-current-callback-period 1000
# handle incoming current callbacks (unit is mA)
tinkerforge dispatch current25-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 current25-bricklet $uid set-debounce-period 10000
# configure threshold for "greater than 5A" (unit is mA)
tinkerforge call current25-bricklet $uid set-current-callback-threshold greater 5000 0
# handle incoming current-reached callbacks (unit is mA)
tinkerforge dispatch current25-bricklet $uid current-reached\
--execute "echo Current is greater than 5A: {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 Current25 Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the Current25 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 of the sensor. The value is in mA and between -25000mA and 25000mA.
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: | 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.
Output: |
|
---|
Returns true if more than 25A were measured.
Note
To reset this value you have to power cycle the Bricklet.
Output: |
|
---|
Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.
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 callback analog-value and set the period with set-analog-value-callback-period.
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 analog-value callback is triggered periodically. A value of 0 turns the callback off.
analog-value is only triggered if the analog value has changed since the last triggering.
The default value is 0.
Output: |
|
---|
Returns the period as set by set-analog-value-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 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 default value is ('x', 0, 0).
The following symbols are available for this function:
Output: |
|
---|
Returns the threshold as set by set-analog-value-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 current25-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-analog-value-callback-period. The parameter is the analog value of the sensor.
analog-value is only triggered if the current 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-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.
Output: | no output |
---|
This callback is triggered when an over current is measured (see is-over-current).