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

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

.. _temperature_ir_bricklet_csharp:

C# - Temperature IR Bricklet
============================

This is the description of the :ref:`C# API bindings <api_bindings_csharp>` 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_csharp_install>` for the C# API
bindings is part of their general description.

.. _temperature_ir_bricklet_csharp_examples:


Examples
--------

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

Simple
^^^^^^

`Download (ExampleSimple.cs) <https://github.com/Tinkerforge/temperature-ir-bricklet/raw/master/software/examples/csharp/ExampleSimple.cs>`__

.. literalinclude:: TemperatureIR_Bricklet_CSharp_ExampleSimple.cs
 :language: csharp
 :linenos:
 :tab-width: 4

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

`Download (ExampleWaterBoiling.cs) <https://github.com/Tinkerforge/temperature-ir-bricklet/raw/master/software/examples/csharp/ExampleWaterBoiling.cs>`__

.. literalinclude:: TemperatureIR_Bricklet_CSharp_ExampleWaterBoiling.cs
 :language: csharp
 :linenos:
 :tab-width: 4

Callback
^^^^^^^^

`Download (ExampleCallback.cs) <https://github.com/Tinkerforge/temperature-ir-bricklet/raw/master/software/examples/csharp/ExampleCallback.cs>`__

.. literalinclude:: TemperatureIR_Bricklet_CSharp_ExampleCallback.cs
 :language: csharp
 :linenos:
 :tab-width: 4

.. _temperature_ir_bricklet_csharp_api:

API
---

Generally, every method of the C# bindings that returns a value can
throw a ``Tinkerforge.TimeoutException``. This exception gets thrown if the
device did not respond. If a cable based connection is used, it is
unlikely that this exception gets thrown (assuming nobody plugs the
device out). However, if a wireless connection is used, timeouts will occur
if the distance to the device gets too big.

Since C# does not support multiple return values directly, we use the ``out``
keyword to return multiple values from a method.

The namespace for all Brick/Bricklet bindings and the IPConnection is
``Tinkerforge.*``.

All methods listed below are thread-safe.




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


.. csharp:function:: class BrickletTemperatureIR(String uid, IPConnection ipcon)

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

 .. code-block:: csharp

  BrickletTemperatureIR temperatureIR = new BrickletTemperatureIR("YOUR_DEVICE_UID", ipcon);

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


.. csharp:function:: public short BrickletTemperatureIR::GetAmbientTemperature()

 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 :csharp:func:`AmbientTemperature <BrickletTemperatureIR::AmbientTemperature>` and set the period with 
 :csharp:func:`SetAmbientTemperatureCallbackPeriod() <BrickletTemperatureIR::SetAmbientTemperatureCallbackPeriod>`.
 
.. csharp:function:: public short BrickletTemperatureIR::GetObjectTemperature()

 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 :csharp:func:`SetEmissivity() <BrickletTemperatureIR::SetEmissivity>`.
 
 If you want to get the object temperature periodically, it is recommended 
 to use the callback :csharp:func:`ObjectTemperature <BrickletTemperatureIR::ObjectTemperature>` and set the period with 
 :csharp:func:`SetObjectTemperatureCallbackPeriod() <BrickletTemperatureIR::SetObjectTemperatureCallbackPeriod>`.
 


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

.. csharp:function:: public void BrickletTemperatureIR::SetEmissivity(int emissivity)

 Sets the `emissivity <http://en.wikipedia.org/wiki/Emissivity>`__ that is
 used to calculate the surface temperature as returned by 
 :csharp:func:`GetObjectTemperature() <BrickletTemperatureIR::GetObjectTemperature>`. 
 
 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 :csharp:func:`SetEmissivity() <BrickletTemperatureIR::SetEmissivity>` 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).
 
.. csharp:function:: public int BrickletTemperatureIR::GetEmissivity()

 Returns the emissivity as set by :csharp:func:`SetEmissivity() <BrickletTemperatureIR::SetEmissivity>`.
 
.. csharp:function:: public byte[] BrickletTemperatureIR::GetAPIVersion()

 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.
 
.. csharp:function:: public bool BrickletTemperatureIR::GetResponseExpected(byte functionId)

 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
 :csharp:func:`SetResponseExpected() <BrickletTemperatureIR::SetResponseExpected>`. 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 :csharp:func:`SetResponseExpected() <BrickletTemperatureIR::SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. csharp:function:: public void BrickletTemperatureIR::SetResponseExpected(byte functionId, bool responseExpected)

 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
 
.. csharp:function:: public void BrickletTemperatureIR::SetResponseExpectedAll(bool responseExpected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. csharp:function:: public void BrickletTemperatureIR::GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)

 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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



.. csharp:function:: public void BrickletTemperatureIR::SetAmbientTemperatureCallbackPeriod(long period)

 Sets the period in ms with which the :csharp:func:`AmbientTemperature <BrickletTemperatureIR::AmbientTemperature>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :csharp:func:`AmbientTemperature <BrickletTemperatureIR::AmbientTemperature>` is only triggered if the temperature has changed since the
 last triggering.
 
 The default value is 0.
 
.. csharp:function:: public long BrickletTemperatureIR::GetAmbientTemperatureCallbackPeriod()

 Returns the period as set by :csharp:func:`SetAmbientTemperatureCallbackPeriod() <BrickletTemperatureIR::SetAmbientTemperatureCallbackPeriod>`.
 
.. csharp:function:: public void BrickletTemperatureIR::SetObjectTemperatureCallbackPeriod(long period)

 Sets the period in ms with which the :csharp:func:`ObjectTemperature <BrickletTemperatureIR::ObjectTemperature>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :csharp:func:`ObjectTemperature <BrickletTemperatureIR::ObjectTemperature>` is only triggered if the temperature has changed since the
 last triggering.
 
 The default value is 0.
 
.. csharp:function:: public long BrickletTemperatureIR::GetObjectTemperatureCallbackPeriod()

 Returns the period as set by :csharp:func:`SetObjectTemperatureCallbackPeriod() <BrickletTemperatureIR::SetObjectTemperatureCallbackPeriod>`.
 
.. csharp:function:: public void BrickletTemperatureIR::SetAmbientTemperatureCallbackThreshold(char option, short min, short max)

 Sets the thresholds for the :csharp:func:`AmbientTemperatureReached <BrickletTemperatureIR::AmbientTemperatureReached>` 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 = '>'
 
.. csharp:function:: public void BrickletTemperatureIR::GetAmbientTemperatureCallbackThreshold(out char option, out short min, out short max)

 Returns the threshold as set by :csharp:func:`SetAmbientTemperatureCallbackThreshold() <BrickletTemperatureIR::SetAmbientTemperatureCallbackThreshold>`.
 
 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 = '>'
 
.. csharp:function:: public void BrickletTemperatureIR::SetObjectTemperatureCallbackThreshold(char option, short min, short max)

 Sets the thresholds for the :csharp:func:`ObjectTemperatureReached <BrickletTemperatureIR::ObjectTemperatureReached>` 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 = '>'
 
.. csharp:function:: public void BrickletTemperatureIR::GetObjectTemperatureCallbackThreshold(out char option, out short min, out short max)

 Returns the threshold as set by :csharp:func:`SetObjectTemperatureCallbackThreshold() <BrickletTemperatureIR::SetObjectTemperatureCallbackThreshold>`.
 
 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 = '>'
 
.. csharp:function:: public void BrickletTemperatureIR::SetDebouncePeriod(long debounce)

 Sets the period in ms with which the threshold callbacks
 
 * :csharp:func:`AmbientTemperatureReached <BrickletTemperatureIR::AmbientTemperatureReached>`,
 * :csharp:func:`ObjectTemperatureReached <BrickletTemperatureIR::ObjectTemperatureReached>`
 
 are triggered, if the thresholds
 
 * :csharp:func:`SetAmbientTemperatureCallbackThreshold() <BrickletTemperatureIR::SetAmbientTemperatureCallbackThreshold>`,
 * :csharp:func:`SetObjectTemperatureCallbackThreshold() <BrickletTemperatureIR::SetObjectTemperatureCallbackThreshold>`
 
 keep being reached.
 
 The default value is 100.
 
.. csharp:function:: public long BrickletTemperatureIR::GetDebouncePeriod()

 Returns the debounce period as set by :csharp:func:`SetDebouncePeriod() <BrickletTemperatureIR::SetDebouncePeriod>`.
 


.. _temperature_ir_bricklet_csharp_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive time critical or recurring data from
the device. The registration is done by appending your callback handler to
the corresponding event:

.. code-block:: csharp

    void Callback(BrickletTemperatureIR sender, int value)
    {
        System.Console.WriteLine("Value: " + value);
    }

    temperatureIR.ExampleCallback += Callback;

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


.. csharp:function:: public event BrickletTemperatureIR::AmbientTemperature(BrickletTemperatureIR sender, short temperature)


  This callback is triggered periodically with the period that is set by
  :csharp:func:`SetAmbientTemperatureCallbackPeriod() <BrickletTemperatureIR::SetAmbientTemperatureCallbackPeriod>`. The parameter is the ambient
  temperature of the sensor.
  
  :csharp:func:`AmbientTemperature <BrickletTemperatureIR::AmbientTemperature>` is only triggered if the ambient temperature
  has changed since the last triggering.
  

.. csharp:function:: public event BrickletTemperatureIR::ObjectTemperature(BrickletTemperatureIR sender, short temperature)


  This callback is triggered periodically with the period that is set by
  :csharp:func:`SetObjectTemperatureCallbackPeriod() <BrickletTemperatureIR::SetObjectTemperatureCallbackPeriod>`. The parameter is the object
  temperature of the sensor.
  
  :csharp:func:`ObjectTemperature <BrickletTemperatureIR::ObjectTemperature>` is only triggered if the object temperature
  has changed since the last triggering.
  

.. csharp:function:: public event BrickletTemperatureIR::AmbientTemperatureReached(BrickletTemperatureIR sender, short temperature)


  This callback is triggered when the threshold as set by
  :csharp:func:`SetAmbientTemperatureCallbackThreshold() <BrickletTemperatureIR::SetAmbientTemperatureCallbackThreshold>` 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 :csharp:func:`SetDebouncePeriod() <BrickletTemperatureIR::SetDebouncePeriod>`.
  

.. csharp:function:: public event BrickletTemperatureIR::ObjectTemperatureReached(BrickletTemperatureIR sender, short temperature)


  This callback is triggered when the threshold as set by
  :csharp:func:`SetObjectTemperatureCallbackThreshold() <BrickletTemperatureIR::SetObjectTemperatureCallbackThreshold>` 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 :csharp:func:`SetDebouncePeriod() <BrickletTemperatureIR::SetDebouncePeriod>`.
  


.. _temperature_ir_bricklet_csharp_constants:

Constants
^^^^^^^^^

.. csharp:member:: public int BrickletTemperatureIR::DEVICE_IDENTIFIER

 This constant is used to identify a Temperature IR Bricklet.

 The :csharp:func:`GetIdentity() <BrickletTemperatureIR::GetIdentity>` function and the
 :csharp:func:`EnumerateCallback <IPConnection::EnumerateCallback>`
 callback of the IP Connection have a ``deviceIdentifier`` parameter to specify
 the Brick's or Bricklet's type.

