Shell - IO-16 Bricklet

This is the description of the Shell API bindings for the IO-16 Bricklet. General information and technical specifications for the IO-16 Bricklet 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).

Input

Download (example-input.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 IO-16 Bricklet

# Get current value from port A as bitmask
tinkerforge call io16-bricklet $uid get-port a

Output

Download (example-output.sh)

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

uid=XYZ # Change XYZ to the UID of your IO-16 Bricklet

# Set pin 0 on port A to output low: 1 << 0 = 1
tinkerforge call io16-bricklet $uid set-port-configuration a 1 direction-out false

# Set pin 0 and 7 on port B to output high: (1 << 0) | (1 << 7) = 129
tinkerforge call io16-bricklet $uid set-port-configuration b 129 direction-out true

Interrupt

Download (example-interrupt.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 IO-16 Bricklet

# Handle incoming interrupt callbacks
tinkerforge dispatch io16-bricklet $uid interrupt &

# Enable interrupt on pin 2 of port A: 1 << 2 = 4
tinkerforge call io16-bricklet $uid set-port-interrupt a 4

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

The call command is used to call a function of the IO-16 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 IO-16 Bricklet and exits
tinkerforge dispatch io16-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> -- string
  • <callback> -- string

The dispatch command is used to dispatch a callback of the IO-16 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 IO-16 Bricklet and exits
tinkerforge call io16-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 io16-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 io16-bricklet <uid> set-port <port> <value-mask>
Parameters:
  • <port> -- char
  • <value-mask> -- int
Output:

no output

Sets the output value (high or low) for a port ("a" or "b") with a bitmask (8bit). A 1 in the bitmask means high and a 0 in the bitmask means low.

For example: The value 15 or 0b00001111 will turn the pins 0-3 high and the pins 4-7 low for the specified port.

Note

This function does nothing for pins that are configured as input. Pull-up resistors can be switched on with set-port-configuration.

tinkerforge call io16-bricklet <uid> get-port <port>
Parameters:
  • <port> -- char
Output:
  • value-mask -- int

Returns a bitmask of the values that are currently measured on the specified port. This function works if the pin is configured to input as well as if it is configured to output.

tinkerforge call io16-bricklet <uid> set-port-configuration <port> <selection-mask> <direction> <value>
Parameters:
  • <port> -- char
  • <selection-mask> -- int
  • <direction> -- char (has symbols)
  • <value> -- bool
Output:

no output

Configures the value and direction of a specified port. Possible directions are 'i' and 'o' for input and output.

If the direction is configured as output, the value is either high or low (set as true or false).

If the direction is configured as input, the value is either pull-up or default (set as true or false).

For example:

  • ('a', 255, 'i', true) or ('a', 0b11111111, 'i', true) will set all pins of port A as input pull-up.
  • ('a', 128, 'i', false) or ('a', 0b10000000, 'i', false) will set pin 7 of port A as input default (floating if nothing is connected).
  • ('b', 3, 'o', false) or ('b', 0b00000011, 'o', false) will set pins 0 and 1 of port B as output low.
  • ('b', 4, 'o', true) or ('b', 0b00000100, 'o', true) will set pin 2 of port B as output high.

The default configuration is input with pull-up.

The following symbols are available for this function:

  • direction-in = i, for <direction>
  • direction-out = o, for <direction>
tinkerforge call io16-bricklet <uid> get-port-configuration <port>
Parameters:
  • <port> -- char
Output:
  • direction-mask -- int
  • value-mask -- int

Returns a direction bitmask and a value bitmask for the specified port. A 1 in the direction bitmask means input and a 0 in the bitmask means output.

For example: A return value of (15, 51) or (0b00001111, 0b00110011) for direction and value means that:

  • pins 0 and 1 are configured as input pull-up,
  • pins 2 and 3 are configured as input default,
  • pins 4 and 5 are configured as output high
  • and pins 6 and 7 are configured as output low.
tinkerforge call io16-bricklet <uid> get-edge-count <pin> <reset-counter>
Parameters:
  • <pin> -- int
  • <reset-counter> -- bool
Output:
  • count -- int

Returns the current value of the edge counter for the selected pin on port A. You can configure the edges that are counted with set-edge-count-config.

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

New in version 2.0.3 (Plugin).

Advanced Functions

tinkerforge call io16-bricklet <uid> set-port-monoflop <port> <selection-mask> <value-mask> <time>
Parameters:
  • <port> -- char
  • <selection-mask> -- int
  • <value-mask> -- int
  • <time> -- int
Output:

no output

Configures a monoflop of the pins specified by the second parameter as 8 bit long bitmask. The specified pins must be configured for output. Non-output pins will be ignored.

The third parameter is a bitmask with the desired value of the specified output pins. A 1 in the bitmask means high and a 0 in the bitmask means low.

The forth parameter indicates the time (in ms) that the pins should hold the value.

If this function is called with the parameters ('a', 9, 1, 1500) or ('a', 0b00001001, 0b00000001, 1500): Pin 0 will get high and pin 3 will get low on port 'a'. In 1.5s pin 0 will get low and pin 3 will get high again.

A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and an IO-16 Bricklet connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds and pin 0 set to high. Pin 0 will be high all the time. If now the RS485 connection is lost, then pin 0 will get low in at most two seconds.

tinkerforge call io16-bricklet <uid> get-port-monoflop <port> <pin>
Parameters:
  • <port> -- char
  • <pin> -- int
Output:
  • value -- int
  • time -- int
  • time-remaining -- int

Returns (for the given pin) the current value and the time as set by set-port-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 io16-bricklet <uid> set-selected-values <port> <selection-mask> <value-mask>
Parameters:
  • <port> -- char
  • <selection-mask> -- int
  • <value-mask> -- int
Output:

no output

Sets the output value (high or low) for a port ("a" or "b" with a bitmask, according to the selection mask. The bitmask is 8 bit long and a 1 in the bitmask means high and a 0 in the bitmask means low.

For example: The parameters ('a', 192, 128) or ('a', 0b11000000, 0b10000000) will turn pin 7 high and pin 6 low on port A, pins 0-6 will remain untouched.

Note

This function does nothing for pins that are configured as input. Pull-up resistors can be switched on with set-port-configuration.

tinkerforge call io16-bricklet <uid> set-edge-count-config <pin> <edge-type> <debounce>
Parameters:
  • <pin> -- int
  • <edge-type> -- int (has symbols)
  • <debounce> -- int
Output:

no output

Configures the edge counter for the selected pin of port A. Pins 0 and 1 are available for edge counting.

The edge type parameter configures if rising edges, falling edges or both are counted if the pin is configured for input. Possible edge types are:

  • 0 = rising (default)
  • 1 = falling
  • 2 = both

The debounce time is given in ms.

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.

Default values: 0 (edge type) and 100ms (debounce time)

The following symbols are available for this function:

  • edge-type-rising = 0, for <edge-type>
  • edge-type-falling = 1, for <edge-type>
  • edge-type-both = 2, for <edge-type>

New in version 2.0.3 (Plugin).

tinkerforge call io16-bricklet <uid> get-edge-count-config <pin>
Parameters:
  • <pin> -- int
Output:
  • edge-type -- int (has symbols)
  • debounce -- int

Returns the edge type and debounce time for the selected pin of port A as set by set-edge-count-config.

The following symbols are available for this function:

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

New in version 2.0.3 (Plugin).

tinkerforge call io16-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 io16-bricklet <uid> set-debounce-period <debounce>
Parameters:
  • <debounce> -- int
Output:

no output

Sets the debounce period of the interrupt callback in ms.

For example: If you set this value to 100, you will get the interrupt maximal every 100ms. This is necessary if something that bounces is connected to the IO-16 Bricklet, such as a button.

The default value is 100.

tinkerforge call io16-bricklet <uid> get-debounce-period
Output:
  • debounce -- int

Returns the debounce period as set by set-debounce-period.

tinkerforge call io16-bricklet <uid> set-port-interrupt <port> <interrupt-mask>
Parameters:
  • <port> -- char
  • <interrupt-mask> -- int
Output:

no output

Sets the pins on which an interrupt is activated with a bitmask. Interrupts are triggered on changes of the voltage level of the pin, i.e. changes from high to low and low to high.

For example: ('a', 129) or ('a', 0b10000001) will enable the interrupt for pins 0 and 7 of port a.

The interrupt is delivered with the interrupt callback.

tinkerforge call io16-bricklet <uid> get-port-interrupt <port>
Parameters:
  • <port> -- char
Output:
  • interrupt-mask -- int

Returns the interrupt bitmask for the specified port as set by set-port-interrupt.

Callbacks

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

tinkerforge dispatch io16-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 io16-bricklet <uid> interrupt
Output:
  • port -- char
  • interrupt-mask -- int
  • value-mask -- int

This callback is triggered whenever a change of the voltage level is detected on pins where the interrupt was activated with set-port-interrupt.

The values are the port, a bitmask that specifies which interrupts occurred and the current value bitmask of the port.

For example:

  • ('a', 1, 1) or ('a', 0b00000001, 0b00000001) means that on port A an interrupt on pin 0 occurred and currently pin 0 is high and pins 1-7 are low.
  • ('b', 129, 254) or ('b', 0b10000001, 0b11111110) means that on port B interrupts on pins 0 and 7 occurred and currently pin 0 is low and pins 1-7 are high.
tinkerforge dispatch io16-bricklet <uid> monoflop-done
Output:
  • port -- char
  • selection-mask -- int
  • value-mask -- int

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