..
 #############################################################
 # 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# - Humidity Bricklet

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

.. _humidity_bricklet_csharp:

C# - Humidity Bricklet
======================

This is the description of the :ref:`C# API bindings <api_bindings_csharp>` for the :ref:`Humidity Bricklet <humidity_bricklet>`. General information and technical
specifications for the Humidity Bricklet are summarized in its :ref:`hardware description
<humidity_bricklet_description>`.

An :ref:`installation guide <api_bindings_csharp_install>` for the C# API
bindings is part of their general description.

.. _humidity_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/humidity-bricklet/raw/master/software/examples/csharp/ExampleSimple.cs>`__

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

Callback
^^^^^^^^

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

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

Threshold
^^^^^^^^^

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

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

.. _humidity_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 BrickletHumidity(String uid, IPConnection ipcon)

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

 .. code-block:: csharp

  BrickletHumidity humidity = new BrickletHumidity("YOUR_DEVICE_UID", ipcon);

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


.. csharp:function:: public int BrickletHumidity::GetHumidity()

 Returns the humidity of the sensor. The value
 has a range of 0 to 1000 and is given in %RH/10 (Relative Humidity), 
 i.e. a value of 421 means that a humidity of 42.1 %RH is measured.
 
 If you want to get the humidity periodically, it is recommended to use the
 callback :csharp:func:`Humidity <BrickletHumidity::Humidity>` and set the period with 
 :csharp:func:`SetHumidityCallbackPeriod() <BrickletHumidity::SetHumidityCallbackPeriod>`.
 


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

.. csharp:function:: public int BrickletHumidity::GetAnalogValue()

 Returns the value as read by a 12-bit analog-to-digital converter.
 The value is between 0 and 4095.
 
 .. note::
  The value returned by :csharp:func:`GetHumidity() <BrickletHumidity::GetHumidity>` is averaged over several samples
  to yield less noise, while :csharp:func:`GetAnalogValue() <BrickletHumidity::GetAnalogValue>` gives back raw
  unfiltered analog values. The returned humidity value is calibrated for
  room temperatures, if you use the sensor in extreme cold or extreme
  warm environments, you might want to calculate the humidity from
  the analog value yourself. See the `HIH 5030 datasheet
  <https://github.com/Tinkerforge/humidity-bricklet/raw/master/datasheets/hih-5030.pdf>`__.
 
 If you want the analog value periodically, it is recommended to use the 
 callback :csharp:func:`AnalogValue <BrickletHumidity::AnalogValue>` and set the period with 
 :csharp:func:`SetAnalogValueCallbackPeriod() <BrickletHumidity::SetAnalogValueCallbackPeriod>`.
 
.. csharp:function:: public byte[] BrickletHumidity::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 BrickletHumidity::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() <BrickletHumidity::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() <BrickletHumidity::SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. csharp:function:: public void BrickletHumidity::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:
 
 * BrickletHumidity.FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD = 3
 * BrickletHumidity.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
 * BrickletHumidity.FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD = 7
 * BrickletHumidity.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
 * BrickletHumidity.FUNCTION_SET_DEBOUNCE_PERIOD = 11
 
.. csharp:function:: public void BrickletHumidity::SetResponseExpectedAll(bool responseExpected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. csharp:function:: public void BrickletHumidity::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 BrickletHumidity::SetHumidityCallbackPeriod(long period)

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

 Returns the period as set by :csharp:func:`SetHumidityCallbackPeriod() <BrickletHumidity::SetHumidityCallbackPeriod>`.
 
.. csharp:function:: public void BrickletHumidity::SetAnalogValueCallbackPeriod(long period)

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

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

 Sets the thresholds for the :csharp:func:`HumidityReached <BrickletHumidity::HumidityReached>` 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 humidity is *outside* the min and max values"
  "'i'",    "Callback is triggered when the humidity is *inside* the min and max values"
  "'<'",    "Callback is triggered when the humidity is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the humidity is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletHumidity.THRESHOLD_OPTION_OFF = 'x'
 * BrickletHumidity.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletHumidity.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletHumidity.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletHumidity.THRESHOLD_OPTION_GREATER = '>'
 
.. csharp:function:: public void BrickletHumidity::GetHumidityCallbackThreshold(out char option, out short min, out short max)

 Returns the threshold as set by :csharp:func:`SetHumidityCallbackThreshold() <BrickletHumidity::SetHumidityCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BrickletHumidity.THRESHOLD_OPTION_OFF = 'x'
 * BrickletHumidity.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletHumidity.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletHumidity.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletHumidity.THRESHOLD_OPTION_GREATER = '>'
 
.. csharp:function:: public void BrickletHumidity::SetAnalogValueCallbackThreshold(char option, int min, int max)

 Sets the thresholds for the :csharp:func:`AnalogValueReached <BrickletHumidity::AnalogValueReached>` 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 analog value is *outside* the min and max values"
  "'i'",    "Callback is triggered when the analog value is *inside* the min and max values"
  "'<'",    "Callback is triggered when the analog value is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the analog value is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletHumidity.THRESHOLD_OPTION_OFF = 'x'
 * BrickletHumidity.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletHumidity.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletHumidity.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletHumidity.THRESHOLD_OPTION_GREATER = '>'
 
.. csharp:function:: public void BrickletHumidity::GetAnalogValueCallbackThreshold(out char option, out int min, out int max)

 Returns the threshold as set by :csharp:func:`SetAnalogValueCallbackThreshold() <BrickletHumidity::SetAnalogValueCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BrickletHumidity.THRESHOLD_OPTION_OFF = 'x'
 * BrickletHumidity.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletHumidity.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletHumidity.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletHumidity.THRESHOLD_OPTION_GREATER = '>'
 
.. csharp:function:: public void BrickletHumidity::SetDebouncePeriod(long debounce)

 Sets the period in ms with which the threshold callbacks
 
 * :csharp:func:`HumidityReached <BrickletHumidity::HumidityReached>`,
 * :csharp:func:`AnalogValueReached <BrickletHumidity::AnalogValueReached>`
 
 are triggered, if the thresholds
 
 * :csharp:func:`SetHumidityCallbackThreshold() <BrickletHumidity::SetHumidityCallbackThreshold>`,
 * :csharp:func:`SetAnalogValueCallbackThreshold() <BrickletHumidity::SetAnalogValueCallbackThreshold>`
 
 keep being reached.
 
 The default value is 100.
 
.. csharp:function:: public long BrickletHumidity::GetDebouncePeriod()

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


.. _humidity_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(BrickletHumidity sender, int value)
    {
        System.Console.WriteLine("Value: " + value);
    }

    humidity.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 BrickletHumidity::Humidity(BrickletHumidity sender, int humidity)


  This callback is triggered periodically with the period that is set by
  :csharp:func:`SetHumidityCallbackPeriod() <BrickletHumidity::SetHumidityCallbackPeriod>`. The parameter is the humidity of the
  sensor.
  
  :csharp:func:`Humidity <BrickletHumidity::Humidity>` is only triggered if the humidity has changed since the
  last triggering.
  

.. csharp:function:: public event BrickletHumidity::AnalogValue(BrickletHumidity sender, int value)


  This callback is triggered periodically with the period that is set by
  :csharp:func:`SetAnalogValueCallbackPeriod() <BrickletHumidity::SetAnalogValueCallbackPeriod>`. The parameter is the analog value of the
  sensor.
  
  :csharp:func:`AnalogValue <BrickletHumidity::AnalogValue>` is only triggered if the humidity has changed since the
  last triggering.
  

.. csharp:function:: public event BrickletHumidity::HumidityReached(BrickletHumidity sender, int humidity)


  This callback is triggered when the threshold as set by
  :csharp:func:`SetHumidityCallbackThreshold() <BrickletHumidity::SetHumidityCallbackThreshold>` is reached.
  The parameter is the humidity of the sensor.
  
  If the threshold keeps being reached, the callback is triggered periodically
  with the period as set by :csharp:func:`SetDebouncePeriod() <BrickletHumidity::SetDebouncePeriod>`.
  

.. csharp:function:: public event BrickletHumidity::AnalogValueReached(BrickletHumidity sender, int value)


  This callback is triggered when the threshold as set by
  :csharp:func:`SetAnalogValueCallbackThreshold() <BrickletHumidity::SetAnalogValueCallbackThreshold>` is reached.
  The parameter is the analog value of the sensor.
  
  If the threshold keeps being reached, the callback is triggered periodically
  with the period as set by :csharp:func:`SetDebouncePeriod() <BrickletHumidity::SetDebouncePeriod>`.
  


.. _humidity_bricklet_csharp_constants:

Constants
^^^^^^^^^

.. csharp:member:: public int BrickletHumidity::DEVICE_IDENTIFIER

 This constant is used to identify a Humidity Bricklet.

 The :csharp:func:`GetIdentity() <BrickletHumidity::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.

