Ruby - Industrial Dual Analog In Bricklet

This is the description of the Ruby API bindings for the Industrial Dual Analog In Bricklet. General information and technical specifications for the Industrial Dual Analog In 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_dual_analog_in'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
idai = BrickletIndustrialDualAnalogIn.new UID, ipcon # Create device object

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

# Get current voltage from channel 1
voltage = idai.get_voltage 1
puts "Voltage (Channel 1): #{voltage/1000.0} V"

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

Callback

Download (example_callback.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
33
34
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_dual_analog_in'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
idai = BrickletIndustrialDualAnalogIn.new UID, ipcon # Create device object

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

# Register voltage callback
idai.register_callback(BrickletIndustrialDualAnalogIn::CALLBACK_VOLTAGE) do |channel,
                                                                             voltage|
  puts "Channel: #{channel}"
  puts "Voltage: #{voltage/1000.0} V"
  puts ''
end

# Set period for voltage (channel 1) callback to 1s (1000ms)
# Note: The voltage (channel 1) callback is only called every second
#       if the voltage (channel 1) has changed since the last call!
idai.set_voltage_callback_period 1, 1000

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

Threshold

Download (example_threshold.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
33
34
35
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_dual_analog_in'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
idai = BrickletIndustrialDualAnalogIn.new UID, ipcon # Create device object

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

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
idai.set_debounce_period 10000

# Register voltage reached callback
idai.register_callback(BrickletIndustrialDualAnalogIn::CALLBACK_VOLTAGE_REACHED) do |channel,
                                                                                     voltage|
  puts "Channel: #{channel}"
  puts "Voltage: #{voltage/1000.0} V"
  puts ''
end

# Configure threshold for voltage (channel 1) "greater than 10 V"
idai.set_voltage_callback_threshold 1, '>', 10*1000, 0

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

API

All methods listed below are thread-safe.

The Bricklet has two input channel. Functions that are related directly to a channel have a channel parameter to specify one of the two channels. Valid values for the channel parameter are 0 and 1.

Basic Functions

BrickletIndustrialDualAnalogIn::new(uid, ipcon) → industrial_dual_analog_in
Parameters:
  • uid -- str
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

industrial_dual_analog_in = BrickletIndustrialDualAnalogIn.new 'YOUR_DEVICE_UID', ipcon

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

BrickletIndustrialDualAnalogIn#get_voltage(channel) → int
Parameters:channel -- int

Returns the voltage for the given channel in mV.

If you want to get the voltage periodically, it is recommended to use the ::CALLBACK_VOLTAGE callback and set the period with #set_voltage_callback_period.

Advanced Functions

BrickletIndustrialDualAnalogIn#set_sample_rate(rate) → nil
Parameters:rate -- int

Sets the sample rate. The sample rate can be between 1 sample per second and 976 samples per second. Decreasing the sample rate will also decrease the noise on the data.

The default value is 6 (2 samples per second).

The following constants are available for this function:

  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_976_SPS = 0
  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_488_SPS = 1
  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_244_SPS = 2
  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_122_SPS = 3
  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_61_SPS = 4
  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_4_SPS = 5
  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_2_SPS = 6
  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_1_SPS = 7
BrickletIndustrialDualAnalogIn#get_sample_rate → int

Returns the sample rate as set by #set_sample_rate.

The following constants are available for this function:

  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_976_SPS = 0
  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_488_SPS = 1
  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_244_SPS = 2
  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_122_SPS = 3
  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_61_SPS = 4
  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_4_SPS = 5
  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_2_SPS = 6
  • BrickletIndustrialDualAnalogIn::SAMPLE_RATE_1_SPS = 7
BrickletIndustrialDualAnalogIn#set_calibration(offset, gain) → nil
Parameters:
  • offset -- [int, int]
  • gain -- [int, int]

Sets offset and gain of MCP3911 internal calibration registers.

See MCP3911 datasheet 7.7 and 7.8. The Industrial Dual Analog In Bricklet is already factory calibrated by Tinkerforge. It should not be necessary for you to use this function

BrickletIndustrialDualAnalogIn#get_calibration → [[int, int], [int, int]]

Returns the calibration as set by #set_calibration.

The returned array has the values offset and gain.

BrickletIndustrialDualAnalogIn#get_adc_values → [int, int]

Returns the ADC values as given by the MCP3911 IC. This function is needed for proper calibration, see #set_calibration.

BrickletIndustrialDualAnalogIn#get_api_version → [int, int, int]

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.

BrickletIndustrialDualAnalogIn#get_response_expected(function_id) → bool
Parameters:function_id -- int

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.

See #set_response_expected for the list of function ID constants available for this function.

BrickletIndustrialDualAnalogIn#set_response_expected(function_id, response_expected) → nil
Parameters:
  • function_id -- int
  • response_expected -- 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 function ID constants are available for this function:

  • BrickletIndustrialDualAnalogIn::FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 2
  • BrickletIndustrialDualAnalogIn::FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 4
  • BrickletIndustrialDualAnalogIn::FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletIndustrialDualAnalogIn::FUNCTION_SET_SAMPLE_RATE = 8
  • BrickletIndustrialDualAnalogIn::FUNCTION_SET_CALIBRATION = 10
BrickletIndustrialDualAnalogIn#set_response_expected_all(response_expected) → nil
Parameters:response_expected -- bool

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

BrickletIndustrialDualAnalogIn#get_identity → [str, str, str, [int, int, int], [int, int, int], int]

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.

The returned array has the values uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

BrickletIndustrialDualAnalogIn#register_callback(callback_id) { |param [, ...]| block } → nil
Parameters:callback_id -- int

Registers the given block with the given callback_id.

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

BrickletIndustrialDualAnalogIn#set_voltage_callback_period(channel, period) → nil
Parameters:
  • channel -- int
  • period -- int

Sets the period in ms with which the ::CALLBACK_VOLTAGE callback is triggered periodically for the given channel. A value of 0 turns the callback off.

The ::CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since the last triggering.

The default value is 0.

BrickletIndustrialDualAnalogIn#get_voltage_callback_period(channel) → int
Parameters:channel -- int

Returns the period as set by #set_voltage_callback_period.

BrickletIndustrialDualAnalogIn#set_voltage_callback_threshold(channel, option, min, max) → nil
Parameters:
  • channel -- int
  • option -- str
  • min -- int
  • max -- int

Sets the thresholds for the ::CALLBACK_VOLTAGE_REACHED callback for the given channel.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the voltage is outside the min and max values
'i' Callback is triggered when the voltage is inside the min and max values
'<' Callback is triggered when the voltage is smaller than the min value (max is ignored)
'>' Callback is triggered when the voltage is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following constants are available for this function:

  • BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_OFF = 'x'
  • BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_GREATER = '>'
BrickletIndustrialDualAnalogIn#get_voltage_callback_threshold(channel) → [str, int, int]
Parameters:channel -- int

Returns the threshold as set by #set_voltage_callback_threshold.

The following constants are available for this function:

  • BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_OFF = 'x'
  • BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_GREATER = '>'

The returned array has the values option, min and max.

BrickletIndustrialDualAnalogIn#set_debounce_period(debounce) → nil
Parameters:debounce -- int

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

BrickletIndustrialDualAnalogIn#get_debounce_period → int

Returns the debounce period as set by #set_debounce_period.

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_dual_analog_in.register_callback BrickletIndustrialDualAnalogIn::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.

BrickletIndustrialDualAnalogIn::CALLBACK_VOLTAGE
Parameters:
  • channel -- int
  • voltage -- int

This callback is triggered periodically with the period that is set by #set_voltage_callback_period. The parameter is the voltage of the channel.

The ::CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since the last triggering.

BrickletIndustrialDualAnalogIn::CALLBACK_VOLTAGE_REACHED
Parameters:
  • channel -- int
  • voltage -- int

This callback is triggered when the threshold as set by #set_voltage_callback_threshold is reached. The parameter is the voltage of the channel.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by #set_debounce_period.

Constants

BrickletIndustrialDualAnalogIn::DEVICE_IDENTIFIER

This constant is used to identify a Industrial Dual Analog In Bricklet.

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

BrickletIndustrialDualAnalogIn::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Dual Analog In Bricklet.