Shell - Industrial Digital In 4 Bricklet 2.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 Digital In 4 Bricklet 2.0

# Get current value
tinkerforge call industrial-digital-in-4-v2-bricklet $uid get-value

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 Digital In 4 Bricklet 2.0

# Handle incoming value callbacks
tinkerforge dispatch industrial-digital-in-4-v2-bricklet $uid value &

# Set period for value (channel 1) callback to 0.1s (100ms)
tinkerforge call industrial-digital-in-4-v2-bricklet $uid set-value-callback-configuration 1 100 false

echo "Press key to exit"; read dummy

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

Edge Count¶

Download (example-edge-count.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 Digital In 4 Bricklet 2.0

# Configure rising edge count (channel 3) with 10ms debounce
tinkerforge call industrial-digital-in-4-v2-bricklet $uid set-edge-count-configuration channel-3 edge-type-rising 10

# Get edge count 10 times with 1s delay
for i in 0 1 2 3 4 5 6 7 8 9; do
    sleep 1

    # Get current edge count
    tinkerforge call industrial-digital-in-4-v2-bricklet $uid get-edge-count channel-3 false
done

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-in-4-v2-bricklet [<option>..] <uid> <function> [<argument>..]¶

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

The call command is used to call a function of the Industrial Digital In 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 In 4 Bricklet 2.0 and exits

tinkerforge dispatch industrial-digital-in-4-v2-bricklet [<option>..] <uid> <callback>¶

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

The dispatch command is used to dispatch a callback of the Industrial Digital In 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 In 4 Bricklet 2.0 and exits

tinkerforge call industrial-digital-in-4-v2-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-digital-in-4-v2-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-digital-in-4-v2-bricklet <uid> get-value¶

Output:	value – Type: Bool Array, Length: 4

Returns the input value as bools, true refers to high and false refers to low.

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> set-channel-led-config <channel> <config>¶

Parameters:	<channel> – Type: Int, Range: See symbols <config> – Type: Int, Range: See symbols, Default: 3
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:

For <channel>:

• channel-0 = 0
• channel-1 = 1
• channel-2 = 2
• channel-3 = 3

For <config>:

• channel-led-config-off = 0
• channel-led-config-on = 1
• channel-led-config-show-heartbeat = 2
• channel-led-config-show-channel-status = 3

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-channel-led-config <channel>¶

Parameters:	<channel> – Type: Int, Range: See symbols
Output:	config – Type: Int, Range: See symbols, Default: 3

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

The following symbols are available for this function:

For <channel>:

• channel-0 = 0
• channel-1 = 1
• channel-2 = 2
• channel-3 = 3

For config:

• channel-led-config-off = 0
• channel-led-config-on = 1
• channel-led-config-show-heartbeat = 2
• channel-led-config-show-channel-status = 3

Advanced Functions¶

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-edge-count <channel> <reset-counter>¶

Parameters:	<channel> – Type: Int, Range: See symbols <reset-counter> – Type: Bool
Output:	count – Type: Int, Range: [0 to 232 - 1]

Returns the current value of the edge counter for the selected channel. You can configure the edges that are counted with set-edge-count-configuration.

If you set the reset counter to true, the count is set back to 0 directly after it is read.

The following symbols are available for this function:

For <channel>:

• channel-0 = 0
• channel-1 = 1
• channel-2 = 2
• channel-3 = 3

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> set-edge-count-configuration <channel> <edge-type> <debounce>¶

Parameters:	<channel> – Type: Int, Range: See symbols <edge-type> – Type: Int, Range: See symbols, Default: 0 <debounce> – Type: Int, Unit: 1 ms, Range: [0 to 255], Default: 100
Output:	no output

Configures the edge counter for a specific channel.

The edge type parameter configures if rising edges, falling edges or both are counted. Possible edge types are:

• 0 = rising
• 1 = falling
• 2 = both

Configuring an edge counter resets its value to 0.

If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you.

The following symbols are available for this function:

For <channel>:

• channel-0 = 0
• channel-1 = 1
• channel-2 = 2
• channel-3 = 3

For <edge-type>:

• edge-type-rising = 0
• edge-type-falling = 1
• edge-type-both = 2

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-edge-count-configuration <channel>¶

Parameters:	<channel> – Type: Int, Range: See symbols
Output:	edge-type – Type: Int, Range: See symbols, Default: 0 debounce – Type: Int, Unit: 1 ms, Range: [0 to 255], Default: 100

Returns the edge type and debounce time for the selected channel as set by set-edge-count-configuration.

The following symbols are available for this function:

For <channel>:

• channel-0 = 0
• channel-1 = 1
• channel-2 = 2
• channel-3 = 3

For edge-type:

• edge-type-rising = 0
• edge-type-falling = 1
• edge-type-both = 2

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-spitfp-error-count¶

Output:	error-count-ack-checksum – Type: Int, Range: [0 to 232 - 1] error-count-message-checksum – Type: Int, Range: [0 to 232 - 1] error-count-frame – Type: Int, Range: [0 to 232 - 1] error-count-overflow – Type: Int, Range: [0 to 232 - 1]

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-in-4-v2-bricklet <uid> set-status-led-config <config>¶

Parameters:	<config> – Type: Int, Range: See symbols, Default: 3
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:

For <config>:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-status-led-config¶

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

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

The following symbols are available for this function:

For config:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-chip-temperature¶

Output:	temperature – Type: Int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature 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-in-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-in-4-v2-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-digital-in-4-v2-bricklet <uid> set-value-callback-configuration <channel> <period> <value-has-to-change>¶

Parameters:	<channel> – Type: Int, Range: See symbols <period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 <value-has-to-change> – Type: Bool, Default: false
Output:	no output

This callback can be configured per channel.

The period is the period with which the value 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.

The following symbols are available for this function:

For <channel>:

• channel-0 = 0
• channel-1 = 1
• channel-2 = 2
• channel-3 = 3

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-value-callback-configuration <channel>¶

Parameters:	<channel> – Type: Int, Range: See symbols
Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value-has-to-change – Type: Bool, Default: false

Returns the callback configuration for the given channel as set by set-value-callback-configuration.

The following symbols are available for this function:

For <channel>:

• channel-0 = 0
• channel-1 = 1
• channel-2 = 2
• channel-3 = 3

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> set-all-value-callback-configuration <period> <value-has-to-change>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 <value-has-to-change> – Type: Bool, Default: false
Output:	no output

The period is the period with which the all-value 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.

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-all-value-callback-configuration¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value-has-to-change – Type: Bool, Default: false

Returns the callback configuration as set by set-all-value-callback-configuration.

Callbacks¶

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

tinkerforge dispatch industrial-digital-in-4-v2-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch industrial-digital-in-4-v2-bricklet <uid> value¶

Output:	channel – Type: Int, Range: See symbols changed – Type: Bool value – Type: Bool

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

The parameters are the channel, a value-changed indicator and the actual value for the channel. The changed parameter is true if the value has changed since the last callback.

The following symbols are available for this function:

For channel:

• channel-0 = 0
• channel-1 = 1
• channel-2 = 2
• channel-3 = 3

tinkerforge dispatch industrial-digital-in-4-v2-bricklet <uid> all-value¶

Output:	changed – Type: Bool Array, Length: 4 value – Type: Bool Array, Length: 4

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

The parameters are the same as get-value. Additional the changed parameter is true if the value has changed since the last callback.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> set-bootloader-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols
Output:	status – Type: Int, Range: See 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:

For <mode>:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

For status:

• bootloader-status-ok = 0
• bootloader-status-invalid-mode = 1
• bootloader-status-no-change = 2
• bootloader-status-entry-function-not-present = 3
• bootloader-status-device-identifier-incorrect = 4
• bootloader-status-crc-mismatch = 5

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-bootloader-mode¶

Output:	mode – Type: Int, Range: See symbols

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

The following symbols are available for this function:

For mode:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameters:	<pointer> – Type: Int, Unit: 1 B, Range: [0 to 232 - 1]
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-in-4-v2-bricklet <uid> write-firmware <data>¶

Parameters:	<data> – Type: Int Array, Length: 64, Range: [0 to 255]
Output:	status – Type: Int, Range: [0 to 255]

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-in-4-v2-bricklet <uid> write-uid <uid>¶

Parameters:	<uid> – Type: Int, Range: [0 to 232 - 1]
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-in-4-v2-bricklet <uid> read-uid¶

Output:	uid – Type: Int, Range: [0 to 232 - 1]

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