/ 
Tinkerforge-2.1.8
River stage zero No dependents
/ Tinkerforge::BrickletCO2

NAME

Tinkerforge::BrickletCO2 - Measures CO2 concentration in ppm

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a CO2 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 CO2 Bricklet.

CALLBACK_CO2_CONCENTRATION

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

CALLBACK_CO2_CONCENTRATION_REACHED

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

FUNCTION_GET_CO2_CONCENTRATION

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

FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD

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

FUNCTION_GET_CO2_CONCENTRATION_CALLBACK_PERIOD

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

FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD

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

FUNCTION_GET_CO2_CONCENTRATION_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_co2_concentration()

Returns the measured CO2 concentration. The value is in `ppm (parts per million) <https://en.wikipedia.org/wiki/Parts-per_notation>`__ and between 0 to 10000.

If you want to get the CO2 concentration periodically, it is recommended to use the callback :func:`CO2Concentration` and set the period with :func:`SetCO2ConcentrationCallbackPeriod`.

set_co2_concentration_callback_period()

Sets the period in ms with which the :func:`CO2Concentration` callback is triggered periodically. A value of 0 turns the callback off.

:func:`CO2Concentration` is only triggered if the CO2 concentration has changed since the last triggering.

The default value is 0.

get_co2_concentration_callback_period()

Returns the period as set by :func:`SetCO2ConcentrationCallbackPeriod`.

set_co2_concentration_callback_threshold()

Sets the thresholds for the :func:`CO2ConcentrationReached` 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 CO2 concentration is *outside* the min and max values"
"'i'",    "Callback is triggered when the CO2 concentration is *inside* the min and max values"
"'<'",    "Callback is triggered when the CO2 concentration is smaller than the min value (max is ignored)"
"'>'",    "Callback is triggered when the CO2 concentration is greater than the min value (max is ignored)"

The default value is ('x', 0, 0).

get_co2_concentration_callback_threshold()

Returns the threshold as set by :func:`SetCO2ConcentrationCallbackThreshold`.

set_debounce_period()

Sets the period in ms with which the threshold callbacks

* :func:`CO2ConcentrationReached`,

are triggered, if the thresholds

* :func:`SetCO2ConcentrationCallbackThreshold`,

keep being reached.

The default value is 100.

get_debounce_period()

Returns the debounce period as set by :func:`SetDebouncePeriod`.

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' or 'd'.

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