Ruby - Industrial Quad Relay Bricklet

This is the description of the Ruby API bindings for the Industrial Quad Relay Bricklet. General information and technical specifications for the Industrial Quad Relay Bricklet are summarized in its hardware description.

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

Examples

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

Simple

Download (example_simple.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_quad_relay'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Industrial Quad Relay Bricklet

ipcon = IPConnection.new # Create IP connection
iqr = BrickletIndustrialQuadRelay.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Turn relays alternating on/off 10 times with 100 ms delay
for _ in 0..9
  sleep 0.1
  iqr.set_value 1 << 0
  sleep 0.1
  iqr.set_value 1 << 1
  sleep 0.1
  iqr.set_value 1 << 2
  sleep 0.1
  iqr.set_value 1 << 3
end

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API

All methods listed below are thread-safe.

Basic Functions

BrickletIndustrialQuadRelay::new(uid, ipcon) → industrial_quad_relay
Parameters:
  • uid – Type: str
  • ipcon – Type: IPConnection
Returns:
  • industrial_quad_relay – Type: BrickletIndustrialQuadRelay

Creates an object with the unique device ID uid:

industrial_quad_relay = BrickletIndustrialQuadRelay.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected (see examples above).

BrickletIndustrialQuadRelay#set_value(value_mask) → nil
Parameters:
  • value_mask – Type: int, Range: [0 to 216 - 1]

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.

BrickletIndustrialQuadRelay#get_value → int
Returns:
  • value_mask – Type: int, Range: [0 to 216 - 1]

Returns the bitmask as set by #set_value.

Advanced Functions

BrickletIndustrialQuadRelay#set_monoflop(selection_mask, value_mask, time) → nil
Parameters:
  • selection_mask – Type: int, Range: [0 to 216 - 1]
  • value_mask – Type: int, Range: [0 to 216 - 1]
  • time – Type: int, Range: [0 to 232 - 1]

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 (in ms) 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.

BrickletIndustrialQuadRelay#get_monoflop(pin) → [int, int, int]
Parameters:
  • pin – Type: int, Range: [0 to 255]
Return Array:
  • 0: value – Type: int, Range: [0 to 216 - 1]
  • 1: time – Type: int, Range: [0 to 232 - 1]
  • 2: time_remaining – Type: int, 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.

BrickletIndustrialQuadRelay#set_group(group) → nil
Parameters:
  • group – Type: [chr, ...], Length: 4

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.

BrickletIndustrialQuadRelay#get_group → [chr, ...]
Returns:
  • group – Type: [chr, ...], Length: 4

Returns the group as set by #set_group

BrickletIndustrialQuadRelay#get_available_for_group → int
Returns:
  • available – Type: int, Range: [0 to 255]

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.

BrickletIndustrialQuadRelay#set_selected_values(selection_mask, value_mask) → nil
Parameters:
  • selection_mask – Type: int, Range: [0 to 216 - 1]
  • value_mask – Type: int, Range: [0 to 216 - 1]

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.

BrickletIndustrialQuadRelay#get_api_version → [int, ...]
Returns:
  • api_version – Type: [int, ...], Length: 3, Range: [0 to 255]

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletIndustrialQuadRelay#get_response_expected(function_id) → bool
Parameters:
  • function_id – Type: int, Range: See constants
Returns:
  • response_expected – Type: bool

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by #set_response_expected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • BrickletIndustrialQuadRelay::FUNCTION_SET_VALUE = 1
  • BrickletIndustrialQuadRelay::FUNCTION_SET_MONOFLOP = 3
  • BrickletIndustrialQuadRelay::FUNCTION_SET_GROUP = 5
  • BrickletIndustrialQuadRelay::FUNCTION_SET_SELECTED_VALUES = 9
BrickletIndustrialQuadRelay#set_response_expected(function_id, response_expected) → nil
Parameters:
  • function_id – Type: int, Range: See constants
  • response_expected – Type: bool

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • BrickletIndustrialQuadRelay::FUNCTION_SET_VALUE = 1
  • BrickletIndustrialQuadRelay::FUNCTION_SET_MONOFLOP = 3
  • BrickletIndustrialQuadRelay::FUNCTION_SET_GROUP = 5
  • BrickletIndustrialQuadRelay::FUNCTION_SET_SELECTED_VALUES = 9
BrickletIndustrialQuadRelay#set_response_expected_all(response_expected) → nil
Parameters:
  • response_expected – Type: bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

BrickletIndustrialQuadRelay#get_identity → [str, str, chr, [int, ...], [int, ...], int]
Return Array:
  • 0: uid – Type: str, Length: up to 8
  • 1: connected_uid – Type: str, Length: up to 8
  • 2: position – Type: chr
  • 3: hardware_version – Type: [int, ...], Length: 3, Range: [0 to 255]
  • 4: firmware_version – Type: [int, ...], Length: 3, Range: [0 to 255]
  • 5: 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' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

BrickletIndustrialQuadRelay#register_callback(callback_id) { |param [, ...]| block } → nil
Parameters:
  • callback_id – Type: int

Registers the given block with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the #register_callback function of the device object. The first parameter is the callback ID and the second parameter is a block:

industrial_quad_relay.register_callback BrickletIndustrialQuadRelay::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

The available constants with inherent number and type of parameters 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.

BrickletIndustrialQuadRelay::CALLBACK_MONOFLOP_DONE
Callback Parameters:
  • 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).

Constants

BrickletIndustrialQuadRelay::DEVICE_IDENTIFIER

This constant is used to identify a Industrial Quad Relay Bricklet.

The #get_identity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletIndustrialQuadRelay::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Quad Relay Bricklet.