/ 
Tinkerforge-2.1.28
River stage zero No dependents
/ Tinkerforge::BrickletHumidity

NAME

Tinkerforge::BrickletHumidity - Measures relative humidity

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a Humidity Bricklet.

The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

DEVICE_DISPLAY_NAME

This constant represents the display name of a Humidity Bricklet.

CALLBACK_HUMIDITY

This constant is used with the register_callback() subroutine to specify the CALLBACK_HUMIDITY callback.

CALLBACK_ANALOG_VALUE

This constant is used with the register_callback() subroutine to specify the CALLBACK_ANALOG_VALUE callback.

CALLBACK_HUMIDITY_REACHED

This constant is used with the register_callback() subroutine to specify the CALLBACK_HUMIDITY_REACHED callback.

CALLBACK_ANALOG_VALUE_REACHED

This constant is used with the register_callback() subroutine to specify the CALLBACK_ANALOG_VALUE_REACHED callback.

FUNCTION_GET_HUMIDITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_ANALOG_VALUE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_HUMIDITY_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_HUMIDITY_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_DEBOUNCE_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_DEBOUNCE_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_IDENTITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTIONS

new()

Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.

get_humidity()

Returns the humidity of the sensor.

If you want to get the humidity periodically, it is recommended to use the :cb:`Humidity` callback and set the period with :func:`Set Humidity Callback Period`.

get_analog_value()

Returns the value as read by a 12-bit analog-to-digital converter.

.. note:: The value returned by :func:`Get Humidity` is averaged over several samples to yield less noise, while :func:`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 :cb:`Analog Value` callback and set the period with :func:`Set Analog Value Callback Period`.

set_humidity_callback_period()

Sets the period with which the :cb:`Humidity` callback is triggered periodically. A value of 0 turns the callback off.

The :cb:`Humidity` callback is only triggered if the humidity has changed since the last triggering.

get_humidity_callback_period()

Returns the period as set by :func:`Set Humidity Callback Period`.

set_analog_value_callback_period()

Sets the period with which the :cb:`Analog Value` callback is triggered periodically. A value of 0 turns the callback off.

The :cb:`Analog Value` callback is only triggered if the analog value has changed since the last triggering.

get_analog_value_callback_period()

Returns the period as set by :func:`Set Analog Value Callback Period`.

set_humidity_callback_threshold()

Sets the thresholds for the :cb:`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)"
get_humidity_callback_threshold()

Returns the threshold as set by :func:`Set Humidity Callback Threshold`.

set_analog_value_callback_threshold()

Sets the thresholds for the :cb:`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)"
get_analog_value_callback_threshold()

Returns the threshold as set by :func:`Set Analog Value Callback Threshold`.

set_debounce_period()

Sets the period with which the threshold callbacks

* :cb:`Humidity Reached`, * :cb:`Analog Value Reached`

are triggered, if the thresholds

* :func:`Set Humidity Callback Threshold`, * :func:`Set Analog Value Callback Threshold`

keep being reached.

get_debounce_period()

Returns the debounce period as set by :func:`Set Debounce Period`.

get_identity()

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|