..
 #############################################################
 # 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-tcpip">Software</a> / TCP/IP - Humidity Bricklet

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

.. _humidity_bricklet_tcpip:

TCP/IP - Humidity Bricklet
==========================

This is the description of the :ref:`TCP/IP protocol <llproto_tcpip>` 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>`.

.. _humidity_bricklet_tcpip_api:

API
---

A general description of the TCP/IP protocol structure can be found
:ref:`here <llproto_tcpip>`.




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



.. tcpip:function:: BrickletHumidity.get_humidity

 :functionid: 1
 :emptyrequest: empty payload

 :response humidity: uint16

 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 :tcpip:func:`CALLBACK_HUMIDITY <BrickletHumidity.CALLBACK_HUMIDITY>` and set the period with 
 :tcpip:func:`set_humidity_callback_period <BrickletHumidity.set_humidity_callback_period>`.
 


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

.. tcpip:function:: BrickletHumidity.get_analog_value

 :functionid: 2
 :emptyrequest: empty payload

 :response value: uint16

 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 :tcpip:func:`get_humidity <BrickletHumidity.get_humidity>` is averaged over several samples
  to yield less noise, while :tcpip:func:`get_analog_value <BrickletHumidity.get_analog_value>` 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 :tcpip:func:`CALLBACK_ANALOG_VALUE <BrickletHumidity.CALLBACK_ANALOG_VALUE>` and set the period with 
 :tcpip:func:`set_analog_value_callback_period <BrickletHumidity.set_analog_value_callback_period>`.
 
.. tcpip:function:: BrickletHumidity.get_identity

 :functionid: 255
 :emptyrequest: empty payload

 :response uid: char[8]
 :response connected_uid: char[8]
 :response position: char
 :response hardware_version: uint8[3]
 :response firmware_version: uint8[3]
 :response device_identifier: uint16

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



.. tcpip:function:: BrickletHumidity.set_humidity_callback_period

 :functionid: 3
 :request period: uint32

 :noresponse: no response

 Sets the period in ms with which the :tcpip:func:`CALLBACK_HUMIDITY <BrickletHumidity.CALLBACK_HUMIDITY>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :tcpip:func:`CALLBACK_HUMIDITY <BrickletHumidity.CALLBACK_HUMIDITY>` is only triggered if the humidity has changed since the
 last triggering.
 
 The default value is 0.
 
.. tcpip:function:: BrickletHumidity.get_humidity_callback_period

 :functionid: 4
 :emptyrequest: empty payload

 :response period: uint32

 Returns the period as set by :tcpip:func:`set_humidity_callback_period <BrickletHumidity.set_humidity_callback_period>`.
 
.. tcpip:function:: BrickletHumidity.set_analog_value_callback_period

 :functionid: 5
 :request period: uint32

 :noresponse: no response

 Sets the period in ms with which the :tcpip:func:`CALLBACK_ANALOG_VALUE <BrickletHumidity.CALLBACK_ANALOG_VALUE>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :tcpip:func:`CALLBACK_ANALOG_VALUE <BrickletHumidity.CALLBACK_ANALOG_VALUE>` is only triggered if the analog value has changed since the
 last triggering.
 
 The default value is 0.
 
.. tcpip:function:: BrickletHumidity.get_analog_value_callback_period

 :functionid: 6
 :emptyrequest: empty payload

 :response period: uint32

 Returns the period as set by :tcpip:func:`set_analog_value_callback_period <BrickletHumidity.set_analog_value_callback_period>`.
 
.. tcpip:function:: BrickletHumidity.set_humidity_callback_threshold

 :functionid: 7
 :request option: char
 :request min: int16
 :request max: int16

 :noresponse: no response

 Sets the thresholds for the :tcpip:func:`CALLBACK_HUMIDITY_REACHED <BrickletHumidity.CALLBACK_HUMIDITY_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 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).
 
.. tcpip:function:: BrickletHumidity.get_humidity_callback_threshold

 :functionid: 8
 :emptyrequest: empty payload

 :response option: char
 :response min: int16
 :response max: int16

 Returns the threshold as set by :tcpip:func:`set_humidity_callback_threshold <BrickletHumidity.set_humidity_callback_threshold>`.
 
.. tcpip:function:: BrickletHumidity.set_analog_value_callback_threshold

 :functionid: 9
 :request option: char
 :request min: uint16
 :request max: uint16

 :noresponse: no response

 Sets the thresholds for the :tcpip:func:`CALLBACK_ANALOG_VALUE_REACHED <BrickletHumidity.CALLBACK_ANALOG_VALUE_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 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).
 
.. tcpip:function:: BrickletHumidity.get_analog_value_callback_threshold

 :functionid: 10
 :emptyrequest: empty payload

 :response option: char
 :response min: uint16
 :response max: uint16

 Returns the threshold as set by :tcpip:func:`set_analog_value_callback_threshold <BrickletHumidity.set_analog_value_callback_threshold>`.
 
.. tcpip:function:: BrickletHumidity.set_debounce_period

 :functionid: 11
 :request debounce: uint32

 :noresponse: no response

 Sets the period in ms with which the threshold callbacks
 
 * :tcpip:func:`CALLBACK_HUMIDITY_REACHED <BrickletHumidity.CALLBACK_HUMIDITY_REACHED>`,
 * :tcpip:func:`CALLBACK_ANALOG_VALUE_REACHED <BrickletHumidity.CALLBACK_ANALOG_VALUE_REACHED>`
 
 are triggered, if the thresholds
 
 * :tcpip:func:`set_humidity_callback_threshold <BrickletHumidity.set_humidity_callback_threshold>`,
 * :tcpip:func:`set_analog_value_callback_threshold <BrickletHumidity.set_analog_value_callback_threshold>`
 
 keep being reached.
 
 The default value is 100.
 
.. tcpip:function:: BrickletHumidity.get_debounce_period

 :functionid: 12
 :emptyrequest: empty payload

 :response debounce: uint32

 Returns the debounce period as set by :tcpip:func:`set_debounce_period <BrickletHumidity.set_debounce_period>`.
 


.. _humidity_bricklet_tcpip_callbacks:

Callbacks
^^^^^^^^^

.. tcpip:function:: BrickletHumidity.CALLBACK_HUMIDITY

 :functionid: 13

 :response humidity: uint16


 This callback is triggered periodically with the period that is set by
 :tcpip:func:`set_humidity_callback_period <BrickletHumidity.set_humidity_callback_period>`. The response value is the humidity of the
 sensor.
 
 :tcpip:func:`CALLBACK_HUMIDITY <BrickletHumidity.CALLBACK_HUMIDITY>` is only triggered if the humidity has changed since the
 last triggering.
 
.. tcpip:function:: BrickletHumidity.CALLBACK_ANALOG_VALUE

 :functionid: 14

 :response value: uint16


 This callback is triggered periodically with the period that is set by
 :tcpip:func:`set_analog_value_callback_period <BrickletHumidity.set_analog_value_callback_period>`. The response value is the analog value of the
 sensor.
 
 :tcpip:func:`CALLBACK_ANALOG_VALUE <BrickletHumidity.CALLBACK_ANALOG_VALUE>` is only triggered if the humidity has changed since the
 last triggering.
 
.. tcpip:function:: BrickletHumidity.CALLBACK_HUMIDITY_REACHED

 :functionid: 15

 :response humidity: uint16


 This callback is triggered when the threshold as set by
 :tcpip:func:`set_humidity_callback_threshold <BrickletHumidity.set_humidity_callback_threshold>` is reached.
 The response value is the humidity of the sensor.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :tcpip:func:`set_debounce_period <BrickletHumidity.set_debounce_period>`.
 
.. tcpip:function:: BrickletHumidity.CALLBACK_ANALOG_VALUE_REACHED

 :functionid: 16

 :response value: uint16


 This callback is triggered when the threshold as set by
 :tcpip:func:`set_analog_value_callback_threshold <BrickletHumidity.set_analog_value_callback_threshold>` is reached.
 The response value is the analog value of the sensor.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :tcpip:func:`set_debounce_period <BrickletHumidity.set_debounce_period>`.
 


