Class: Tinkerforge::BrickletIndustrialQuadRelay

Inherits:
Device
  • Object
show all
Defined in:
lib/tinkerforge/bricklet_industrial_quad_relay.rb

Overview

4 galvanically isolated solid state relays

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

225
DEVICE_DISPLAY_NAME =

:nodoc:

'Industrial Quad Relay Bricklet'
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).

8
FUNCTION_SET_VALUE =

:nodoc:

1
FUNCTION_GET_VALUE =

:nodoc:

2
FUNCTION_SET_MONOFLOP =

:nodoc:

3
FUNCTION_GET_MONOFLOP =

:nodoc:

4
FUNCTION_SET_GROUP =

:nodoc:

5
FUNCTION_GET_GROUP =

:nodoc:

6
FUNCTION_GET_AVAILABLE_FOR_GROUP =

:nodoc:

7
FUNCTION_SET_SELECTED_VALUES =

:nodoc:

9
FUNCTION_GET_IDENTITY =

:nodoc:

255

Constants inherited from Device

Device::DEVICE_IDENTIFIER_CHECK_MATCH, Device::DEVICE_IDENTIFIER_CHECK_MISMATCH, Device::DEVICE_IDENTIFIER_CHECK_PENDING, Device::RESPONSE_EXPECTED_ALWAYS_TRUE, Device::RESPONSE_EXPECTED_FALSE, Device::RESPONSE_EXPECTED_INVALID_FUNCTION_ID, Device::RESPONSE_EXPECTED_TRUE

Instance Attribute Summary

Attributes inherited from Device

#callback_formats, #expected_response_function_id, #expected_response_sequence_number, #high_level_callbacks, #registered_callbacks, #replaced, #uid

Instance Method Summary collapse

Methods inherited from Device

#check_validity, #dequeue_response, #enqueue_response, #get_api_version, #get_response_expected, #send_request, #set_response_expected, #set_response_expected_all

Constructor Details

#initialize(uid, ipcon) ⇒ BrickletIndustrialQuadRelay

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



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/tinkerforge/bricklet_industrial_quad_relay.rb', line 38

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

Instance Method Details

#get_available_for_group ⇒ Object

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.



151
152
153
154
155
 
# File 'lib/tinkerforge/bricklet_industrial_quad_relay.rb', line 151

def get_available_for_group
  check_validity

  send_request FUNCTION_GET_AVAILABLE_FOR_GROUP, [], '', 9, 'C'
end

#get_group ⇒ Object

Returns the group as set by BrickletIndustrialQuadRelay#set_group



142
143
144
145
146
 
# File 'lib/tinkerforge/bricklet_industrial_quad_relay.rb', line 142

def get_group
  check_validity

  send_request FUNCTION_GET_GROUP, [], '', 12, 'k4'
end

#get_identity ⇒ Object

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|



189
190
191
 
# File 'lib/tinkerforge/bricklet_industrial_quad_relay.rb', line 189

def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end

#get_monoflop(pin) ⇒ Object

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.



114
115
116
117
118
 
# File 'lib/tinkerforge/bricklet_industrial_quad_relay.rb', line 114

def get_monoflop(pin)
  check_validity

  send_request FUNCTION_GET_MONOFLOP, [pin], 'C', 18, 'S L L'
end

#get_value ⇒ Object

Returns the bitmask as set by BrickletIndustrialQuadRelay#set_value.



79
80
81
82
83
 
# File 'lib/tinkerforge/bricklet_industrial_quad_relay.rb', line 79

def get_value
  check_validity

  send_request FUNCTION_GET_VALUE, [], '', 10, 'S'
end

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



194
195
196
197
 
# File 'lib/tinkerforge/bricklet_industrial_quad_relay.rb', line 194

def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end

#set_group(group) ⇒ Object

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.



135
136
137
138
139
 
# File 'lib/tinkerforge/bricklet_industrial_quad_relay.rb', line 135

def set_group(group)
  check_validity

  send_request FUNCTION_SET_GROUP, [group], 'k4', 8, ''
end

#set_monoflop(selection_mask, value_mask, time) ⇒ Object

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.



103
104
105
106
107
 
# File 'lib/tinkerforge/bricklet_industrial_quad_relay.rb', line 103

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) ⇒ Object

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.



173
174
175
176
177
 
# File 'lib/tinkerforge/bricklet_industrial_quad_relay.rb', line 173

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) ⇒ Object

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.



72
73
74
75
76
 
# File 'lib/tinkerforge/bricklet_industrial_quad_relay.rb', line 72

def set_value(value_mask)
  check_validity

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