Class: Tinkerforge::BrickletIO16

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

Overview

16-channel digital input/output

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

28
DEVICE_DISPLAY_NAME =

:nodoc:

'IO-16 Bricklet'
CALLBACK_INTERRUPT =

This callback is triggered whenever a change of the voltage level is detected on pins where the interrupt was activated with BrickletIO16#set_port_interrupt.

The values are the port, a bitmask that specifies which interrupts occurred and the current value bitmask of the port.

For example:

  • (‘a’, 1, 1) or (‘a’, 0b00000001, 0b00000001) means that on port A an interrupt on pin 0 occurred and currently pin 0 is high and pins 1-7 are low.

  • (‘b’, 129, 254) or (‘b’, 0b10000001, 0b11111110) means that on port B interrupts on pins 0 and 7 occurred and currently pin 0 is low and pins 1-7 are high.

9
CALLBACK_MONOFLOP_DONE =

This callback is triggered whenever a monoflop timer reaches 0. The parameters contain the port, the involved pins and the current value of the pins (the value after the monoflop).

12
FUNCTION_SET_PORT =

:nodoc:

1
FUNCTION_GET_PORT =

:nodoc:

2
FUNCTION_SET_PORT_CONFIGURATION =

:nodoc:

3
FUNCTION_GET_PORT_CONFIGURATION =

:nodoc:

4
FUNCTION_SET_DEBOUNCE_PERIOD =

:nodoc:

5
FUNCTION_GET_DEBOUNCE_PERIOD =

:nodoc:

6
FUNCTION_SET_PORT_INTERRUPT =

:nodoc:

7
FUNCTION_GET_PORT_INTERRUPT =

:nodoc:

8
FUNCTION_SET_PORT_MONOFLOP =

:nodoc:

10
FUNCTION_GET_PORT_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) ⇒ BrickletIO16

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



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
89
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 64

def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 1]

  @response_expected[FUNCTION_SET_PORT] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_PORT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_PORT_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_PORT_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_PORT_INTERRUPT] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_PORT_INTERRUPT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_PORT_MONOFLOP] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_PORT_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] = [11, 'k C C']
  @callback_formats[CALLBACK_MONOFLOP_DONE] = [11, 'k C C']

  @ipcon.add_device self
end

Instance Method Details

#get_debounce_period ⇒ Object

Returns the debounce period as set by BrickletIO16#set_debounce_period.



170
171
172
173
174
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 170

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 on port A. You can configure the edges that are counted with BrickletIO16#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.3$nbsp;(Plugin)



260
261
262
263
264
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 260

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 of port A as set by BrickletIO16#set_edge_count_config.

.. versionadded

2.0.3$nbsp;(Plugin)



292
293
294
295
296
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 292

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|



308
309
310
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 308

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

#get_port(port) ⇒ Object

Returns a bitmask of the values that are currently measured on the specified port. This function works if the pin is configured to input as well as if it is configured to output.



112
113
114
115
116
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 112

def get_port(port)
  check_validity

  send_request FUNCTION_GET_PORT, [port], 'k', 9, 'C'
end

#get_port_configuration(port) ⇒ Object

Returns a direction bitmask and a value bitmask for the specified port. A 1 in the direction bitmask means input and a 0 in the bitmask means output.

For example: A return value of (15, 51) or (0b00001111, 0b00110011) for direction and value means that:

  • pins 0 and 1 are configured as input pull-up,

  • pins 2 and 3 are configured as input default,

  • pins 4 and 5 are configured as output high

  • and pins 6 and 7 are configured as output low.



152
153
154
155
156
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 152

def get_port_configuration(port)
  check_validity

  send_request FUNCTION_GET_PORT_CONFIGURATION, [port], 'k', 10, 'C C'
end

#get_port_interrupt(port) ⇒ Object

Returns the interrupt bitmask for the specified port as set by BrickletIO16#set_port_interrupt.



192
193
194
195
196
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 192

def get_port_interrupt(port)
  check_validity

  send_request FUNCTION_GET_PORT_INTERRUPT, [port], 'k', 9, 'C'
end

#get_port_monoflop(port, pin) ⇒ Object

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



228
229
230
231
232
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 228

def get_port_monoflop(port, pin)
  check_validity

  send_request FUNCTION_GET_PORT_MONOFLOP, [port, pin], 'k C', 17, 'C L L'
end

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



313
314
315
316
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 313

def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
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-16 Bricklet, such as a button.



163
164
165
166
167
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 163

def set_debounce_period(debounce)
  check_validity

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

#set_edge_count_config(pin, edge_type, debounce) ⇒ Object

Configures the edge counter for the selected pin of port A. Pins 0 and 1 are available for edge counting.

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

  • 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.3$nbsp;(Plugin)



282
283
284
285
286
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 282

def set_edge_count_config(pin, edge_type, debounce)
  check_validity

  send_request FUNCTION_SET_EDGE_COUNT_CONFIG, [pin, edge_type, debounce], 'C C C', 8, ''
end

#set_port(port, value_mask) ⇒ Object

Sets the output value (high or low) for a port (“a” or “b”) with a bitmask (8bit). A 1 in the bitmask means high and a 0 in the bitmask means low.

For example: The value 15 or 0b00001111 will turn the pins 0-3 high and the pins 4-7 low for the specified port.

All running monoflop timers of the given port 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 BrickletIO16#set_port_configuration.



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

def set_port(port, value_mask)
  check_validity

  send_request FUNCTION_SET_PORT, [port, value_mask], 'k C', 8, ''
end

#set_port_configuration(port, selection_mask, direction, value) ⇒ Object

Configures the value and direction of a specified port. 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:

  • (‘a’, 255, ‘i’, true) or (‘a’, 0b11111111, ‘i’, true) will set all pins of port A as input pull-up.

  • (‘a’, 128, ‘i’, false) or (‘a’, 0b10000000, ‘i’, false) will set pin 7 of port A as input default (floating if nothing is connected).

  • (‘b’, 3, ‘o’, false) or (‘b’, 0b00000011, ‘o’, false) will set pins 0 and 1 of port B as output low.

  • (‘b’, 4, ‘o’, true) or (‘b’, 0b00000100, ‘o’, true) will set pin 2 of port B as output high.

Running monoflop timers for the selected pins will be aborted if this function is called.



136
137
138
139
140
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 136

def set_port_configuration(port, selection_mask, direction, value)
  check_validity

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

#set_port_interrupt(port, 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: (‘a’, 129) or (‘a’, 0b10000001) will enable the interrupt for pins 0 and 7 of port a.

The interrupt is delivered with the CALLBACK_INTERRUPT callback.



184
185
186
187
188
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 184

def set_port_interrupt(port, interrupt_mask)
  check_validity

  send_request FUNCTION_SET_PORT_INTERRUPT, [port, interrupt_mask], 'k C', 8, ''
end

#set_port_monoflop(port, selection_mask, value_mask, time) ⇒ Object

Configures a monoflop of the pins specified by the second parameter as 8 bit long bitmask. The specified pins must be configured for output. Non-output pins will be ignored.

The third 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 forth parameter indicates the time that the pins should hold the value.

If this function is called with the parameters (‘a’, 9, 1, 1500) or (‘a’, 0b00001001, 0b00000001, 1500): Pin 0 will get high and pin 3 will get low on port ‘a’. 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-16 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.



217
218
219
220
221
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 217

def set_port_monoflop(port, selection_mask, value_mask, time)
  check_validity

  send_request FUNCTION_SET_PORT_MONOFLOP, [port, selection_mask, value_mask, time], 'k C C L', 8, ''
end

#set_selected_values(port, selection_mask, value_mask) ⇒ Object

Sets the output value (high or low) for a port (“a” or “b” with a bitmask, according to the selection mask. The bitmask is 8 bit long and a 1 in the bitmask means high and a 0 in the bitmask means low.

For example: The parameters (‘a’, 192, 128) or (‘a’, 0b11000000, 0b10000000) will turn pin 7 high and pin 6 low on port A, pins 0-6 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 BrickletIO16#set_port_configuration.



247
248
249
250
251
 
# File 'lib/tinkerforge/bricklet_io16.rb', line 247

def set_selected_values(port, selection_mask, value_mask)
  check_validity

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