This is the description of the Shell API bindings for the Industrial Dual 0-20mA Bricklet. General information and technical specifications for the Industrial Dual 0-20mA 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 from sensor 1 (unit is nA)
tinkerforge call industrial-dual-0-20ma-bricklet $uid get-current 1
|
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 industrial-dual-0-20ma-bricklet $uid set-current-callback-period 1 1000
# handle incoming illuminance callbacks (unit is nA)
tinkerforge dispatch industrial-dual-0-20ma-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 industrial-dual-0-20ma-bricklet $uid set-debounce-period 10000
# configure threshold (sensor 1) for "greater than 10mA" (unit is nA)
tinkerforge call industrial-dual-0-20ma-bricklet $uid set-current-callback-threshold 1 greater 10000000 0
# handle incoming current-reached callbacks (unit is nA)
tinkerforge dispatch industrial-dual-0-20ma-bricklet $uid current-reached\
--execute "echo Current (sensor {sensor}) is greater than 10mA: {current} nA"
|
Possible exit codes for all tinkerforge commands are:
Two sensors can be connected to the Bricklet. Functions that are related directly to a sensor have a sensor parameter to specify one of the two sensors. Valid values for the sensor parameter are 0 and 1.
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 Industrial Dual 0-20mA Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the Industrial Dual 0-20mA 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:
Parameters: |
|
---|---|
Output: |
|
Returns the current of the specified sensor (0 or 1). The value is in nA and between 0nA and 22505322nA (22.5mA).
It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works probably.
If the returned current is below 4mA, there is likely no sensor connected or the sensor may be defect. If the returned current is over 20mA, there might be a short circuit or the sensor may be defect.
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.
Parameters: |
|
---|---|
Output: | no output |
Sets the sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively.
Value | Description |
---|---|
0 | 240 samples per second, 12 bit resolution |
1 | 60 samples per second, 14 bit resolution |
2 | 15 samples per second, 16 bit resolution |
3 | 4 samples per second, 18 bit resolution |
The default value is 3: 4 samples per second with 18 bit resolution.
The following symbols are available for this function:
Output: |
|
---|
Returns the sample rate as set by set-sample-rate.
The following symbols are available for this function:
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 for the given sensor. 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.
Parameters: |
|
---|---|
Output: |
|
Returns the period as set by set-current-callback-period.
Parameters: |
|
---|---|
Output: | no output |
Sets the thresholds for the current-reached callback for the given sensor.
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:
Parameters: |
|
---|---|
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 period in ms with which the threshold callback
is triggered, if the threshold
keeps 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 industrial-dual-0-20ma-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 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.