Software / API Bindings / Ruby / API Reference and Examples / Bricklets / Analog In Bricklet 3.0

Ruby - Analog In Bricklet 3.0¶

This is the description of the Ruby API bindings for the Analog In Bricklet 3.0. General information and technical specifications for the Analog In Bricklet 3.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)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_analog_in_v3'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
ai = BrickletAnalogInV3.new UID, ipcon # Create device object

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

# Get current voltage
voltage = ai.get_voltage
puts "Voltage: #{voltage/1000.0} V"

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

Callback¶

Download (example_callback.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_analog_in_v3'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
ai = BrickletAnalogInV3.new UID, ipcon # Create device object

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

# Register voltage callback
ai.register_callback(BrickletAnalogInV3::CALLBACK_VOLTAGE) do |voltage|
  puts "Voltage: #{voltage/1000.0} V"
end

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

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

Threshold¶

Download (example_threshold.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_analog_in_v3'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
ai = BrickletAnalogInV3.new UID, ipcon # Create device object

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

# Register voltage callback
ai.register_callback(BrickletAnalogInV3::CALLBACK_VOLTAGE) do |voltage|
  puts "Voltage: #{voltage/1000.0} V"
end

# Configure threshold for voltage "smaller than 5 V"
# with a debounce period of 1s (1000ms)
ai.set_voltage_callback_configuration 1000, false, '<', 5*1000, 0

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

API¶

All functions listed below are thread-safe.

Basic Functions¶

BrickletAnalogInV3::new(uid, ipcon) → analog_in_v3¶

Parameters:	uid – Type: str ipcon – Type: IPConnection
Returns:	analog_in_v3 – Type: BrickletAnalogInV3

Creates an object with the unique device ID uid:

analog_in_v3 = BrickletAnalogInV3.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected.

BrickletAnalogInV3#get_voltage → int¶

Returns:	voltage – Type: int, Unit: 1 mV, Range: [0 to 42000]

Returns the measured voltage. The resolution is approximately 10mV to 1mV depending on the oversampling configuration (#set_oversampling).

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.

Advanced Functions¶

BrickletAnalogInV3#set_oversampling(oversampling) → nil¶

Parameters:	oversampling – Type: int, Range: See constants, Default: 7

Sets the oversampling between 32x and 16384x. The Bricklet takes one 12bit sample every 17.5µs. Thus an oversampling of 32x is equivalent to an integration time of 0.56ms and a oversampling of 16384x is equivalent to an integration time of 286ms.

The oversampling uses the moving average principle. A new value is always calculated once per millisecond.

With increased oversampling the noise decreases. With decreased oversampling the reaction time increases (changes in voltage will be measured faster).

The following constants are available for this function:

For oversampling:

BrickletAnalogInV3::OVERSAMPLING_32 = 0
BrickletAnalogInV3::OVERSAMPLING_64 = 1
BrickletAnalogInV3::OVERSAMPLING_128 = 2
BrickletAnalogInV3::OVERSAMPLING_256 = 3
BrickletAnalogInV3::OVERSAMPLING_512 = 4
BrickletAnalogInV3::OVERSAMPLING_1024 = 5
BrickletAnalogInV3::OVERSAMPLING_2048 = 6
BrickletAnalogInV3::OVERSAMPLING_4096 = 7
BrickletAnalogInV3::OVERSAMPLING_8192 = 8
BrickletAnalogInV3::OVERSAMPLING_16384 = 9

BrickletAnalogInV3#get_oversampling → int¶

Returns:	oversampling – Type: int, Range: See constants, Default: 7

Returns the oversampling value as set by #set_oversampling.

The following constants are available for this function:

For oversampling:

BrickletAnalogInV3::OVERSAMPLING_32 = 0
BrickletAnalogInV3::OVERSAMPLING_64 = 1
BrickletAnalogInV3::OVERSAMPLING_128 = 2
BrickletAnalogInV3::OVERSAMPLING_256 = 3
BrickletAnalogInV3::OVERSAMPLING_512 = 4
BrickletAnalogInV3::OVERSAMPLING_1024 = 5
BrickletAnalogInV3::OVERSAMPLING_2048 = 6
BrickletAnalogInV3::OVERSAMPLING_4096 = 7
BrickletAnalogInV3::OVERSAMPLING_8192 = 8
BrickletAnalogInV3::OVERSAMPLING_16384 = 9

BrickletAnalogInV3#set_calibration(offset, multiplier, divisor) → nil¶

Parameters:	offset – Type: int, Unit: 1 mV, Range: [-2¹⁵ to 2¹⁵ - 1] multiplier – Type: int, Range: [0 to 2¹⁶ - 1] divisor – Type: int, Range: [0 to 2¹⁶ - 1]

Sets a calibration for the measured voltage value. The formula for the calibration is as follows:

Calibrated Value = (Value + Offset) * Multiplier / Divisor

We recommend that you use the Brick Viewer to calibrate the Bricklet. The calibration will be saved internally and only has to be done once.

BrickletAnalogInV3#get_calibration → [int, int, int]¶

Return Array:	0: offset – Type: int, Unit: 1 mV, Range: [-2¹⁵ to 2¹⁵ - 1] 1: multiplier – Type: int, Range: [0 to 2¹⁶ - 1] 2: divisor – Type: int, Range: [0 to 2¹⁶ - 1]

Returns the calibration as set by #set_calibration.

BrickletAnalogInV3#get_spitfp_error_count → [int, int, int, int]¶

Return Array:	0: error_count_ack_checksum – Type: int, Range: [0 to 2³² - 1] 1: error_count_message_checksum – Type: int, Range: [0 to 2³² - 1] 2: error_count_frame – Type: int, Range: [0 to 2³² - 1] 3: error_count_overflow – Type: int, Range: [0 to 2³² - 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.

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

BrickletAnalogInV3::STATUS_LED_CONFIG_OFF = 0
BrickletAnalogInV3::STATUS_LED_CONFIG_ON = 1
BrickletAnalogInV3::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletAnalogInV3::STATUS_LED_CONFIG_SHOW_STATUS = 3

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

BrickletAnalogInV3::STATUS_LED_CONFIG_OFF = 0
BrickletAnalogInV3::STATUS_LED_CONFIG_ON = 1
BrickletAnalogInV3::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletAnalogInV3::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletAnalogInV3#get_chip_temperature → int¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 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.

BrickletAnalogInV3#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!

BrickletAnalogInV3#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Return Array:

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', '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 2¹⁶ - 1]

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', '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 2¹⁶ - 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). A Bricklet connected to an Isolator Bricklet is always at 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¶

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

BrickletAnalogInV3#set_voltage_callback_configuration(period, value_has_to_change, option, min, max) → nil¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 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: [0 to 2¹⁶ - 1], Default: 0 max – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 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:

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

BrickletAnalogInV3#get_voltage_callback_configuration → [int, bool, chr, int, int]¶

Return Array:	0: period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 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: [0 to 2¹⁶ - 1], Default: 0 4: max – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0

Returns the callback configuration as set by #set_voltage_callback_configuration.

The following constants are available for this function:

For option:

BrickletAnalogInV3::THRESHOLD_OPTION_OFF = 'x'
BrickletAnalogInV3::THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletAnalogInV3::THRESHOLD_OPTION_INSIDE = 'i'
BrickletAnalogInV3::THRESHOLD_OPTION_SMALLER = '<'
BrickletAnalogInV3::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:

analog_in_v3.register_callback BrickletAnalogInV3::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.

BrickletAnalogInV3::CALLBACK_VOLTAGE¶

Callback Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 42000]

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.

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

BrickletAnalogInV3#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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

BrickletAnalogInV3::FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
BrickletAnalogInV3::FUNCTION_SET_OVERSAMPLING = 5
BrickletAnalogInV3::FUNCTION_SET_CALIBRATION = 7
BrickletAnalogInV3::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletAnalogInV3::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletAnalogInV3::FUNCTION_RESET = 243
BrickletAnalogInV3::FUNCTION_WRITE_UID = 248

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

The following constants are available for this function:

For function_id:

BrickletAnalogInV3::FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
BrickletAnalogInV3::FUNCTION_SET_OVERSAMPLING = 5
BrickletAnalogInV3::FUNCTION_SET_CALIBRATION = 7
BrickletAnalogInV3::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletAnalogInV3::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletAnalogInV3::FUNCTION_RESET = 243
BrickletAnalogInV3::FUNCTION_WRITE_UID = 248

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

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

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

For status:

BrickletAnalogInV3::BOOTLOADER_STATUS_OK = 0
BrickletAnalogInV3::BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletAnalogInV3::BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletAnalogInV3::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletAnalogInV3::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletAnalogInV3::BOOTLOADER_STATUS_CRC_MISMATCH = 5

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

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

BrickletAnalogInV3#set_write_firmware_pointer(pointer) → nil¶

Parameters:	pointer – Type: int, Unit: 1 B, Range: [0 to 2³² - 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.

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

BrickletAnalogInV3#write_uid(uid) → nil¶

Parameters:	uid – Type: int, Range: [0 to 2³² - 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.

BrickletAnalogInV3#read_uid → int¶

Returns:	uid – Type: int, Range: [0 to 2³² - 1]

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

Constants¶

BrickletAnalogInV3::DEVICE_IDENTIFIER¶

This constant is used to identify a Analog In Bricklet 3.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.

BrickletAnalogInV3::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Analog In Bricklet 3.0.