Shell - Industrial Dual 0-20mA Bricklet¶

Simple¶

Download (example-simple.sh)

1#!/bin/sh
2# Connects to localhost:4223 by default, use --host and --port to change this
3
4uid=XYZ # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet
5
6# Get current current from sensor 1
7tinkerforge call industrial-dual-0-20ma-bricklet $uid get-current 1

Callback¶

Download (example-callback.sh)

 1#!/bin/sh
 2# Connects to localhost:4223 by default, use --host and --port to change this
 3
 4uid=XYZ # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet
 5
 6# Handle incoming current callbacks
 7tinkerforge dispatch industrial-dual-0-20ma-bricklet $uid current &
 8
 9# Set period for current (sensor 1) callback to 1s (1000ms)
10# Note: The current (sensor 1) callback is only called every second
11#       if the current (sensor 1) has changed since the last call!
12tinkerforge call industrial-dual-0-20ma-bricklet $uid set-current-callback-period 1 1000
13
14echo "Press key to exit"; read dummy
15
16kill -- -$$ # Stop callback dispatch in background

Threshold¶

Download (example-threshold.sh)

 1#!/bin/sh
 2# Connects to localhost:4223 by default, use --host and --port to change this
 3
 4uid=XYZ # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet
 5
 6# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
 7tinkerforge call industrial-dual-0-20ma-bricklet $uid set-debounce-period 10000
 8
 9# Handle incoming current reached callbacks
10tinkerforge dispatch industrial-dual-0-20ma-bricklet $uid current-reached &
11
12# Configure threshold for current (sensor 1) "greater than 10 mA"
13tinkerforge call industrial-dual-0-20ma-bricklet $uid set-current-callback-threshold 1 threshold-option-greater 10000000 0
14
15echo "Press key to exit"; read dummy
16
17kill -- -$$ # 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 industrial-dual-0-20ma-bricklet [<option>..] <uid> <function> [<argument>..]¶

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

The call command is used to call a function of the Industrial Dual 0-20mA 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 Industrial Dual 0-20mA Bricklet and exits

tinkerforge dispatch industrial-dual-0-20ma-bricklet [<option>..] <uid> <callback>¶

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

The dispatch command is used to dispatch a callback of the Industrial Dual 0-20mA 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 Industrial Dual 0-20mA Bricklet and exits

tinkerforge call industrial-dual-0-20ma-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 industrial-dual-0-20ma-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 industrial-dual-0-20ma-bricklet <uid> get-current <sensor>¶

Parameters:	<sensor> – Type: Int, Range: [0 to 1]
Output:	current – Type: Int, Unit: 1 nA, Range: [0 to 22505322]

Returns the current of the specified sensor.

It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works properly.

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 current callback and set the period with set-current-callback-period.

Advanced Functions¶

tinkerforge call industrial-dual-0-20ma-bricklet <uid> set-sample-rate <rate>¶

Parameters:	<rate> – Type: Int, Range: See symbols, Default: 3
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 following symbols are available for this function:

For <rate>:

• sample-rate-240-sps = 0

• sample-rate-60-sps = 1

• sample-rate-15-sps = 2

• sample-rate-4-sps = 3

tinkerforge call industrial-dual-0-20ma-bricklet <uid> get-sample-rate¶

Output:	rate – Type: Int, Range: See symbols, Default: 3

Returns the sample rate as set by set-sample-rate.

The following symbols are available for this function:

For rate:

• sample-rate-240-sps = 0

• sample-rate-60-sps = 1

• sample-rate-15-sps = 2

• sample-rate-4-sps = 3

tinkerforge call industrial-dual-0-20ma-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 industrial-dual-0-20ma-bricklet <uid> set-current-callback-period <sensor> <period>¶

Parameters:	<sensor> – Type: Int, Range: [0 to 1] <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 for the given sensor. 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 industrial-dual-0-20ma-bricklet <uid> get-current-callback-period <sensor>¶

Parameters:	<sensor> – Type: Int, Range: [0 to 1]
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 industrial-dual-0-20ma-bricklet <uid> set-current-callback-threshold <sensor> <option> <min> <max>¶

Parameters:	<sensor> – Type: Int, Range: [0 to 1] <option> – Type: Char, Range: See symbols, Default: x <min> – Type: Int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0 <max> – Type: Int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0
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 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 industrial-dual-0-20ma-bricklet <uid> get-current-callback-threshold <sensor>¶

Parameters:	<sensor> – Type: Int, Range: [0 to 1]
Output:	option – Type: Char, Range: See symbols, Default: x min – Type: Int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0 max – Type: Int, Unit: 1 nA, 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 industrial-dual-0-20ma-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 callback

• current-reached

is triggered, if the threshold

• set-current-callback-threshold

keeps being reached.

tinkerforge call industrial-dual-0-20ma-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 industrial-dual-0-20ma-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch industrial-dual-0-20ma-bricklet <uid> current¶

Output:	sensor – Type: Int, Range: [0 to 1] current – Type: Int, Unit: 1 nA, Range: [0 to 22505322]

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 industrial-dual-0-20ma-bricklet <uid> current-reached¶

Output:	sensor – Type: Int, Range: [0 to 1] current – Type: Int, Unit: 1 nA, Range: [0 to 22505322]

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.