Ruby - Industrial Digital In 4 Bricklet

This is the description of the Ruby API bindings for the Industrial Digital In 4 Bricklet. General information and technical specifications for the Industrial Digital In 4 Bricklet are summarized in its hardware description.

An installation guide for the Ruby API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (example_simple.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_digital_in_4'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Industrial Digital In 4 Bricklet

ipcon = IPConnection.new # Create IP connection
idi4 = BrickletIndustrialDigitalIn4.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Get current value as bitmask
value_mask = idi4.get_value
puts "Value Mask: #{'%04b' % value_mask}"

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Interrupt

Download (example_interrupt.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_digital_in_4'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Industrial Digital In 4 Bricklet

ipcon = IPConnection.new # Create IP connection
idi4 = BrickletIndustrialDigitalIn4.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register interrupt callback
idi4.register_callback(BrickletIndustrialDigitalIn4::CALLBACK_INTERRUPT) do |interrupt_mask,
                                                                             value_mask|
  puts "Interrupt Mask: #{'%04b' % interrupt_mask}"
  puts "Value Mask: #{'%04b' % value_mask}"
  puts ''
end

# Enable interrupt on pin 0
idi4.set_interrupt 1 << 0

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API

All methods listed below are thread-safe.

Basic Functions

BrickletIndustrialDigitalIn4::new(uid, ipcon) → industrial_digital_in_4
Parameters:
  • uid – Type: str
  • ipcon – Type: IPConnection
Returns:
  • industrial_digital_in_4 – Type: BrickletIndustrialDigitalIn4

Creates an object with the unique device ID uid:

industrial_digital_in_4 = BrickletIndustrialDigitalIn4.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected (see examples above).

BrickletIndustrialDigitalIn4#get_value → int
Returns:
  • value_mask – Type: int, Range: [0 to 216 - 1]

Returns the input value with a bitmask. The bitmask is 16bit long, true refers to high and false refers to low.

For example: The value 3 or 0b0011 means that pins 0-1 are high and the other pins are low.

If no groups are used (see #set_group), the pins correspond to the markings on the IndustrialDigital In 4 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.

BrickletIndustrialDigitalIn4#get_edge_count(pin, reset_counter) → int
Parameters:
  • pin – Type: int, Range: [0 to 255]
  • reset_counter – Type: bool
Returns:
  • count – Type: int, Range: [0 to 232 - 1]

Returns the current value of the edge counter for the selected pin. You can configure the edges that are counted with #set_edge_count_config.

If you set the reset counter to true, the count is set back to 0 directly after it is read.

New in version 2.0.1 (Plugin).

Advanced Functions

BrickletIndustrialDigitalIn4#set_group(group) → nil
Parameters:
  • group – Type: [chr, ...], Length: 4

Sets a group of Digital In 4 Bricklets that should work together. You can find Bricklets that can be grouped together with #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 Digital In 4 Bricklets connected to port A and port B respectively, you could call with ['a', 'b', 'n', 'n'].

Now the pins on the Digital In 4 on port A are assigned to 0-3 and the pins on the Digital In 4 on port B are assigned to 4-7. It is now possible to call #get_value and read out two Bricklets at the same time.

Changing the group configuration resets all edge counter configurations and values.

BrickletIndustrialDigitalIn4#get_group → [chr, ...]
Returns:
  • group – Type: [chr, ...], Length: 4

Returns the group as set by #set_group

BrickletIndustrialDigitalIn4#get_available_for_group → int
Returns:
  • available – Type: int, Range: [0 to 255]

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.

BrickletIndustrialDigitalIn4#set_edge_count_config(selection_mask, edge_type, debounce) → nil
Parameters:
  • selection_mask – Type: int, Range: [0 to 216 - 1]
  • edge_type – Type: int, Range: See constants
  • debounce – Type: int, Range: [0 to 255]

Configures the edge counter for the selected pins. A bitmask of 9 or 0b1001 will enable the edge counter for pins 0 and 3.

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

The debounce time is given in ms.

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.

Default values: 0 (edge type) and 100ms (debounce time)

The following constants are available for this function:

For edge_type:

  • BrickletIndustrialDigitalIn4::EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4::EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4::EDGE_TYPE_BOTH = 2

New in version 2.0.1 (Plugin).

BrickletIndustrialDigitalIn4#get_edge_count_config(pin) → [int, int]
Parameters:
  • pin – Type: int, Range: [0 to 255]
Return Array:
  • 0: edge_type – Type: int, Range: See constants
  • 1: debounce – Type: int, Range: [0 to 255]

Returns the edge type and debounce time for the selected pin as set by #set_edge_count_config.

The following constants are available for this function:

For edge_type:

  • BrickletIndustrialDigitalIn4::EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4::EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4::EDGE_TYPE_BOTH = 2

New in version 2.0.1 (Plugin).

BrickletIndustrialDigitalIn4#get_api_version → [int, ...]
Returns:
  • api_version – Type: [int, ...], Length: 3, Range: [0 to 255]

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletIndustrialDigitalIn4#get_response_expected(function_id) → bool
Parameters:
  • function_id – Type: int, Range: See constants
Returns:
  • response_expected – Type: bool

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by #set_response_expected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • BrickletIndustrialDigitalIn4::FUNCTION_SET_GROUP = 2
  • BrickletIndustrialDigitalIn4::FUNCTION_SET_DEBOUNCE_PERIOD = 5
  • BrickletIndustrialDigitalIn4::FUNCTION_SET_INTERRUPT = 7
  • BrickletIndustrialDigitalIn4::FUNCTION_SET_EDGE_COUNT_CONFIG = 11
BrickletIndustrialDigitalIn4#set_response_expected(function_id, response_expected) → nil
Parameters:
  • function_id – Type: int, Range: See constants
  • response_expected – Type: bool

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • BrickletIndustrialDigitalIn4::FUNCTION_SET_GROUP = 2
  • BrickletIndustrialDigitalIn4::FUNCTION_SET_DEBOUNCE_PERIOD = 5
  • BrickletIndustrialDigitalIn4::FUNCTION_SET_INTERRUPT = 7
  • BrickletIndustrialDigitalIn4::FUNCTION_SET_EDGE_COUNT_CONFIG = 11
BrickletIndustrialDigitalIn4#set_response_expected_all(response_expected) → nil
Parameters:
  • response_expected – Type: bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

BrickletIndustrialDigitalIn4#get_identity → [str, str, chr, [int, ...], [int, ...], int]
Return Array:
  • 0: uid – Type: str, Length: up to 8
  • 1: connected_uid – Type: str, Length: up to 8
  • 2: position – Type: chr
  • 3: hardware_version – Type: [int, ...], Length: 3, Range: [0 to 255]
  • 4: firmware_version – Type: [int, ...], Length: 3, Range: [0 to 255]
  • 5: device_identifier – Type: int, Range: [0 to 216 - 1]

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' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

BrickletIndustrialDigitalIn4#register_callback(callback_id) { |param [, ...]| block } → nil
Parameters:
  • callback_id – Type: int

Registers the given block with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletIndustrialDigitalIn4#set_debounce_period(debounce) → nil
Parameters:
  • debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

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 Digital In 4 Bricklet, such as a button.

BrickletIndustrialDigitalIn4#get_debounce_period → int
Returns:
  • debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by #set_debounce_period.

BrickletIndustrialDigitalIn4#set_interrupt(interrupt_mask) → nil
Parameters:
  • interrupt_mask – Type: int, Range: [0 to 216 - 1]

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 9 or 0b1001 will enable the interrupt for pins 0 and 3.

The interrupts use the grouping as set by #set_group.

The interrupt is delivered with the ::CALLBACK_INTERRUPT callback.

BrickletIndustrialDigitalIn4#get_interrupt → int
Returns:
  • interrupt_mask – Type: int, Range: [0 to 216 - 1]

Returns the interrupt bitmask as set by #set_interrupt.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the #register_callback function of the device object. The first parameter is the callback ID and the second parameter is a block:

industrial_digital_in_4.register_callback BrickletIndustrialDigitalIn4::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

The available constants with inherent number and type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

BrickletIndustrialDigitalIn4::CALLBACK_INTERRUPT
Callback Parameters:
  • interrupt_mask – Type: int, Range: [0 to 216 - 1]
  • value_mask – Type: int, Range: [0 to 216 - 1]

This callback is triggered whenever a change of the voltage level is detected on pins where the interrupt was activated with #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.

Constants

BrickletIndustrialDigitalIn4::DEVICE_IDENTIFIER

This constant is used to identify a Industrial Digital In 4 Bricklet.

The #get_identity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletIndustrialDigitalIn4::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Digital In 4 Bricklet.