Class: Tinkerforge::BrickletIO4

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

Overview

4-channel digital input/output

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

29
DEVICE_DISPLAY_NAME =

:nodoc:

'IO-4 Bricklet'
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.

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

12
FUNCTION_SET_VALUE =

:nodoc:

1
FUNCTION_GET_VALUE =

:nodoc:

2
FUNCTION_SET_CONFIGURATION =

:nodoc:

3
FUNCTION_GET_CONFIGURATION =

:nodoc:

4
FUNCTION_SET_DEBOUNCE_PERIOD =

:nodoc:

5
FUNCTION_GET_DEBOUNCE_PERIOD =

:nodoc:

6
FUNCTION_SET_INTERRUPT =

:nodoc:

7
FUNCTION_GET_INTERRUPT =

:nodoc:

8
FUNCTION_SET_MONOFLOP =

:nodoc:

10
FUNCTION_GET_MONOFLOP =

:nodoc:

11
FUNCTION_SET_SELECTED_VALUES =

:nodoc:

13
FUNCTION_GET_EDGE_COUNT =

:nodoc:

14
FUNCTION_SET_EDGE_COUNT_CONFIG =

:nodoc:

15
FUNCTION_GET_EDGE_COUNT_CONFIG =

:nodoc:

16
FUNCTION_GET_IDENTITY =

:nodoc:

255
DIRECTION_IN =

:nodoc:

'i'
DIRECTION_OUT =

:nodoc:

'o'
EDGE_TYPE_RISING =

:nodoc:

0
EDGE_TYPE_FALLING =

:nodoc:

1
EDGE_TYPE_BOTH =

:nodoc:

2

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

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 63

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

Instance Method Details

#get_configuration ⇒ Object

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.



150
151
152
153
154
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 150

def get_configuration
  check_validity

  send_request FUNCTION_GET_CONFIGURATION, [], '', 10, 'C C'
end

#get_debounce_period ⇒ Object

Returns the debounce period as set by BrickletIO4#set_debounce_period.



168
169
170
171
172
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 168

def get_debounce_period
  check_validity

  send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 12, 'L'
end

#get_edge_count(pin, reset_counter) ⇒ Object

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)



257
258
259
260
261
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 257

def get_edge_count(pin, reset_counter)
  check_validity

  send_request FUNCTION_GET_EDGE_COUNT, [pin, reset_counter], 'C ?', 12, 'L'
end

#get_edge_count_config(pin) ⇒ Object

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)



288
289
290
291
292
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 288

def get_edge_count_config(pin)
  check_validity

  send_request FUNCTION_GET_EDGE_COUNT_CONFIG, [pin], 'C', 10, 'C C'
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|



304
305
306
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 304

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

#get_interrupt ⇒ Object

Returns the interrupt bitmask as set by BrickletIO4#set_interrupt.



189
190
191
192
193
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 189

def get_interrupt
  check_validity

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

#get_monoflop(pin) ⇒ Object

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.



225
226
227
228
229
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 225

def get_monoflop(pin)
  check_validity

  send_request FUNCTION_GET_MONOFLOP, [pin], 'C', 17, 'C L L'
end

#get_value ⇒ Object

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.



110
111
112
113
114
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 110

def get_value
  check_validity

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

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



309
310
311
312
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 309

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

#set_configuration(selection_mask, direction, value) ⇒ Object

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.



134
135
136
137
138
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 134

def set_configuration(selection_mask, direction, value)
  check_validity

  send_request FUNCTION_SET_CONFIGURATION, [selection_mask, direction, value], 'C k ?', 8, ''
end

#set_debounce_period(debounce) ⇒ Object

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.



161
162
163
164
165
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 161

def set_debounce_period(debounce)
  check_validity

  send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 8, ''
end

#set_edge_count_config(selection_mask, edge_type, debounce) ⇒ Object

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)



278
279
280
281
282
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 278

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

#set_interrupt(interrupt_mask) ⇒ Object

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.



182
183
184
185
186
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 182

def set_interrupt(interrupt_mask)
  check_validity

  send_request FUNCTION_SET_INTERRUPT, [interrupt_mask], 'C', 8, ''
end

#set_monoflop(selection_mask, value_mask, time) ⇒ Object

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.



214
215
216
217
218
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 214

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

#set_selected_values(selection_mask, value_mask) ⇒ Object

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.



244
245
246
247
248
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 244

def set_selected_values(selection_mask, value_mask)
  check_validity

  send_request FUNCTION_SET_SELECTED_VALUES, [selection_mask, value_mask], 'C C', 8, ''
end

#set_value(value_mask) ⇒ Object

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.



101
102
103
104
105
 
# File 'lib/tinkerforge/bricklet_io4.rb', line 101

def set_value(value_mask)
  check_validity

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