Shell - Industrial Dual 0-20mA Bricklet 2.0

This is the description of the Shell API bindings for the Industrial Dual 0-20mA Bricklet 2.0. General information and technical specifications for the Industrial Dual 0-20mA Bricklet 2.0 are summarized in its hardware description.

An installation guide for the Shell API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

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 Industrial Dual 0-20mA Bricklet 2.0

# Get current current from channel 0
tinkerforge call industrial-dual-0-20ma-v2-bricklet $uid get-current 0

Callback

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0

# Handle incoming current callbacks
tinkerforge dispatch industrial-dual-0-20ma-v2-bricklet $uid current &

# Set period for current (channel 0) callback to 1s (1000ms) without a threshold
tinkerforge call industrial-dual-0-20ma-v2-bricklet $uid set-current-callback-configuration 0 1000 false threshold-option-off 0 0

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
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0

# Handle incoming current callbacks
tinkerforge dispatch industrial-dual-0-20ma-v2-bricklet $uid current &

# Configure threshold for current (channel 0) "greater than 10 mA"
# with a debounce period of 10s (10000ms)
tinkerforge call industrial-dual-0-20ma-v2-bricklet $uid set-current-callback-configuration 0 10000 false threshold-option-greater 10000000 0

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

API

Possible exit codes for all tinkerforge commands are:

  • 1: interrupted (ctrl+c)
  • 2: syntax error
  • 21: Python 2.5 or newer is required
  • 22: Python argparse module is missing
  • 23: socket error
  • 24: other exception
  • 25: invalid placeholder in format string
  • 26: authentication error
  • 201: timeout occurred
  • 209: invalid argument value
  • 210: function is not supported
  • 211: unknown error

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-v2-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The call command is used to call a function of the Industrial Dual 0-20mA Bricklet 2.0. 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 2.0 and exits
tinkerforge dispatch industrial-dual-0-20ma-v2-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> -- string
  • <callback> -- string

The dispatch command is used to dispatch a callback of the Industrial Dual 0-20mA Bricklet 2.0. 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 2.0 and exits
tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> <function> [<option>..] [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- 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 send and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch industrial-dual-0-20ma-v2-bricklet <uid> <callback> [<option>..]
Parameters:
  • <uid> -- string
  • <callback> -- 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-v2-bricklet <uid> get-current <channel>
Parameters:
  • <channel> -- int
Output:
  • current -- int

Returns the current of the specified channel. 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 connected sensor is defective. If the returned current is over 20mA, there might be a short circuit or the sensor is defective.

If you want to get the value periodically, it is recommended to use the current callback. You can set the callback configuration with set-current-callback-configuration.

tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> set-channel-led-config <channel> <config>
Parameters:
  • <channel> -- int
  • <config> -- int (has symbols)
Output:

no output

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the measured value.

You can configure the channel status behavior with set-channel-led-status-config.

By default all channel LEDs are configured as "Channel Status".

The following symbols are available for this function:

  • channel-led-config-off = 0, for <config>
  • channel-led-config-on = 1, for <config>
  • channel-led-config-show-heartbeat = 2, for <config>
  • channel-led-config-show-channel-status = 3, for <config>
tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> get-channel-led-config <channel>
Parameters:
  • <channel> -- int
Output:
  • config -- int (has symbols)

Returns the channel LED configuration as set by set-channel-led-config

The following symbols are available for this function:

  • channel-led-config-off = 0, for config
  • channel-led-config-on = 1, for config
  • channel-led-config-show-heartbeat = 2, for config
  • channel-led-config-show-channel-status = 3, for config
tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> set-channel-led-status-config <channel> <min> <max> <config>
Parameters:
  • <channel> -- int
  • <min> -- int
  • <max> -- int
  • <config> -- int (has symbols)
Output:

no output

Sets the channel LED status config. This config is used if the channel LED is configured as "Channel Status", see set-channel-led-config.

For each channel you can choose between threshold and intensity mode.

In threshold mode you can define a positive or a negative threshold. For a positive threshold set the "min" parameter to the threshold value in nA above which the LED should turn on and set the "max" parameter to 0. Example: If you set a positive threshold of 10mA, the LED will turn on as soon as the current exceeds 10mA and turn off again if it goes below 10mA. For a negative threshold set the "max" parameter to the threshold value in nA below which the LED should turn on and set the "min" parameter to 0. Example: If you set a negative threshold of 10mA, the LED will turn on as soon as the current goes below 10mA and the LED will turn off when the current exceeds 10mA.

In intensity mode you can define a range in nA that is used to scale the brightness of the LED. Example with min=4mA and max=20mA: The LED is off at 4mA and below, on at 20mA and above and the brightness is linearly scaled between the values 4mA and 20mA. If the min value is greater than the max value, the LED brightness is scaled the other way around.

By default the channel LED status config is set to intensity with min=4mA and max=20mA.

The following symbols are available for this function:

  • channel-led-status-config-threshold = 0, for <config>
  • channel-led-status-config-intensity = 1, for <config>
tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> get-channel-led-status-config <channel>
Parameters:
  • <channel> -- int
Output:
  • min -- int
  • max -- int
  • config -- int (has symbols)

Returns the channel LED status configuration as set by set-channel-led-status-config.

The following symbols are available for this function:

  • channel-led-status-config-threshold = 0, for config
  • channel-led-status-config-intensity = 1, for config

Advanced Functions

tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> set-sample-rate <rate>
Parameters:
  • <rate> -- int (has symbols)
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:

  • sample-rate-240-sps = 0, for <rate>
  • sample-rate-60-sps = 1, for <rate>
  • sample-rate-15-sps = 2, for <rate>
  • sample-rate-4-sps = 3, for <rate>
tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> get-sample-rate
Output:
  • rate -- int (has symbols)

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

The following symbols are available for this function:

  • sample-rate-240-sps = 0, for rate
  • sample-rate-60-sps = 1, for rate
  • sample-rate-15-sps = 2, for rate
  • sample-rate-4-sps = 3, for rate
tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> set-gain <gain>
Parameters:
  • <gain> -- int (has symbols)
Output:

no output

Sets a gain between 1x and 8x. If you want to measure a very small current, you can increase the gain to get some more resolution.

Example: If you measure 0.5mA with a gain of 8x the return value will be 4mA.

The default gain is 1x.

The following symbols are available for this function:

  • gain-1x = 0, for <gain>
  • gain-2x = 1, for <gain>
  • gain-4x = 2, for <gain>
  • gain-8x = 3, for <gain>
tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> get-gain
Output:
  • gain -- int (has symbols)

Returns the gain as set by set-gain.

The following symbols are available for this function:

  • gain-1x = 0, for gain
  • gain-2x = 1, for gain
  • gain-4x = 2, for gain
  • gain-8x = 3, for gain
tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> get-spitfp-error-count
Output:
  • error-count-ack-checksum -- int
  • error-count-message-checksum -- int
  • error-count-frame -- int
  • error-count-overflow -- int

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> set-bootloader-mode <mode>
Parameters:
  • <mode> -- int (has symbols)
Output:
  • status -- int (has symbols)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following symbols are available for this function:

  • bootloader-mode-bootloader = 0, for <mode>
  • bootloader-mode-firmware = 1, for <mode>
  • bootloader-mode-bootloader-wait-for-reboot = 2, for <mode>
  • bootloader-mode-firmware-wait-for-reboot = 3, for <mode>
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for <mode>
  • bootloader-status-ok = 0, for status
  • bootloader-status-invalid-mode = 1, for status
  • bootloader-status-no-change = 2, for status
  • bootloader-status-entry-function-not-present = 3, for status
  • bootloader-status-device-identifier-incorrect = 4, for status
  • bootloader-status-crc-mismatch = 5, for status
tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> get-bootloader-mode
Output:
  • mode -- int (has symbols)

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

  • bootloader-mode-bootloader = 0, for mode
  • bootloader-mode-firmware = 1, for mode
  • bootloader-mode-bootloader-wait-for-reboot = 2, for mode
  • bootloader-mode-firmware-wait-for-reboot = 3, for mode
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for mode
tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> set-write-firmware-pointer <pointer>
Parameters:
  • <pointer> -- int
Output:

no output

Sets the firmware pointer for write-firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> write-firmware <data>
Parameters:
  • <data> -- int,int,..61x..,int
Output:
  • status -- int

Writes 64 Bytes of firmware at the position as written by set-write-firmware-pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> set-status-led-config <config>
Parameters:
  • <config> -- int (has symbols)
Output:

no output

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following symbols are available for this function:

  • status-led-config-off = 0, for <config>
  • status-led-config-on = 1, for <config>
  • status-led-config-show-heartbeat = 2, for <config>
  • status-led-config-show-status = 3, for <config>
tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> get-status-led-config
Output:
  • config -- int (has symbols)

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

  • status-led-config-off = 0, for config
  • status-led-config-on = 1, for config
  • status-led-config-show-heartbeat = 2, for config
  • status-led-config-show-status = 3, for config
tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> get-chip-temperature
Output:
  • temperature -- int

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> reset
Output:no output

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> write-uid <uid>
Parameters:
  • <uid> -- int
Output:

no output

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> read-uid
Output:
  • uid -- int

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> get-identity
Output:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (has symbols)

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

Callback Configuration Functions

tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> set-current-callback-configuration <channel> <period> <value-has-to-change> <option> <min> <max>
Parameters:
  • <channel> -- int
  • <period> -- int
  • <value-has-to-change> -- bool
  • <option> -- char (has symbols)
  • <min> -- int
  • <max> -- int
Output:

no output

The period in ms is the period with which the current callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the current callback.

The following options are possible:

Option Description
'x' Threshold is turned off
'o' Threshold is triggered when the value is outside the min and max values
'i' Threshold is triggered when the value is inside or equal to the min and max values
'<' Threshold is triggered when the value is smaller than the min value (max is ignored)
'>' Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The default value is (0, false, 'x', 0, 0).

The following symbols are available for this function:

  • threshold-option-off = x, for <option>
  • threshold-option-outside = o, for <option>
  • threshold-option-inside = i, for <option>
  • threshold-option-smaller = <, for <option>
  • threshold-option-greater = >, for <option>
tinkerforge call industrial-dual-0-20ma-v2-bricklet <uid> get-current-callback-configuration <channel>
Parameters:
  • <channel> -- int
Output:
  • period -- int
  • value-has-to-change -- bool
  • option -- char (has symbols)
  • min -- int
  • max -- int

Returns the callback configuration as set by set-current-callback-configuration.

The following symbols are available for this function:

  • threshold-option-off = x, for option
  • threshold-option-outside = o, for option
  • threshold-option-inside = i, for option
  • threshold-option-smaller = <, for option
  • threshold-option-greater = >, for option

Callbacks

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch industrial-dual-0-20ma-v2-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.

tinkerforge dispatch industrial-dual-0-20ma-v2-bricklet <uid> current
Output:
  • channel -- int
  • current -- int

This callback is triggered periodically according to the configuration set by set-current-callback-configuration.

The parameter is the same as get-current.