..
 #############################################################
 # This file was automatically generated on 2015-05-19.      #
 #                                                           #
 # 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       #
 #############################################################

:orphan:
:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-tcpip">Software</a> / TCP/IP - CO2 Bricklet

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

.. _co2_bricklet_tcpip:

TCP/IP - CO2 Bricklet
=====================

.. note::
 This Bricklet is currently in the prototype stage and the software/hardware
 as well as the documentation is in an incomplete state.


This is the description of the :ref:`TCP/IP protocol <llproto_tcpip>` for the :ref:`CO2 Bricklet <co2_bricklet>`. General information and technical
specifications for the CO2 Bricklet are summarized in its :ref:`hardware description
<co2_bricklet_description>`.

.. _co2_bricklet_tcpip_api:

API
---

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




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



.. tcpip:function:: BrickletCO2.get_co2_concentration

 :functionid: 1
 :emptyrequest: empty payload

 :response co2_concentration: uint16

 Returns the measured CO2 concentration. The value is in ppb and
 between TBD and TBD.
 
 If you want to get the CO2 concentration periodically, it is recommended to use the
 callback :tcpip:func:`CALLBACK_CO2_CONCENTRATION <BrickletCO2.CALLBACK_CO2_CONCENTRATION>` and set the period with
 :tcpip:func:`set_co2_concentration_callback_period <BrickletCO2.set_co2_concentration_callback_period>`.
 


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

.. tcpip:function:: BrickletCO2.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:: BrickletCO2.set_co2_concentration_callback_period

 :functionid: 2
 :request period: uint32

 :noresponse: no response

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

 :functionid: 3
 :emptyrequest: empty payload

 :response period: uint32

 Returns the period as set by :tcpip:func:`set_co2_concentration_callback_period <BrickletCO2.set_co2_concentration_callback_period>`.
 
.. tcpip:function:: BrickletCO2.set_co2_concentration_callback_threshold

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

 :noresponse: no response

 Sets the thresholds for the :tcpip:func:`CALLBACK_CO2_CONCENTRATION_REACHED <BrickletCO2.CALLBACK_CO2_CONCENTRATION_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 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).
 
.. tcpip:function:: BrickletCO2.get_co2_concentration_callback_threshold

 :functionid: 5
 :emptyrequest: empty payload

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

 Returns the threshold as set by :tcpip:func:`set_co2_concentration_callback_threshold <BrickletCO2.set_co2_concentration_callback_threshold>`.
 
.. tcpip:function:: BrickletCO2.set_debounce_period

 :functionid: 6
 :request debounce: uint32

 :noresponse: no response

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

 :functionid: 7
 :emptyrequest: empty payload

 :response debounce: uint32

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


.. _co2_bricklet_tcpip_callbacks:

Callbacks
^^^^^^^^^

.. tcpip:function:: BrickletCO2.CALLBACK_CO2_CONCENTRATION

 :functionid: 8

 :response co2_concentration: uint16


 This callback is triggered periodically with the period that is set by
 :tcpip:func:`set_co2_concentration_callback_period <BrickletCO2.set_co2_concentration_callback_period>`. The response value is the co2 concentration of the
 sensor.
 
 :tcpip:func:`CALLBACK_CO2_CONCENTRATION <BrickletCO2.CALLBACK_CO2_CONCENTRATION>` is only triggered if the co2 concentration has changed since the
 last triggering.
 
.. tcpip:function:: BrickletCO2.CALLBACK_CO2_CONCENTRATION_REACHED

 :functionid: 9

 :response co2_concentration: uint16


 This callback is triggered when the threshold as set by
 :tcpip:func:`set_co2_concentration_callback_threshold <BrickletCO2.set_co2_concentration_callback_threshold>` is reached.
 The response value is the CO2 concentration.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :tcpip:func:`set_debounce_period <BrickletCO2.set_debounce_period>`.
 


