Shell - Industrial Digital Out 4 Bricklet 2.0

This is the description of the Shell API bindings for the Industrial Digital Out 4 Bricklet 2.0. General information and technical specifications for the Industrial Digital Out 4 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
 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 Industrial Digital Out 4 Bricklet 2.0

# Set channels alternating high/low 10 times with 100 ms delay
for i in 0 1 2 3 4 5 6 7 8 9; do
    sleep 0.1
    tinkerforge call industrial-digital-out-4-v2-bricklet $uid set-value true,false,false,false
    sleep 0.1
    tinkerforge call industrial-digital-out-4-v2-bricklet $uid set-value false,true,false,false
    sleep 0.1
    tinkerforge call industrial-digital-out-4-v2-bricklet $uid set-value false,false,true,false
    sleep 0.1
    tinkerforge call industrial-digital-out-4-v2-bricklet $uid set-value false,false,false,true
done

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

The call command is used to call a function of the Industrial Digital Out 4 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 Digital Out 4 Bricklet 2.0 and exits
tinkerforge dispatch industrial-digital-out-4-v2-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> -- string
  • <callback> -- string

The dispatch command is used to dispatch a callback of the Industrial Digital Out 4 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 Digital Out 4 Bricklet 2.0 and exits
tinkerforge call industrial-digital-out-4-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-digital-out-4-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-digital-out-4-v2-bricklet <uid> set-value <value>
Parameters:
  • <value> -- bool,bool,bool,bool
Output:

no output

Sets the output value of all four channels. A value of true or false outputs logic 1 or logic 0 respectively on the corresponding channel.

Use set-selected-value to change only one output channel state.

For example: (True, True, False, False) will turn the channels 0-1 high and the channels 2-3 low.

tinkerforge call industrial-digital-out-4-v2-bricklet <uid> get-value
Output:
  • value -- bool,bool,bool,bool

Returns the logic levels that are currently output on the channels.

tinkerforge call industrial-digital-out-4-v2-bricklet <uid> set-selected-value <channel> <value>
Parameters:
  • <channel> -- int
  • <value> -- bool
Output:

no output

Sets the output value of a specific channel without affecting the other channels.

tinkerforge call industrial-digital-out-4-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 is on if the channel is high and off otherwise.

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-digital-out-4-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

Advanced Functions

tinkerforge call industrial-digital-out-4-v2-bricklet <uid> set-monoflop <channel> <value> <time>
Parameters:
  • <channel> -- int
  • <value> -- bool
  • <time> -- int
Output:

no output

The first parameter is the desired state of the channel (true means output high and false means output low). The second parameter indicates the time (in ms) that the channel should hold the state.

If this function is called with the parameters (true, 1500): The channel will turn on and in 1.5s it will turn off again.

A monoflop can be used as a failsafe mechanism. For example: Lets assume you have a RS485 bus and a IO-4 Bricklet is connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds. The channel will be high all the time. If now the RS485 connection is lost, the channel will turn low in at most two seconds.

tinkerforge call industrial-digital-out-4-v2-bricklet <uid> get-monoflop <channel>
Parameters:
  • <channel> -- int
Output:
  • value -- bool
  • time -- int
  • time-remaining -- int

Returns (for the given channel) the current value and the time as set by set-monoflop as well as the remaining time until the value flips.

If the timer is not running currently, the remaining time will be returned as 0.

tinkerforge call industrial-digital-out-4-v2-bricklet <uid> set-pwm-configuration <channel> <frequency> <duty-cycle>
Parameters:
  • <channel> -- int
  • <frequency> -- int
  • <duty-cycle> -- int
Output:

no output

Activates a PWM for the given channel with the frequency given in 1/10Hz and the duty cycle given in 1/100%.

To turn the PWM off again, you can set the frequency to 0 or any other function that changes a value of the channel (e.g. set-selected-value).

The maximum duty cycle value is 10000 (100%). The optocoupler of the Industrial Digital Out 4 Bricklet 2.0 has a rise time and fall time of 11.5us (each) at 24V. So the maximum useful frequency value is about 400000 (40kHz).

The default values are 0, 0.

tinkerforge call industrial-digital-out-4-v2-bricklet <uid> get-pwm-configuration <channel>
Parameters:
  • <channel> -- int
Output:
  • frequency -- int
  • duty-cycle -- int

Returns the PWM configuration as set by set-pwm-configuration.

tinkerforge call industrial-digital-out-4-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-digital-out-4-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-digital-out-4-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-digital-out-4-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-digital-out-4-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-digital-out-4-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-digital-out-4-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-digital-out-4-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-digital-out-4-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-digital-out-4-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-digital-out-4-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-digital-out-4-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

Callbacks

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

tinkerforge dispatch industrial-digital-out-4-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-digital-out-4-v2-bricklet <uid> monoflop-done
Output:
  • channel -- int
  • value -- bool

This callback is triggered whenever a monoflop timer reaches 0. The parameters contain the channel and the current value of the channel (the value after the monoflop).