..
 #############################################################
 # 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-shell">Software</a> / Shell - Temperature IR Bricklet

.. |device_identifier_constant| unicode:: 0xA0
   :trim:

.. _temperature_ir_bricklet_shell:

Shell - Temperature IR Bricklet
===============================

This is the description of the :ref:`Shell API bindings <api_bindings_shell>` 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_shell_install>` for the Shell API
bindings is part of their general description.

.. _temperature_ir_bricklet_shell_examples:


Examples
--------

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

Simple
^^^^^^

`Download (example-simple.sh) <https://github.com/Tinkerforge/temperature-ir-bricklet/raw/master/software/examples/shell/example-simple.sh>`__

.. literalinclude:: TemperatureIR_Bricklet_Shell_example-simple.sh
 :language: bash
 :linenos:
 :tab-width: 4

Callback
^^^^^^^^

`Download (example-callback.sh) <https://github.com/Tinkerforge/temperature-ir-bricklet/raw/master/software/examples/shell/example-callback.sh>`__

.. literalinclude:: TemperatureIR_Bricklet_Shell_example-callback.sh
 :language: bash
 :linenos:
 :tab-width: 4

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

`Download (example-water-boiling.sh) <https://github.com/Tinkerforge/temperature-ir-bricklet/raw/master/software/examples/shell/example-water-boiling.sh>`__

.. literalinclude:: TemperatureIR_Bricklet_Shell_example-water-boiling.sh
 :language: bash
 :linenos:
 :tab-width: 4

.. _temperature_ir_bricklet_shell_api:

API
---

Possible exit codes for all ``tinkerforge`` commands are:

* 1: interrupted (ctrl+c)
* 2: syntax error
* 21: Python 2.5 or newer is required
* 22: Python ``argparse`` module is missing
* 23: socket error
* 24: other exception
* 25: invalid placeholder in format string
* 26: authentication error
* 201: timeout occurred
* 209: invalid argument value
* 210: function is not supported
* 211: unknown error



Command Structure
^^^^^^^^^^^^^^^^^

The common options of the ``call`` and ``dispatch`` commands are documented
:ref:`here <ipcon_shell_api>`. The specific command structure is shown below.

.. sh:function:: X Stinkerforge Pcall Ntemperature-ir-bricklet A[<option>..] L<uid> L<function> L[<argument>..]

 :param <uid>: string
 :param <function>: string

 The ``call`` command is used to call a function of the Temperature IR Bricklet. It can take several
 options:

 * ``--help`` shows help for the specific ``call`` command and exits
 * ``--list-functions`` shows a list of known functions of the Temperature IR Bricklet and exits


.. sh:function:: X Stinkerforge Pdispatch Ntemperature-ir-bricklet A[<option>..] L<uid> L<callback>

 :param <uid>: string
 :param <callback>: string

 The ``dispatch`` command is used to dispatch a callback of the Temperature IR Bricklet. It can
 take several options:

 * ``--help`` shows help for the specific ``dispatch`` command and exits
 * ``--list-callbacks`` shows a list of known callbacks of the Temperature IR Bricklet and exits


.. sh:function:: X Stinkerforge Scall Ptemperature-ir-bricklet L<uid> N<function> A[<option>..] L[<argument>..]

 :param <uid>: string
 :param <function>: string

 The ``<function>`` to be called can take different options depending of its
 kind. All functions can take the following options:

 * ``--help`` shows help for the specific function and exits

 Getter functions can take the following options:

 * ``--execute <command>`` shell command line to execute for each incoming
   response (see section about :ref:`output formatting <ipcon_shell_output>`
   for details)

 Setter functions can take the following options:

 * ``--expect-response`` requests response and waits for it

 The ``--expect-response`` option for setter functions allows to detect
 timeouts and other error conditions calls of setters as well. The device will
 then send a response for this purpose. If this option is not given for a
 setter function then no response is send and errors are silently ignored,
 because they cannot be detected.


.. sh:function:: X Stinkerforge Sdispatch Ptemperature-ir-bricklet L<uid> N<callback> A[<option>..]

 :param <uid>: string
 :param <callback>: string

 The ``<callback>`` to be dispatched can take several options:

 * ``--help`` shows help for the specific callback and exits
 * ``--execute <command>`` shell command line to execute for each incoming
   response (see section about :ref:`output formatting <ipcon_shell_output>`
   for details)



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



.. sh:function:: tinkerforge call temperature-ir-bricklet <uid> get-ambient-temperature  


 :returns 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 :sh:func:`ambient-temperature <temperature-ir-bricklet ambient-temperature>` and set the period with 
 :sh:func:`set-ambient-temperature-callback-period <temperature-ir-bricklet set-ambient-temperature-callback-period>`.
 
.. sh:function:: tinkerforge call temperature-ir-bricklet <uid> get-object-temperature  


 :returns 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 :sh:func:`set-emissivity <temperature-ir-bricklet set-emissivity>`.
 
 If you want to get the object temperature periodically, it is recommended 
 to use the callback :sh:func:`object-temperature <temperature-ir-bricklet object-temperature>` and set the period with 
 :sh:func:`set-object-temperature-callback-period <temperature-ir-bricklet set-object-temperature-callback-period>`.
 


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

.. sh:function:: tinkerforge call temperature-ir-bricklet <uid> set-emissivity <emissivity> 

 :param <emissivity>: int

 :noreturn: no output

 Sets the `emissivity <http://en.wikipedia.org/wiki/Emissivity>`__ that is
 used to calculate the surface temperature as returned by 
 :sh:func:`get-object-temperature <temperature-ir-bricklet 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 :sh:func:`set-emissivity <temperature-ir-bricklet 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).
 
.. sh:function:: tinkerforge call temperature-ir-bricklet <uid> get-emissivity  


 :returns emissivity: int

 Returns the emissivity as set by :sh:func:`set-emissivity <temperature-ir-bricklet set-emissivity>`.
 
.. sh:function:: tinkerforge call temperature-ir-bricklet <uid> get-identity  


 :returns uid: string
 :returns connected-uid: string
 :returns position: char
 :returns hardware-version: int,int,int
 :returns firmware-version: int,int,int
 :returns device-identifier: int (has symbols)

 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|
 


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



.. sh:function:: tinkerforge call temperature-ir-bricklet <uid> set-ambient-temperature-callback-period <period> 

 :param <period>: int

 :noreturn: no output

 Sets the period in ms with which the :sh:func:`ambient-temperature <temperature-ir-bricklet ambient-temperature>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :sh:func:`ambient-temperature <temperature-ir-bricklet ambient-temperature>` is only triggered if the temperature has changed since the
 last triggering.
 
 The default value is 0.
 
.. sh:function:: tinkerforge call temperature-ir-bricklet <uid> get-ambient-temperature-callback-period  


 :returns period: int

 Returns the period as set by :sh:func:`set-ambient-temperature-callback-period <temperature-ir-bricklet set-ambient-temperature-callback-period>`.
 
.. sh:function:: tinkerforge call temperature-ir-bricklet <uid> set-object-temperature-callback-period <period> 

 :param <period>: int

 :noreturn: no output

 Sets the period in ms with which the :sh:func:`object-temperature <temperature-ir-bricklet object-temperature>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :sh:func:`object-temperature <temperature-ir-bricklet object-temperature>` is only triggered if the temperature has changed since the
 last triggering.
 
 The default value is 0.
 
.. sh:function:: tinkerforge call temperature-ir-bricklet <uid> get-object-temperature-callback-period  


 :returns period: int

 Returns the period as set by :sh:func:`set-object-temperature-callback-period <temperature-ir-bricklet set-object-temperature-callback-period>`.
 
.. sh:function:: tinkerforge call temperature-ir-bricklet <uid> set-ambient-temperature-callback-threshold <option> <min> <max> 

 :param <option>: char (has symbols)
 :param <min>: int
 :param <max>: int

 :noreturn: no output

 Sets the thresholds for the :sh:func:`ambient-temperature-reached <temperature-ir-bricklet 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 symbols are available for this function:
 
 * ``off`` = x, for <option>
 * ``outside`` = o, for <option>
 * ``inside`` = i, for <option>
 * ``smaller`` = <, for <option>
 * ``greater`` = >, for <option>
 
.. sh:function:: tinkerforge call temperature-ir-bricklet <uid> get-ambient-temperature-callback-threshold  


 :returns option: char (has symbols)
 :returns min: int
 :returns max: int

 Returns the threshold as set by :sh:func:`set-ambient-temperature-callback-threshold <temperature-ir-bricklet set-ambient-temperature-callback-threshold>`.
 
 The following symbols are available for this function:
 
 * ``off`` = x, for option
 * ``outside`` = o, for option
 * ``inside`` = i, for option
 * ``smaller`` = <, for option
 * ``greater`` = >, for option
 
.. sh:function:: tinkerforge call temperature-ir-bricklet <uid> set-object-temperature-callback-threshold <option> <min> <max> 

 :param <option>: char (has symbols)
 :param <min>: int
 :param <max>: int

 :noreturn: no output

 Sets the thresholds for the :sh:func:`object-temperature-reached <temperature-ir-bricklet 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 symbols are available for this function:
 
 * ``off`` = x, for <option>
 * ``outside`` = o, for <option>
 * ``inside`` = i, for <option>
 * ``smaller`` = <, for <option>
 * ``greater`` = >, for <option>
 
.. sh:function:: tinkerforge call temperature-ir-bricklet <uid> get-object-temperature-callback-threshold  


 :returns option: char (has symbols)
 :returns min: int
 :returns max: int

 Returns the threshold as set by :sh:func:`set-object-temperature-callback-threshold <temperature-ir-bricklet set-object-temperature-callback-threshold>`.
 
 The following symbols are available for this function:
 
 * ``off`` = x, for option
 * ``outside`` = o, for option
 * ``inside`` = i, for option
 * ``smaller`` = <, for option
 * ``greater`` = >, for option
 
.. sh:function:: tinkerforge call temperature-ir-bricklet <uid> set-debounce-period <debounce> 

 :param <debounce>: int

 :noreturn: no output

 Sets the period in ms with which the threshold callbacks
 
 * :sh:func:`ambient-temperature-reached <temperature-ir-bricklet ambient-temperature-reached>`,
 * :sh:func:`object-temperature-reached <temperature-ir-bricklet object-temperature-reached>`
 
 are triggered, if the thresholds
 
 * :sh:func:`set-ambient-temperature-callback-threshold <temperature-ir-bricklet set-ambient-temperature-callback-threshold>`,
 * :sh:func:`set-object-temperature-callback-threshold <temperature-ir-bricklet set-object-temperature-callback-threshold>`
 
 keep being reached.
 
 The default value is 100.
 
.. sh:function:: tinkerforge call temperature-ir-bricklet <uid> get-debounce-period  


 :returns debounce: int

 Returns the debounce period as set by :sh:func:`set-debounce-period <temperature-ir-bricklet set-debounce-period>`.
 


.. _temperature_ir_bricklet_shell_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be used to receive time critical or recurring data from the
device:

.. code-block:: bash

    tinkerforge dispatch temperature-ir-bricklet <uid> example

The available callbacks 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.

.. sh:function::  tinkerforge dispatch temperature-ir-bricklet <uid> ambient-temperature

 :returns temperature: int


 This callback is triggered periodically with the period that is set by
 :sh:func:`set-ambient-temperature-callback-period <temperature-ir-bricklet set-ambient-temperature-callback-period>`. The parameter is the ambient
 temperature of the sensor.
 
 :sh:func:`ambient-temperature <temperature-ir-bricklet ambient-temperature>` is only triggered if the ambient temperature
 has changed since the last triggering.
 
.. sh:function::  tinkerforge dispatch temperature-ir-bricklet <uid> object-temperature

 :returns temperature: int


 This callback is triggered periodically with the period that is set by
 :sh:func:`set-object-temperature-callback-period <temperature-ir-bricklet set-object-temperature-callback-period>`. The parameter is the object
 temperature of the sensor.
 
 :sh:func:`object-temperature <temperature-ir-bricklet object-temperature>` is only triggered if the object temperature
 has changed since the last triggering.
 
.. sh:function::  tinkerforge dispatch temperature-ir-bricklet <uid> ambient-temperature-reached

 :returns temperature: int


 This callback is triggered when the threshold as set by
 :sh:func:`set-ambient-temperature-callback-threshold <temperature-ir-bricklet 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 :sh:func:`set-debounce-period <temperature-ir-bricklet set-debounce-period>`.
 
.. sh:function::  tinkerforge dispatch temperature-ir-bricklet <uid> object-temperature-reached

 :returns temperature: int


 This callback is triggered when the threshold as set by
 :sh:func:`set-object-temperature-callback-threshold <temperature-ir-bricklet 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 :sh:func:`set-debounce-period <temperature-ir-bricklet set-debounce-period>`.
 


