class Tinkerforge::BrickletIndustrialQuadRelay

4 galvanically isolated solid state relays

Constants

CALLBACK_MONOFLOP_DONE

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).

Public Class Methods

new(uid, ipcon) click to toggle source

Creates an object with the unique device ID uid and adds it to the IP Connection ipcon.

Calls superclass method
# File lib/tinkerforge/bricklet_industrial_quad_relay.rb, line 37
def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_SET_VALUE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_MONOFLOP] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_MONOFLOP] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_GROUP] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_GROUP] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_AVAILABLE_FOR_GROUP] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_SELECTED_VALUES] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_MONOFLOP_DONE] = [12, 'S S']

  @ipcon.add_device self
end

Public Instance Methods

get_available_for_group() click to toggle source

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.

# File lib/tinkerforge/bricklet_industrial_quad_relay.rb, line 150
def get_available_for_group
  check_validity

  send_request FUNCTION_GET_AVAILABLE_FOR_GROUP, [], '', 9, 'C'
end
get_group() click to toggle source

Returns the group as set by BrickletIndustrialQuadRelay#set_group

# File lib/tinkerforge/bricklet_industrial_quad_relay.rb, line 141
def get_group
  check_validity

  send_request FUNCTION_GET_GROUP, [], '', 12, 'k4'
end
get_identity() click to toggle source

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 :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|

# File lib/tinkerforge/bricklet_industrial_quad_relay.rb, line 188
def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end
get_monoflop(pin) click to toggle source

Returns (for the given pin) the current value and the time as set by BrickletIndustrialQuadRelay#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.

# File lib/tinkerforge/bricklet_industrial_quad_relay.rb, line 113
def get_monoflop(pin)
  check_validity

  send_request FUNCTION_GET_MONOFLOP, [pin], 'C', 18, 'S L L'
end
get_value() click to toggle source

Returns the bitmask as set by BrickletIndustrialQuadRelay#set_value.

# File lib/tinkerforge/bricklet_industrial_quad_relay.rb, line 78
def get_value
  check_validity

  send_request FUNCTION_GET_VALUE, [], '', 10, 'S'
end
register_callback(id, &block) click to toggle source

Registers a callback with ID id to the block block.

# File lib/tinkerforge/bricklet_industrial_quad_relay.rb, line 193
def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end
set_group(group) click to toggle source

Sets a group of Quad Relay Bricklets that should work together. You can find Bricklets that can be grouped together with BrickletIndustrialQuadRelay#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 BrickletIndustrialQuadRelay#set_value and control two Bricklets at the same time.

# File lib/tinkerforge/bricklet_industrial_quad_relay.rb, line 134
def set_group(group)
  check_validity

  send_request FUNCTION_SET_GROUP, [group], 'k4', 8, ''
end
set_monoflop(selection_mask, value_mask, time) click to toggle source

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.

# File lib/tinkerforge/bricklet_industrial_quad_relay.rb, line 102
def set_monoflop(selection_mask, value_mask, time)
  check_validity

  send_request FUNCTION_SET_MONOFLOP, [selection_mask, value_mask, time], 'S S L', 8, ''
end
set_selected_values(selection_mask, value_mask) click to toggle source

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 BrickletIndustrialQuadRelay#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.

# File lib/tinkerforge/bricklet_industrial_quad_relay.rb, line 172
def set_selected_values(selection_mask, value_mask)
  check_validity

  send_request FUNCTION_SET_SELECTED_VALUES, [selection_mask, value_mask], 'S S', 8, ''
end
set_value(value_mask) click to toggle source

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 BrickletIndustrialQuadRelay#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.

# File lib/tinkerforge/bricklet_industrial_quad_relay.rb, line 71
def set_value(value_mask)
  check_validity

  send_request FUNCTION_SET_VALUE, [value_mask], 'S', 8, ''
end