Ruby - Industrial Dual Analog In Bricklet 2.0

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

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
idai = BrickletIndustrialDualAnalogInV2.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 0
voltage = idai.get_voltage 0
puts "Voltage (Channel 0): #{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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_dual_analog_in_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
idai = BrickletIndustrialDualAnalogInV2.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(BrickletIndustrialDualAnalogInV2::CALLBACK_VOLTAGE) do |channel,
                                                                               voltage|
  puts "Channel: #{channel}"
  puts "Voltage: #{voltage/1000.0} V"
  puts ''
end

# Set period for voltage (channel 0) callback to 1s (1000ms) without a threshold
idai.set_voltage_callback_configuration 0, 1000, false, 'x', 0, 0

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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_dual_analog_in_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
idai = BrickletIndustrialDualAnalogInV2.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(BrickletIndustrialDualAnalogInV2::CALLBACK_VOLTAGE) do |channel,
                                                                               voltage|
  puts "Channel: #{channel}"
  puts "Voltage: #{voltage/1000.0} V"
  puts ''
end

# Configure threshold for voltage (channel 0) "greater than 10 V"
# with a debounce period of 10s (10000ms)
idai.set_voltage_callback_configuration 0, 10000, false, '>', 10*1000, 0

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

API

All functions 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

BrickletIndustrialDualAnalogInV2::new(uid, ipcon) → industrial_dual_analog_in_v2
Parameters:
  • uid – Type: str
  • ipcon – Type: IPConnection
Returns:
  • industrial_dual_analog_in_v2 – Type: BrickletIndustrialDualAnalogInV2

Creates an object with the unique device ID uid:

industrial_dual_analog_in_v2 = BrickletIndustrialDualAnalogInV2.new 'YOUR_DEVICE_UID', ipcon

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

BrickletIndustrialDualAnalogInV2#get_voltage(channel) → int
Parameters:
  • channel – Type: int, Range: [0 to 1]
Returns:
  • voltage – Type: int, Unit: 1 mV, Range: [-35000 to 35000]

Returns the voltage for the given channel.

If you want to get the value periodically, it is recommended to use the ::CALLBACK_VOLTAGE callback. You can set the callback configuration with #set_voltage_callback_configuration.

BrickletIndustrialDualAnalogInV2#set_channel_led_config(channel, config) → nil
Parameters:
  • channel – Type: int, Range: [0 to 1]
  • config – Type: int, Range: See constants, Default: 3

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the measured value.

You can configure the channel status behavior with #set_channel_led_status_config.

By default all channel LEDs are configured as "Channel Status".

The following constants are available for this function:

For config:

  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
BrickletIndustrialDualAnalogInV2#get_channel_led_config(channel) → int
Parameters:
  • channel – Type: int, Range: [0 to 1]
Returns:
  • config – Type: int, Range: See constants, Default: 3

Returns the channel LED configuration as set by #set_channel_led_config

The following constants are available for this function:

For config:

  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
BrickletIndustrialDualAnalogInV2#set_channel_led_status_config(channel, min, max, config) → nil
Parameters:
  • channel – Type: int, Range: [0 to 1]
  • min – Type: int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0
  • max – Type: int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 10000
  • config – Type: int, Range: See constants, Default: 1

Sets the channel LED status config. This config is used if the channel LED is configured as "Channel Status", see #set_channel_led_config.

For each channel you can choose between threshold and intensity mode.

In threshold mode you can define a positive or a negative threshold. For a positive threshold set the "min" parameter to the threshold value in mV above which the LED should turn on and set the "max" parameter to 0. Example: If you set a positive threshold of 10V, the LED will turn on as soon as the voltage exceeds 10V and turn off again if it goes below 10V. For a negative threshold set the "max" parameter to the threshold value in mV below which the LED should turn on and set the "min" parameter to 0. Example: If you set a negative threshold of 10V, the LED will turn on as soon as the voltage goes below 10V and the LED will turn off when the voltage exceeds 10V.

In intensity mode you can define a range in mV that is used to scale the brightness of the LED. Example with min=4V, max=20V: The LED is off at 4V, on at 20V and the brightness is linearly scaled between the values 4V and 20V. If the min value is greater than the max value, the LED brightness is scaled the other way around.

The following constants are available for this function:

For config:

  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1
BrickletIndustrialDualAnalogInV2#get_channel_led_status_config(channel) → [int, int, int]
Parameters:
  • channel – Type: int, Range: [0 to 1]
Return Array:
  • 0: min – Type: int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0
  • 1: max – Type: int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 10000
  • 2: config – Type: int, Range: See constants, Default: 1

Returns the channel LED status configuration as set by #set_channel_led_status_config.

The following constants are available for this function:

For config:

  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Advanced Functions

BrickletIndustrialDualAnalogInV2#set_sample_rate(rate) → nil
Parameters:
  • rate – Type: int, Range: See constants, Default: 6

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 following constants are available for this function:

For rate:

  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_976_SPS = 0
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_488_SPS = 1
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_244_SPS = 2
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_122_SPS = 3
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_61_SPS = 4
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_4_SPS = 5
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_2_SPS = 6
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_1_SPS = 7
BrickletIndustrialDualAnalogInV2#get_sample_rate → int
Returns:
  • rate – Type: int, Range: See constants, Default: 6

Returns the sample rate as set by #set_sample_rate.

The following constants are available for this function:

For rate:

  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_976_SPS = 0
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_488_SPS = 1
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_244_SPS = 2
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_122_SPS = 3
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_61_SPS = 4
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_4_SPS = 5
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_2_SPS = 6
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_1_SPS = 7
BrickletIndustrialDualAnalogInV2#set_calibration(offset, gain) → nil
Parameters:
  • offset – Type: [int, ...], Length: 2, Range: [-8388608 to 8388607]
  • gain – Type: [int, ...], Length: 2, Range: [-8388608 to 8388607]

Sets offset and gain of MCP3911 internal calibration registers.

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

BrickletIndustrialDualAnalogInV2#get_calibration → [[int, ...], [int, ...]]
Return Array:
  • 0: offset – Type: [int, ...], Length: 2, Range: [-8388608 to 8388607]
  • 1: gain – Type: [int, ...], Length: 2, Range: [-8388608 to 8388607]

Returns the calibration as set by #set_calibration.

BrickletIndustrialDualAnalogInV2#get_adc_values → [int, ...]
Returns:
  • value – Type: [int, ...], Length: 2, Range: [-8388608 to 8388607]

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

BrickletIndustrialDualAnalogInV2#get_spitfp_error_count → [int, int, int, int]
Return Array:
  • 0: error_count_ack_checksum – Type: int, Range: [0 to 232 - 1]
  • 1: error_count_message_checksum – Type: int, Range: [0 to 232 - 1]
  • 2: error_count_frame – Type: int, Range: [0 to 232 - 1]
  • 3: error_count_overflow – Type: int, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

BrickletIndustrialDualAnalogInV2#set_bootloader_mode(mode) → int
Parameters:
  • mode – Type: int, Range: See constants
Returns:
  • status – Type: int, Range: See constants

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_STATUS_OK = 0
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletIndustrialDualAnalogInV2#get_bootloader_mode → int
Returns:
  • mode – Type: int, Range: See constants

Returns the current bootloader mode, see #set_bootloader_mode.

The following constants are available for this function:

For mode:

  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletIndustrialDualAnalogInV2#set_write_firmware_pointer(pointer) → nil
Parameters:
  • pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]

Sets the firmware pointer for #write_firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletIndustrialDualAnalogInV2#write_firmware(data) → int
Parameters:
  • data – Type: [int, ...], Length: 64, Range: [0 to 255]
Returns:
  • status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by #set_write_firmware_pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletIndustrialDualAnalogInV2#set_status_led_config(config) → nil
Parameters:
  • config – Type: int, Range: See constants, Default: 3

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletIndustrialDualAnalogInV2#get_status_led_config → int
Returns:
  • config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by #set_status_led_config

The following constants are available for this function:

For config:

  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletIndustrialDualAnalogInV2#get_chip_temperature → int
Returns:
  • temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

BrickletIndustrialDualAnalogInV2#reset → nil

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletIndustrialDualAnalogInV2#write_uid(uid) → nil
Parameters:
  • uid – Type: int, Range: [0 to 232 - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletIndustrialDualAnalogInV2#read_uid → int
Returns:
  • uid – Type: int, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

BrickletIndustrialDualAnalogInV2#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, Range: ['a' to 'h', 'i', 'z']
  • 3: hardware_version – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, Range: [0 to 255]
  • 4: firmware_version – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, 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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

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

Callback Configuration Functions

BrickletIndustrialDualAnalogInV2#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.

BrickletIndustrialDualAnalogInV2#set_voltage_callback_configuration(channel, period, value_has_to_change, option, min, max) → nil
Parameters:
  • channel – Type: int, Range: [0 to 1]
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
  • option – Type: chr, Range: See constants, Default: 'x'
  • min – Type: int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0
  • max – Type: int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0

The period is the period with which the ::CALLBACK_VOLTAGE callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the ::CALLBACK_VOLTAGE callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

  • BrickletIndustrialDualAnalogInV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletIndustrialDualAnalogInV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletIndustrialDualAnalogInV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletIndustrialDualAnalogInV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletIndustrialDualAnalogInV2::THRESHOLD_OPTION_GREATER = '>'
BrickletIndustrialDualAnalogInV2#get_voltage_callback_configuration(channel) → [int, bool, chr, int, int]
Parameters:
  • channel – Type: int, Range: [0 to 1]
Return Array:
  • 0: period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • 1: value_has_to_change – Type: bool, Default: false
  • 2: option – Type: chr, Range: See constants, Default: 'x'
  • 3: min – Type: int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0
  • 4: max – Type: int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by #set_voltage_callback_configuration.

The following constants are available for this function:

For option:

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

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_v2.register_callback BrickletIndustrialDualAnalogInV2::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.

BrickletIndustrialDualAnalogInV2::CALLBACK_VOLTAGE
Callback Parameters:
  • channel – Type: int, Range: [0 to 1]
  • voltage – Type: int, Unit: 1 mV, Range: [-35000 to 35000]

This callback is triggered periodically according to the configuration set by #set_voltage_callback_configuration.

The parameter is the same as #get_voltage.

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletIndustrialDualAnalogInV2#get_api_version → [int, ...]
Return Array:
  • 0: api_version – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, Range: [0 to 255]

Returns the version of the API definition 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.

BrickletIndustrialDualAnalogInV2#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:

  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_SAMPLE_RATE = 5
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_CALIBRATION = 7
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_CHANNEL_LED_CONFIG = 10
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDualAnalogInV2::FUNCTION_RESET = 243
  • BrickletIndustrialDualAnalogInV2::FUNCTION_WRITE_UID = 248
BrickletIndustrialDualAnalogInV2#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:

  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_SAMPLE_RATE = 5
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_CALIBRATION = 7
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_CHANNEL_LED_CONFIG = 10
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDualAnalogInV2::FUNCTION_RESET = 243
  • BrickletIndustrialDualAnalogInV2::FUNCTION_WRITE_UID = 248
BrickletIndustrialDualAnalogInV2#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.

Constants

BrickletIndustrialDualAnalogInV2::DEVICE_IDENTIFIER

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

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.

BrickletIndustrialDualAnalogInV2::DEVICE_DISPLAY_NAME

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