Software / API Bindings / Ruby / API Reference and Examples / Bricklets (Discontinued) / Temperature IR Bricklet

Ruby - Temperature IR Bricklet¶

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

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_temperature_ir'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Temperature IR Bricklet

ipcon = IPConnection.new # Create IP connection
tir = BrickletTemperatureIR.new UID, ipcon # Create device object

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

# Get current ambient temperature
ambient_temperature = tir.get_ambient_temperature
puts "Ambient Temperature: #{ambient_temperature/10.0} °C"

# Get current object temperature
object_temperature = tir.get_object_temperature
puts "Object Temperature: #{object_temperature/10.0} °C"

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_temperature_ir'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Temperature IR Bricklet

ipcon = IPConnection.new # Create IP connection
tir = BrickletTemperatureIR.new UID, ipcon # Create device object

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

# Register object temperature callback
tir.register_callback(BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE) do |temperature|
  puts "Object Temperature: #{temperature/10.0} °C"
end

# Set period for object temperature callback to 1s (1000ms)
# Note: The object temperature callback is only called every second
#       if the object temperature has changed since the last call!
tir.set_object_temperature_callback_period 1000

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

Water Boiling¶

Download (example_water_boiling.rb)

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_temperature_ir'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Temperature IR Bricklet

ipcon = IPConnection.new # Create IP connection
tir = BrickletTemperatureIR.new UID, ipcon # Create device object

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

# Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
tir.set_emissivity 64224

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

# Register object temperature reached callback
tir.register_callback(BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE_REACHED) do |temperature|
  puts "Object Temperature: #{temperature/10.0} °C"
  puts 'The water is boiling!'
end

# Configure threshold for object temperature "greater than 100 °C"
tir.set_object_temperature_callback_threshold '>', 100*10, 0

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

API¶

All functions listed below are thread-safe.

Basic Functions¶

BrickletTemperatureIR::new(uid, ipcon) → temperature_ir¶

Parameters:	uid – Type: str ipcon – Type: IPConnection
Returns:	temperature_ir – Type: BrickletTemperatureIR

Creates an object with the unique device ID uid:

temperature_ir = BrickletTemperatureIR.new 'YOUR_DEVICE_UID', ipcon

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

BrickletTemperatureIR#get_ambient_temperature → int¶

Returns:	temperature – Type: int, Unit: 1/10 °C, Range: [-400 to 1250]

Returns the ambient temperature of the sensor.

If you want to get the ambient temperature periodically, it is recommended to use the ::CALLBACK_AMBIENT_TEMPERATURE callback and set the period with #set_ambient_temperature_callback_period.

BrickletTemperatureIR#get_object_temperature → int¶

Returns:	temperature – Type: int, Unit: 1/10 °C, Range: [-700 to 3800]

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at.

The temperature of different materials is dependent on their emissivity. The emissivity of the material can be set with #set_emissivity.

If you want to get the object temperature periodically, it is recommended to use the ::CALLBACK_OBJECT_TEMPERATURE callback and set the period with #set_object_temperature_callback_period.

Advanced Functions¶

BrickletTemperatureIR#set_emissivity(emissivity) → nil¶

Parameters:	emissivity – Type: int, Unit: 1/65535, Range: [6553 to 2¹⁶ - 1], Default: 2¹⁶ - 1

Sets the emissivity that is used to calculate the surface temperature as returned by #get_object_temperature.

The emissivity is usually given as a value between 0.0 and 1.0. A list of emissivities of different materials can be found here.

The parameter of #set_emissivity has to be given with a factor of 65535 (16-bit). For example: An emissivity of 0.1 can be set with the value 6553, an emissivity of 0.5 with the value 32767 and so on.

Note

If you need a precise measurement for the object temperature, it is absolutely crucial that you also provide a precise emissivity.

The emissivity is stored in non-volatile memory and will still be used after a restart or power cycle of the Bricklet.

BrickletTemperatureIR#get_emissivity → int¶

Returns:	emissivity – Type: int, Unit: 1/65535, Range: [6553 to 2¹⁶ - 1], Default: 2¹⁶ - 1

Returns the emissivity as set by #set_emissivity.

BrickletTemperatureIR#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¶

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

BrickletTemperatureIR#set_ambient_temperature_callback_period(period) → nil¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

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

The ::CALLBACK_AMBIENT_TEMPERATURE callback is only triggered if the temperature has changed since the last triggering.

BrickletTemperatureIR#get_ambient_temperature_callback_period → int¶

Returns:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by #set_ambient_temperature_callback_period.

BrickletTemperatureIR#set_object_temperature_callback_period(period) → nil¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

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

The ::CALLBACK_OBJECT_TEMPERATURE callback is only triggered if the temperature has changed since the last triggering.

BrickletTemperatureIR#get_object_temperature_callback_period → int¶

Returns:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by #set_object_temperature_callback_period.

BrickletTemperatureIR#set_ambient_temperature_callback_threshold(option, min, max) → nil¶

Parameters:	option – Type: chr, Range: See constants, Default: 'x' min – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0

Sets the thresholds for the ::CALLBACK_AMBIENT_TEMPERATURE_REACHED callback.

The following options are possible:

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

The following constants are available for this function:

For option:

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

BrickletTemperatureIR#get_ambient_temperature_callback_threshold → [chr, int, int]¶

Return Array:	0: option – Type: chr, Range: See constants, Default: 'x' 1: min – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 2: max – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0

Returns the threshold as set by #set_ambient_temperature_callback_threshold.

The following constants are available for this function:

For option:

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

BrickletTemperatureIR#set_object_temperature_callback_threshold(option, min, max) → nil¶

Parameters:	option – Type: chr, Range: See constants, Default: 'x' min – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0

Sets the thresholds for the ::CALLBACK_OBJECT_TEMPERATURE_REACHED callback.

The following options are possible:

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

The following constants are available for this function:

For option:

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

BrickletTemperatureIR#get_object_temperature_callback_threshold → [chr, int, int]¶

Return Array:	0: option – Type: chr, Range: See constants, Default: 'x' 1: min – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 2: max – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0

Returns the threshold as set by #set_object_temperature_callback_threshold.

The following constants are available for this function:

For option:

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

BrickletTemperatureIR#set_debounce_period(debounce) → nil¶

Parameters:	debounce – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Sets the period with which the threshold callbacks

::CALLBACK_AMBIENT_TEMPERATURE_REACHED,
::CALLBACK_OBJECT_TEMPERATURE_REACHED

are triggered, if the thresholds

#set_ambient_temperature_callback_threshold,
#set_object_temperature_callback_threshold

keep being reached.

BrickletTemperatureIR#get_debounce_period → int¶

Returns:	debounce – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

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:

temperature_ir.register_callback BrickletTemperatureIR::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.

BrickletTemperatureIR::CALLBACK_AMBIENT_TEMPERATURE¶

Callback Parameters:	temperature – Type: int, Unit: 1/10 °C, Range: [-400 to 1250]

This callback is triggered periodically with the period that is set by #set_ambient_temperature_callback_period. The parameter is the ambient temperature of the sensor.

The ::CALLBACK_AMBIENT_TEMPERATURE callback is only triggered if the ambient temperature has changed since the last triggering.

BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE¶

Callback Parameters:	temperature – Type: int, Unit: 1/10 °C, Range: [-700 to 3800]

This callback is triggered periodically with the period that is set by #set_object_temperature_callback_period. The parameter is the object temperature of the sensor.

The ::CALLBACK_OBJECT_TEMPERATURE callback is only triggered if the object temperature has changed since the last triggering.

BrickletTemperatureIR::CALLBACK_AMBIENT_TEMPERATURE_REACHED¶

Callback Parameters:	temperature – Type: int, Unit: 1/10 °C, Range: [-400 to 1250]

This callback is triggered when the threshold as set by #set_ambient_temperature_callback_threshold is reached. The parameter is the ambient temperature of the sensor.

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

BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE_REACHED¶

Callback Parameters:	temperature – Type: int, Unit: 1/10 °C, Range: [-700 to 3800]

This callback is triggered when the threshold as set by #set_object_temperature_callback_threshold is reached. The parameter is the object temperature of the sensor.

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

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.

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

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

BrickletTemperatureIR::FUNCTION_SET_EMISSIVITY = 3
BrickletTemperatureIR::FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
BrickletTemperatureIR::FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
BrickletTemperatureIR::FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
BrickletTemperatureIR::FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
BrickletTemperatureIR::FUNCTION_SET_DEBOUNCE_PERIOD = 13

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

BrickletTemperatureIR::FUNCTION_SET_EMISSIVITY = 3
BrickletTemperatureIR::FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
BrickletTemperatureIR::FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
BrickletTemperatureIR::FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
BrickletTemperatureIR::FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
BrickletTemperatureIR::FUNCTION_SET_DEBOUNCE_PERIOD = 13

BrickletTemperatureIR#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¶

BrickletTemperatureIR::DEVICE_IDENTIFIER¶

This constant is used to identify a Temperature IR 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.

BrickletTemperatureIR::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Temperature IR Bricklet.