class Tinkerforge::BrickletIO4
4-channel digital input/output
Constants
- CALLBACK_INTERRUPT
This callback is triggered whenever a change of the voltage level is detected on pins where the interrupt was activated with
BrickletIO4#set_interrupt
.The values are a bitmask that specifies which interrupts occurred and the current value bitmask.
For example:
-
(1, 1) or (0b0001, 0b0001) means that an interrupt on pin 0 occurred and currently pin 0 is high and pins 1-3 are low.
-
(9, 14) or (0b1001, 0b1110) means that interrupts on pins 0 and 3 occurred and currently pin 0 is low and pins 1-3 are high.
-
- 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
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
# File lib/tinkerforge/bricklet_io4.rb, line 62 def initialize(uid, ipcon) super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME @api_version = [2, 0, 1] @response_expected[FUNCTION_SET_VALUE] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_CONFIGURATION] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_INTERRUPT] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_INTERRUPT] = 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_SELECTED_VALUES] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_EDGE_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_EDGE_COUNT_CONFIG] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_EDGE_COUNT_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE @callback_formats[CALLBACK_INTERRUPT] = [10, 'C C'] @callback_formats[CALLBACK_MONOFLOP_DONE] = [10, 'C C'] @ipcon.add_device self end
Public Instance Methods
Returns a value bitmask and a direction bitmask. A 1 in the direction bitmask means input and a 0 in the bitmask means output.
For example: A return value of (3, 5) or (0b0011, 0b0101) for direction and value means that:
-
pin 0 is configured as input pull-up,
-
pin 1 is configured as input default,
-
pin 2 is configured as output high and
-
pin 3 is are configured as output low.
# File lib/tinkerforge/bricklet_io4.rb, line 149 def get_configuration check_validity send_request FUNCTION_GET_CONFIGURATION, [], '', 10, 'C C' end
Returns the debounce period as set by BrickletIO4#set_debounce_period
.
# File lib/tinkerforge/bricklet_io4.rb, line 167 def get_debounce_period check_validity send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 12, 'L' end
Returns the current value of the edge counter for the selected pin. You can configure the edges that are counted with BrickletIO4#set_edge_count_config
.
If you set the reset counter to true, the count is set back to 0 directly after it is read.
- .. versionadded
-
2.0.1$nbsp;(Plugin)
# File lib/tinkerforge/bricklet_io4.rb, line 256 def get_edge_count(pin, reset_counter) check_validity send_request FUNCTION_GET_EDGE_COUNT, [pin, reset_counter], 'C ?', 12, 'L' end
Returns the edge type and debounce time for the selected pin as set by BrickletIO4#set_edge_count_config
.
- .. versionadded
-
2.0.1$nbsp;(Plugin)
# File lib/tinkerforge/bricklet_io4.rb, line 287 def get_edge_count_config(pin) check_validity send_request FUNCTION_GET_EDGE_COUNT_CONFIG, [pin], 'C', 10, 'C C' end
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_io4.rb, line 303 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end
Returns the interrupt bitmask as set by BrickletIO4#set_interrupt
.
# File lib/tinkerforge/bricklet_io4.rb, line 188 def get_interrupt check_validity send_request FUNCTION_GET_INTERRUPT, [], '', 9, 'C' end
Returns (for the given pin) the current value and the time as set by BrickletIO4#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_io4.rb, line 224 def get_monoflop(pin) check_validity send_request FUNCTION_GET_MONOFLOP, [pin], 'C', 17, 'C L L' end
Returns a bitmask of the values that are currently measured. This function works if the pin is configured to input as well as if it is configured to output.
# File lib/tinkerforge/bricklet_io4.rb, line 109 def get_value check_validity send_request FUNCTION_GET_VALUE, [], '', 9, 'C' end
Registers a callback with ID id
to the block block
.
# File lib/tinkerforge/bricklet_io4.rb, line 308 def register_callback(id, &block) callback = block @registered_callbacks[id] = callback end
Configures the value and direction of the specified pins. 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:
-
(15, 'i', true) or (0b1111, 'i', true) will set all pins of as input pull-up.
-
(8, 'i', false) or (0b1000, 'i', false) will set pin 3 of as input default (floating if nothing is connected).
-
(3, 'o', false) or (0b0011, 'o', false) will set pins 0 and 1 as output low.
-
(4, 'o', true) or (0b0100, 'o', true) will set pin 2 of as output high.
Running monoflop timers for the specified pins will be aborted if this function is called.
# File lib/tinkerforge/bricklet_io4.rb, line 133 def set_configuration(selection_mask, direction, value) check_validity send_request FUNCTION_SET_CONFIGURATION, [selection_mask, direction, value], 'C k ?', 8, '' end
Sets the debounce period of the CALLBACK_INTERRUPT
callback.
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-4 Bricklet, such as a button.
# File lib/tinkerforge/bricklet_io4.rb, line 160 def set_debounce_period(debounce) check_validity send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 8, '' end
Configures the edge counter for the selected pins.
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
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.
- .. versionadded
-
2.0.1$nbsp;(Plugin)
# File lib/tinkerforge/bricklet_io4.rb, line 277 def set_edge_count_config(selection_mask, edge_type, debounce) check_validity send_request FUNCTION_SET_EDGE_COUNT_CONFIG, [selection_mask, edge_type, debounce], 'C C C', 8, '' end
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: An interrupt bitmask of 10 or 0b1010 will enable the interrupt for pins 1 and 3.
The interrupt is delivered with the CALLBACK_INTERRUPT
callback.
# File lib/tinkerforge/bricklet_io4.rb, line 181 def set_interrupt(interrupt_mask) check_validity send_request FUNCTION_SET_INTERRUPT, [interrupt_mask], 'C', 8, '' end
Configures a monoflop of the pins specified by the first parameter as 4 bit long bitmask. The specified pins must be configured for output. Non-output pins will be ignored.
The second 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 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 get high and pin 3 will get low. 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-4 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.
# File lib/tinkerforge/bricklet_io4.rb, line 213 def set_monoflop(selection_mask, value_mask, time) check_validity send_request FUNCTION_SET_MONOFLOP, [selection_mask, value_mask, time], 'C C L', 8, '' end
Sets the output value (high or low) with a bitmask, according to the selection mask. The bitmask is 4 bit long, true refers to high and false refers to low.
For example: The parameters (9, 4) or (0b0110, 0b0100) will turn pin 1 low and pin 2 high, pin 0 and 3 will remain untouched.
Running monoflop timers for the selected pins will be aborted if this function is called.
- .. note
-
This function does nothing for pins that are configured as input. Pull-up resistors can be switched on with
BrickletIO4#set_configuration
.
# File lib/tinkerforge/bricklet_io4.rb, line 243 def set_selected_values(selection_mask, value_mask) check_validity send_request FUNCTION_SET_SELECTED_VALUES, [selection_mask, value_mask], 'C C', 8, '' end
Sets the output value (high or low) with a bitmask (4bit). A 1 in the bitmask means high and a 0 in the bitmask means low.
For example: The value 3 or 0b0011 will turn the pins 0-1 high and the pins 2-3 low.
All running monoflop timers will be aborted if this function is called.
- .. note
-
This function does nothing for pins that are configured as input. Pull-up resistors can be switched on with
BrickletIO4#set_configuration
.
# File lib/tinkerforge/bricklet_io4.rb, line 100 def set_value(value_mask) check_validity send_request FUNCTION_SET_VALUE, [value_mask], 'C', 8, '' end