Shell - Industrial Quad Relay Bricklet¶

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 Quad Relay Bricklet

# Turn relays alternating on/off 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-quad-relay-bricklet $uid set-value 1 # 1 << 0 = 1
    sleep 0.1
    tinkerforge call industrial-quad-relay-bricklet $uid set-value 2 # 1 << 1 = 2
    sleep 0.1
    tinkerforge call industrial-quad-relay-bricklet $uid set-value 4 # 1 << 2 = 4
    sleep 0.1
    tinkerforge call industrial-quad-relay-bricklet $uid set-value 8 # 1 << 3 = 8
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-quad-relay-bricklet [<option>..] <uid> <function> [<argument>..]¶

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

The call command is used to call a function of the Industrial Quad Relay 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 Quad Relay Bricklet and exits

tinkerforge dispatch industrial-quad-relay-bricklet [<option>..] <uid> <callback>¶

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

The dispatch command is used to dispatch a callback of the Industrial Quad Relay 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 Quad Relay Bricklet and exits

tinkerforge call industrial-quad-relay-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-quad-relay-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-quad-relay-bricklet <uid> set-value <value-mask>¶

Parameters:	<value-mask> – Type: Int, Range: [0 to 216 - 1]
Output:	no output

Sets the output value with a bitmask (16bit). A 1 in the bitmask means relay closed and a 0 means relay open.

For example: The value 3 or 0b0011 will close the relay of pins 0-1 and open the other pins.

If no groups are used (see set-group), the pins correspond to the markings on the Industrial Quad Relay Bricklet.

If groups are used, the pins correspond to the element in the group. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

All running monoflop timers will be aborted if this function is called.

tinkerforge call industrial-quad-relay-bricklet <uid> get-value¶

Output:	value-mask – Type: Int, Range: [0 to 216 - 1]

Returns the bitmask as set by set-value.

Advanced Functions¶

tinkerforge call industrial-quad-relay-bricklet <uid> set-monoflop <selection-mask> <value-mask> <time>¶

Parameters:	<selection-mask> – Type: Int, Range: [0 to 216 - 1] <value-mask> – Type: Int, Range: [0 to 216 - 1] <time> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1]
Output:	no output

Configures a monoflop of the pins specified by the first parameter bitmask.

The second parameter is a bitmask with the desired value of the specified pins. A 1 in the bitmask means relay closed and a 0 means relay open.

The third parameter indicates the time that the pins should hold the value.

If this function is called with the parameters (9, 1, 1500) or (0b1001, 0b0001, 1500): Pin 0 will close and pin 3 will open. In 1.5s pin 0 will open and pin 3 will close again.

A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and a Quad Relay 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 closed. Pin 0 will be closed all the time. If now the RS485 connection is lost, then pin 0 will be opened in at most two seconds.

tinkerforge call industrial-quad-relay-bricklet <uid> get-monoflop <pin>¶

Parameters:	<pin> – Type: Int, Range: [0 to 15]
Output:	value – Type: Int, Range: [0 to 1] time – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1] time-remaining – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1]

Returns (for the given pin) 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-quad-relay-bricklet <uid> set-group <group>¶

Parameters:	<group> – Type: Char Array, Length: 4, Range: [a to d, n]
Output:	no output

Sets a group of Quad Relay Bricklets that should work together. You can find Bricklets that can be grouped together with get-available-for-group.

The group consists of 4 elements. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

Each element can either be one of the ports ('a' to 'd') or 'n' if it should not be used.

For example: If you have two Quad Relay Bricklets connected to port A and port B respectively, you could call with ['a', 'b', 'n', 'n'].

Now the pins on the Quad Relay on port A are assigned to 0-3 and the pins on the Quad Relay on port B are assigned to 4-7. It is now possible to call set-value and control two Bricklets at the same time.

tinkerforge call industrial-quad-relay-bricklet <uid> get-group¶

Output:	group – Type: Char Array, Length: 4, Range: [a to d, n]

Returns the group as set by set-group

tinkerforge call industrial-quad-relay-bricklet <uid> get-available-for-group¶

Output:	available – Type: Int, Range: [0 to 15]

Returns a bitmask of ports that are available for grouping. For example the value 5 or 0b0101 means: Port A and port C are connected to Bricklets that can be grouped together.

tinkerforge call industrial-quad-relay-bricklet <uid> set-selected-values <selection-mask> <value-mask>¶

Parameters:	<selection-mask> – Type: Int, Range: [0 to 216 - 1] <value-mask> – Type: Int, Range: [0 to 216 - 1]
Output:	no output

Sets the output value with a bitmask, according to the selection mask. The bitmask is 16 bit long, true refers to a closed relay and false refers to an open relay.

For example: The values (3, 1) or (0b0011, 0b0001) will close the relay of pin 0, open the relay of pin 1 and leave the others untouched.

If no groups are used (see set-group), the pins correspond to the markings on the Industrial Quad Relay Bricklet.

If groups are used, the pins correspond to the element in the group. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

Running monoflop timers for the selected relays will be aborted if this function is called.

tinkerforge call industrial-quad-relay-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. 

Callbacks¶

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

tinkerforge dispatch industrial-quad-relay-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch industrial-quad-relay-bricklet <uid> monoflop-done¶

Output:	selection-mask – Type: Int, Range: [0 to 216 - 1] value-mask – Type: Int, Range: [0 to 216 - 1]

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