Merge pull request #9 from Infineon/release/v2.1.2

Release/v2.1.2

Author: jaenrig-ifx

README.md

@@ -6,10 +6,22 @@ Arduino library of Infineon's [**XENSIV™ Photoacoustic Spectroscopy (PAS) CO2*
 
 <img src="docs/img/pas-co2-module.png" width=200>
 
+### Supported Sensor Boards
+
+<table>
+    <tr>
+        <td><img src="docs/img/pas-co2-miniboard.png" width="200"></td>
+        <td><img src="docs/img/pas-co2-s2go-front.png" width="300"></td>
+    </tr>
+    <tr>
+        <td style="test-align : center"><a href="https://arduino-pas-co2-sensor.readthedocs.io/en/latest/hw-platforms.html#xensiv-pas-co2-miniboard">XENSIV™ PAS CO2 Miniboard</a></td>
+        <td style="test-align : center"><a href="https://arduino-pas-co2-sensor.readthedocs.io/en/latest/hw-platforms.html#xensiv-pas-co2-sensor-shield2go">XENSIV™ PAS CO2 Sensor Shield2Go</a></td>
+    </tr>
+</table>
 
 ### Getting started
 
-Find a getting started tutorial based on the XENSIV™ PAS CO2 Shield2Go and the XMC 2Go eval board in this [link](https://arduino-pas-co2-sensor.readthedocs.io/en/latest/getting-started.html).
+Find a getting started tutorial based on the XENSIV™ PAS CO2 Shield2Go and the XMC eval boards in this [link](https://arduino-pas-co2-sensor.readthedocs.io/en/latest/getting-started.html).
 
 ### Library installation
 

docs/getting-started.rst

@@ -23,6 +23,9 @@ Required Hardware
     * - `XMC 2Go <https://www.infineon.com/cms/de/product/evaluation-boards/kit_xmc_2go_xmc1100_v1/>`_
       - .. image:: img/xmc2go.jpg
             :height: 80
+    * - or `XMC1100 Boot Kit <https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc11_boot_001/>`_
+      - .. image:: img/xmc1100-bootkit.jpg
+            :height: 80
     * - Pin headers (included with the XMC 2Go) 
       - 
     * - Micro-USB to USB A cable 
@@ -62,18 +65,34 @@ For this example we are going to use the I2C serial interface.
 A. Shield2Go
 """"""""""""
 
-If you are using the XENSIV™ PAS CO2 Sensor Shield2Go, it just need to be stacked on the XMC 2Go microcontroller board. Be sure that that the corresponding solder jumper are set for I2C mode, and PSEL is pulled to GND. 
+.. image:: img/shield2go_co2_pinout.png
+    :width: 200
+
+If you are using the XENSIV™ PAS CO2 Sensor Shield2Go, it is recommended to use a microcontroller
+which provides a 5V output. In this tutorial, the XMC11000 Boot
+Kit is used. Connect the shield and the eval kit as in the following wiring diagram:
+
+.. image:: img/pas-co2-xmc1100bk-conn-diag.png
+    :width: 400
+
+Be sure that the corresponding solder jumper are set for I2C mode, and PSEL is pulled
+to GND. 
+For this example it is not required, but consider connecting the interrupt signal to the pin 2(P1.4)
+or 3(P0.0) of the XMC1100 Boot Kit for appliations that require interrupts.
 Check the `Shield2Go Manual <https://www.infineon.com/dgdl/Infineon-Quickstart_guide_PAS_CO2_Shield2go-UserManual-v01_00-EN.pdf?fileId=8ac78c8c7f2a768a017f6ab96bf11845>`_ for complete details.
 
-.. 
-    .. image:: img/pas-co2-xmc2go-small.jpg
-        :width: 250
+Then, simply connect the eval kit to the computer with the USB cable. 
 
-Then, simply connect it to the computer with the USB cable. 
+.. warning:: 
+    Alternatively, the XMC 2Go can be used by stackin the sensor shield on top. But the XMC 2Go V1 does not support 5V signal, as required by the XENSIV™ PAS CO2 Sensor Shield2Go.
+    Thus, if XMC 2Go is used, keep in mind that an additional 5V signal needs to be provided to the 5V pin of the XENSIV™ PAS CO2 Sensor Shield2Go.
 
 B. Miniboard
 """"""""""""
 
+.. image:: img/minieval_co2_pinout.png
+    :width: 350
+
 In order to use the I2C interface we need to add a 10 Kohm pull-up resistors to the SDA and SCL lines, and a 12VDC voltage needs to be additionally provided to VDD12V pin. Connect the boards as shown in the following diagram:
 
 .. image:: img/xmc2go-miniboard-i2c-conn-diag.png
@@ -92,7 +111,8 @@ With everything ready, now we are going to upload and run one of the library exa
 1. **Select the board** 
 
     Once installed the XMC board family, you can select one of the supported board from the menu *Tools > Board:*.
-    Choose the **XMC1100 XMC2Go** (*Tools > Board > XMC Family > XMC1100 XMC2Go*).
+    Choose the **XMC1100 XMC2Go** or **XMC1100 Boot Kit** depending on your hardware setup (*Tools >
+    Board > XMC Family > XMC1100 XMC2Go/XMC1100 Boot Kit*).
 
 2. **Open the example**
 

docs/img/pas-co2-xmc1100bk-conn-diag.png

@@ -45,7 +45,7 @@ In the following example, we use the XMC 2Go Evaluation Kit (only available for
     framework = arduino
 
     lib_deps =
-        infineon/pas-co2-sensor @ ^1.0.3
+        infineon/pas-co2-sensor @ ^2.1.2
 
 
 Find more information in the `PlatformIO Registry <https://platformio.org/lib/show/12518/pas-co2-sensor>`_.

docs/img/xmc1100-bootkit.jpg

@@ -7,7 +7,7 @@
        "url":"https://github.com/Infineon/arduino-pas-co2-sensor.git",
        "branch":"master"
     },
-    "version":"2.1.1",
+    "version":"2.1.2",
     "license":"MIT",
     "frameworks":"arduino",
     "platforms":[  

docs/lib-install.rst

@@ -1,5 +1,5 @@
 name=pas-co2-sensor
-version=2.1.1
+version=2.1.2
 author=Infineon Technologies
 maintainer=Infineon Technologies <www.infineon.com>
 sentence=C/C++ library for Infineon XENSIV™ PAS CO2 sensor