.. _examples:

Examples
========

.. warning::
    This project is under development and not ready for use.

The following `examples <https://github.com/Infineon/arduino-xensiv-pas-gas-sensor/tree/master/examples>`_ are provided in the library:

.. list-table::

    * - `alarm-nofitication <https://github.com/Infineon/arduino-xensiv-pas-gas-sensor/tree/master/examples/alarm-notification>`_         
      - Readout of the sensor gas concentration based on threshold crossing and synched via hardware interrupt  
    * - `continuous-mode <https://github.com/Infineon/arduino-xensiv-pas-gas-sensor/tree/master/examples/continuous-mode>`_ 
      - Readout of the sensor gas concentration value using continuous measurement mode
    * - `device-id <https://github.com/Infineon/arduino-xensiv-pas-gas-sensor/tree/master/examples/device-id>`_    
      - Readout of the sensor devices product and revision identifiers 
    * - `early-notification <https://github.com/Infineon/arduino-xensiv-pas-gas-sensor/tree/master/examples/early-notification>`_    
      - Readout of the sensor gas concentration based on early notification synched via hardware interrupt 
    * - `forced-compensation <https://github.com/Infineon/arduino-xensiv-pas-gas-sensor/tree/master/examples/forced-compensation>`_    
      - Set gas reference offset using forced compensation 
    * - `single-shot-mode <https://github.com/Infineon/arduino-xensiv-pas-gas-sensor/tree/master/examples/single-shot-mode>`_ 
      - Readout of the sensor gas concentration value using single shot measurement mode
    * - `a2l-gas-selection <https://github.com/Infineon/arduino-xensiv-pas-gas-sensor/tree/master/examples/a2l-gas-selection>`_
      - Readout of the sensor gas concentration value using A2L gas selection (for PAS A2L sensor only)

You can find more details regarding the examples in the example code itself. All the important parts are documented.