..
 #############################################################
 # This file was automatically generated on 2015-05-08.      #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################


:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-ruby">Software</a> / Ruby - Temperature IR Bricklet

.. |device_identifier_constant| replace:: There is also a :ref:`constant <temperature_ir_bricklet_ruby_constants>` for the device identifier of this Bricklet.

.. _temperature_ir_bricklet_ruby:

Ruby - Temperature IR Bricklet
==============================

This is the description of the :ref:`Ruby API bindings <api_bindings_ruby>` for the :ref:`Temperature IR Bricklet <temperature_ir_bricklet>`. General information and technical
specifications for the Temperature IR Bricklet are summarized in its :ref:`hardware description
<temperature_ir_bricklet_description>`.

An :ref:`installation guide <api_bindings_ruby_install>` for the Ruby API
bindings is part of their general description.

.. _temperature_ir_bricklet_ruby_examples:


Examples
--------

The example code below is `Public Domain (CC0 1.0)
<http://creativecommons.org/publicdomain/zero/1.0/>`__.

Simple
^^^^^^

`Download (example_simple.rb) <https://github.com/Tinkerforge/temperature-ir-bricklet/raw/master/software/examples/ruby/example_simple.rb>`__

.. literalinclude:: TemperatureIR_Bricklet_Ruby_example_simple.rb
 :language: ruby
 :linenos:
 :tab-width: 4

Water Boiling
^^^^^^^^^^^^^

`Download (example_water_boiling.rb) <https://github.com/Tinkerforge/temperature-ir-bricklet/raw/master/software/examples/ruby/example_water_boiling.rb>`__

.. literalinclude:: TemperatureIR_Bricklet_Ruby_example_water_boiling.rb
 :language: ruby
 :linenos:
 :tab-width: 4

Callback
^^^^^^^^

`Download (example_callback.rb) <https://github.com/Tinkerforge/temperature-ir-bricklet/raw/master/software/examples/ruby/example_callback.rb>`__

.. literalinclude:: TemperatureIR_Bricklet_Ruby_example_callback.rb
 :language: ruby
 :linenos:
 :tab-width: 4

.. _temperature_ir_bricklet_ruby_api:

API
---

All methods listed below are thread-safe.




Basic Functions
^^^^^^^^^^^^^^^


.. rb:function:: BrickletTemperatureIR::new(uid, ipcon) -> temperature_ir

 :param uid: str
 :param ipcon: IPConnection

 Creates an object with the unique device ID ``uid``:

 .. code-block:: ruby

    temperature_ir = BrickletTemperatureIR.new 'YOUR_DEVICE_UID', ipcon

 This object can then be used after the IP Connection is connected
 (see examples :ref:`above <temperature_ir_bricklet_ruby_examples>`).


.. rb:function:: BrickletTemperatureIR#get_ambient_temperature -> int


 Returns the ambient temperature of the sensor. The value
 has a range of -400 to 1250 and is given in °C/10,
 e.g. a value of 423 means that an ambient temperature of 42.3 °C is 
 measured.
 
 If you want to get the ambient temperature periodically, it is recommended 
 to use the callback :rb:attr:`::CALLBACK_AMBIENT_TEMPERATURE <BrickletTemperatureIR::CALLBACK_AMBIENT_TEMPERATURE>` and set the period with 
 :rb:func:`#set_ambient_temperature_callback_period <BrickletTemperatureIR#set_ambient_temperature_callback_period>`.
 
.. rb:function:: BrickletTemperatureIR#get_object_temperature -> int


 Returns the object temperature of the sensor, i.e. the temperature
 of the surface of the object the sensor is aimed at. The value
 has a range of -700 to 3800 and is given in °C/10,
 e.g. a value of 3001 means that a temperature of 300.1 °C is measured
 on the surface of the object.
 
 The temperature of different materials is dependent on their `emissivity 
 <http://en.wikipedia.org/wiki/Emissivity>`__. The emissivity of the material
 can be set with :rb:func:`#set_emissivity <BrickletTemperatureIR#set_emissivity>`.
 
 If you want to get the object temperature periodically, it is recommended 
 to use the callback :rb:attr:`::CALLBACK_OBJECT_TEMPERATURE <BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE>` and set the period with 
 :rb:func:`#set_object_temperature_callback_period <BrickletTemperatureIR#set_object_temperature_callback_period>`.
 


Advanced Functions
^^^^^^^^^^^^^^^^^^

.. rb:function:: BrickletTemperatureIR#set_emissivity(emissivity) -> nil

 :param emissivity: int

 Sets the `emissivity <http://en.wikipedia.org/wiki/Emissivity>`__ that is
 used to calculate the surface temperature as returned by 
 :rb:func:`#get_object_temperature <BrickletTemperatureIR#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 <http://www.infrared-thermography.com/material.htm>`__.
 
 The parameter of :rb:func:`#set_emissivity <BrickletTemperatureIR#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 default emissivity is 1.0 (value of 65535) and the minimum emissivity the
 sensor can handle is 0.1 (value of 6553).
 
.. rb:function:: BrickletTemperatureIR#get_emissivity -> int


 Returns the emissivity as set by :rb:func:`#set_emissivity <BrickletTemperatureIR#set_emissivity>`.
 
.. rb:function:: BrickletTemperatureIR#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.
 
.. rb:function:: BrickletTemperatureIR#get_response_expected(function_id) -> bool

 :param 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
 :rb:func:`#set_response_expected <BrickletTemperatureIR#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 :rb:func:`#set_response_expected <BrickletTemperatureIR#set_response_expected>`
 for the list of function ID constants available for this function.
 
.. rb:function:: BrickletTemperatureIR#set_response_expected(function_id, response_expected) -> nil

 :param function_id: int
 :param 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 and callbacks it is always disabled.
 
 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:
 
 * 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
 
.. rb:function:: BrickletTemperatureIR#set_response_expected_all(response_expected) -> nil

 :param response_expected: bool

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. rb:function:: BrickletTemperatureIR#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 :ref:`here <device_identifier>`.
 |device_identifier_constant|
 
 The returned array has the values ``uid``, ``connected_uid``, ``position``, ``hardware_version``, ``firmware_version`` and ``device_identifier``.



Callback Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


.. rb:function:: BrickletTemperatureIR#register_callback(id) { |param [, ...]| block } -> nil

 :param id: int

 Registers a callback with ID *id* to the given block. The available
 IDs with corresponding function signatures are listed
 :ref:`below <temperature_ir_bricklet_ruby_callbacks>`.


.. rb:function:: BrickletTemperatureIR#set_ambient_temperature_callback_period(period) -> nil

 :param period: int

 Sets the period in ms with which the :rb:attr:`::CALLBACK_AMBIENT_TEMPERATURE <BrickletTemperatureIR::CALLBACK_AMBIENT_TEMPERATURE>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :rb:attr:`::CALLBACK_AMBIENT_TEMPERATURE <BrickletTemperatureIR::CALLBACK_AMBIENT_TEMPERATURE>` is only triggered if the temperature has changed since the
 last triggering.
 
 The default value is 0.
 
.. rb:function:: BrickletTemperatureIR#get_ambient_temperature_callback_period -> int


 Returns the period as set by :rb:func:`#set_ambient_temperature_callback_period <BrickletTemperatureIR#set_ambient_temperature_callback_period>`.
 
.. rb:function:: BrickletTemperatureIR#set_object_temperature_callback_period(period) -> nil

 :param period: int

 Sets the period in ms with which the :rb:attr:`::CALLBACK_OBJECT_TEMPERATURE <BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :rb:attr:`::CALLBACK_OBJECT_TEMPERATURE <BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE>` is only triggered if the temperature has changed since the
 last triggering.
 
 The default value is 0.
 
.. rb:function:: BrickletTemperatureIR#get_object_temperature_callback_period -> int


 Returns the period as set by :rb:func:`#set_object_temperature_callback_period <BrickletTemperatureIR#set_object_temperature_callback_period>`.
 
.. rb:function:: BrickletTemperatureIR#set_ambient_temperature_callback_threshold(option, min, max) -> nil

 :param option: str
 :param min: int
 :param max: int

 Sets the thresholds for the :rb:attr:`::CALLBACK_AMBIENT_TEMPERATURE_REACHED <BrickletTemperatureIR::CALLBACK_AMBIENT_TEMPERATURE_REACHED>` callback. 
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'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 default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletTemperatureIR::THRESHOLD_OPTION_OFF = 'x'
 * BrickletTemperatureIR::THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletTemperatureIR::THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletTemperatureIR::THRESHOLD_OPTION_SMALLER = '<'
 * BrickletTemperatureIR::THRESHOLD_OPTION_GREATER = '>'
 
.. rb:function:: BrickletTemperatureIR#get_ambient_temperature_callback_threshold -> [str, int, int]


 Returns the threshold as set by :rb:func:`#set_ambient_temperature_callback_threshold <BrickletTemperatureIR#set_ambient_temperature_callback_threshold>`.
 
 The following constants are available for this function:
 
 * BrickletTemperatureIR::THRESHOLD_OPTION_OFF = 'x'
 * BrickletTemperatureIR::THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletTemperatureIR::THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletTemperatureIR::THRESHOLD_OPTION_SMALLER = '<'
 * BrickletTemperatureIR::THRESHOLD_OPTION_GREATER = '>'
 
 The returned array has the values ``option``, ``min`` and ``max``.

.. rb:function:: BrickletTemperatureIR#set_object_temperature_callback_threshold(option, min, max) -> nil

 :param option: str
 :param min: int
 :param max: int

 Sets the thresholds for the :rb:attr:`::CALLBACK_OBJECT_TEMPERATURE_REACHED <BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE_REACHED>` callback. 
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'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 default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletTemperatureIR::THRESHOLD_OPTION_OFF = 'x'
 * BrickletTemperatureIR::THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletTemperatureIR::THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletTemperatureIR::THRESHOLD_OPTION_SMALLER = '<'
 * BrickletTemperatureIR::THRESHOLD_OPTION_GREATER = '>'
 
.. rb:function:: BrickletTemperatureIR#get_object_temperature_callback_threshold -> [str, int, int]


 Returns the threshold as set by :rb:func:`#set_object_temperature_callback_threshold <BrickletTemperatureIR#set_object_temperature_callback_threshold>`.
 
 The following constants are available for this function:
 
 * BrickletTemperatureIR::THRESHOLD_OPTION_OFF = 'x'
 * BrickletTemperatureIR::THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletTemperatureIR::THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletTemperatureIR::THRESHOLD_OPTION_SMALLER = '<'
 * BrickletTemperatureIR::THRESHOLD_OPTION_GREATER = '>'
 
 The returned array has the values ``option``, ``min`` and ``max``.

.. rb:function:: BrickletTemperatureIR#set_debounce_period(debounce) -> nil

 :param debounce: int

 Sets the period in ms with which the threshold callbacks
 
 * :rb:attr:`::CALLBACK_AMBIENT_TEMPERATURE_REACHED <BrickletTemperatureIR::CALLBACK_AMBIENT_TEMPERATURE_REACHED>`,
 * :rb:attr:`::CALLBACK_OBJECT_TEMPERATURE_REACHED <BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE_REACHED>`
 
 are triggered, if the thresholds
 
 * :rb:func:`#set_ambient_temperature_callback_threshold <BrickletTemperatureIR#set_ambient_temperature_callback_threshold>`,
 * :rb:func:`#set_object_temperature_callback_threshold <BrickletTemperatureIR#set_object_temperature_callback_threshold>`
 
 keep being reached.
 
 The default value is 100.
 
.. rb:function:: BrickletTemperatureIR#get_debounce_period -> int


 Returns the debounce period as set by :rb:func:`#set_debounce_period <BrickletTemperatureIR#set_debounce_period>`.
 


.. _temperature_ir_bricklet_ruby_callbacks:

Callbacks
^^^^^^^^^

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

.. code-block:: ruby

    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.

.. rb:attribute:: BrickletTemperatureIR::CALLBACK_AMBIENT_TEMPERATURE

 :param temperature: int


 This callback is triggered periodically with the period that is set by
 :rb:func:`#set_ambient_temperature_callback_period <BrickletTemperatureIR#set_ambient_temperature_callback_period>`. The parameter is the ambient
 temperature of the sensor.
 
 :rb:attr:`::CALLBACK_AMBIENT_TEMPERATURE <BrickletTemperatureIR::CALLBACK_AMBIENT_TEMPERATURE>` is only triggered if the ambient temperature
 has changed since the last triggering.
 
.. rb:attribute:: BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE

 :param temperature: int


 This callback is triggered periodically with the period that is set by
 :rb:func:`#set_object_temperature_callback_period <BrickletTemperatureIR#set_object_temperature_callback_period>`. The parameter is the object
 temperature of the sensor.
 
 :rb:attr:`::CALLBACK_OBJECT_TEMPERATURE <BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE>` is only triggered if the object temperature
 has changed since the last triggering.
 
.. rb:attribute:: BrickletTemperatureIR::CALLBACK_AMBIENT_TEMPERATURE_REACHED

 :param temperature: int


 This callback is triggered when the threshold as set by
 :rb:func:`#set_ambient_temperature_callback_threshold <BrickletTemperatureIR#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 :rb:func:`#set_debounce_period <BrickletTemperatureIR#set_debounce_period>`.
 
.. rb:attribute:: BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE_REACHED

 :param temperature: int


 This callback is triggered when the threshold as set by
 :rb:func:`#set_object_temperature_callback_threshold <BrickletTemperatureIR#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 :rb:func:`#set_debounce_period <BrickletTemperatureIR#set_debounce_period>`.
 


.. _temperature_ir_bricklet_ruby_constants:

Constants
^^^^^^^^^

.. rb:attribute:: BrickletTemperatureIR::DEVICE_IDENTIFIER

 This constant is used to identify a Temperature IR Bricklet.

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

