This code example demonstrates Infineon XENSIV™ PAS CO2 sensor to measure the CO2 level.
-
Ability to configure sampling interval for CO2 measurement
-
Values given in CO2 parts per million
-
Note: This code example version requires ModusToolbox software version 2.2 or later and is not backward compatible with v2.1 or older versions.
-
Board Support Package (BSP) minimum required version: 2.0.0
-
Programming Language: C
-
Associated Parts: All PSoC™ 6 MCU parts
- GNU Arm® Embedded Compiler v9.3.1 (
GCC_ARM) - Default value ofTOOLCHAIN
- Rapid IoT Connect Developer Kit (
CYSBSYSKIT-DEV-01) - Default value ofTARGET
This code example requires the XENSIV™ PAS CO2 Wing Board as part of the Connected Sensor Kit.
-
Connect the PAS CO2 Wing Board to the CYSBSYSKIT-DEV-01 kit with the pin headers.
-
Connect the CYSBSYSKIT-DEV-01 kit to the PC with a USB cable.
-
Place the CYSBSYSKIT-DEV-01 kit at a location in a room which is not very high.
Install a terminal emulator if you don't have one. Instructions in this document use Tera Term.
This example requires no additional software or tools.
-
Create the project and open it using one of the following:
In Eclipse IDE for ModusToolbox
-
Click the New Application link in the Quick Panel (or, use File > New > ModusToolbox Application). This launches the Project Creator tool.
-
Select the CYSBSYSKIT-DEV-01 kit shown in the Project Creator - Choose Board Support Package (BSP) dialog.
-
In the Project Creator - Select Application dialog, choose the "PAS CO2 Application on FreeRTOS" example by enabling the checkbox.
-
Optionally, change the suggested New Application Name.
-
Enter the local path in the Application(s) Root Path field to indicate where the application needs to be created.
Applications that can share libraries can be placed in the same root path.
- Click Create to complete the application creation process.
For more details, see the Eclipse IDE for ModusToolbox User Guide (locally available at {ModusToolbox install directory}/ide_{version}/docs/mt_ide_user_guide.pdf).
In Command-line Interface (CLI)
ModusToolbox provides the Project Creator as both a GUI tool and a command line tool to easily create one or more ModusToolbox applications. See the "Project Creator Tools" section of the ModusToolbox User Guide for more details.
Alternatively, you can manually create the application using the following steps:
-
Download and unzip this repository onto your local machine, or clone the repository.
-
Open a CLI terminal and navigate to the application folder.
On Linux and macOS, you can use any terminal application. On Windows, open the modus-shell app from the Start menu.
Note: The cloned application contains a default BSP file (TARGET_xxx.mtb) in the deps folder. Use the Library Manager (
make modlibscommand) to select and download a different BSP file, if required. If the selected kit does not have the required resources or is not supported, the application may not work.- Import the required libraries by executing the
make getlibscommand.
Various CLI tools include a
-hoption that prints help information to the terminal screen about that tool. For more details, see the ModusToolbox User Guide (locally available at {ModusToolbox install directory}/docs_{version}/mtb_user_guide.pdf).In Third-party IDEs
-
Follow the instructions from the In Command-line Interface (CLI) section to create the application, and import the libraries using the
make getlibscommand. -
Export the application to a supported IDE using the
make <ide>command.
For a list of supported IDEs and more details, see the "Exporting to IDEs" section of the ModusToolbox User Guide (locally available at {ModusToolbox install directory}/docs_{version}/mtb_user_guide.pdf.
- Follow the instructions displayed in the terminal to create or import the application as an IDE project.
-
-
Connect the CYSBSYSKIT-DEV-01 kit with the CO2 Wing Board to the PC.
-
Open a terminal program and select the KitProg3 COM port. Set the serial port parameters to 8N1 and 115200 baud.
-
Program the board using one of the following:
Using Eclipse IDE for ModusToolbox
-
Select the application project in the Project Explorer.
-
In the Quick Panel, scroll down, and click <Application Name> Program (KitProg3_MiniProg4).
Using CLI
From the terminal, execute the
make programcommand to build and program the application using the default toolchain to the default target. You can specify a target and toolchain manually:make program TARGET=<BSP> TOOLCHAIN=<toolchain>Example:
make program TARGET=CYSBSYSKIT-DEV-01 TOOLCHAIN=GCC_ARM -
-
After programming, the application starts automatically. Confirm that "Connected Sensor Kit: PAS CO2 Application on FreeRTOS" is displayed on the UART terminal.
Figure 1. Terminal output on program startup
When the board is initialized successfully, the sensor information is provided through prints on the terminal as well as an onboard OK LED.
The initialization process is indicated using the red LED on CYSBSYSKIT-DEV-01. The LED is turned OFF after a successful initialization; the OK LED on the PAS CO2 Wing Board is turned ON to show that the board is working normally. If this LED is OFF, check the connection with CYSBSYSKIT-DEV-01.
When the sensor gives a new value for CO2, it is displayed on the terminal. If a new value is not available, the state of the sensor is displayed on the terminal. If an out-of-range voltage or temperature error occurs, the warning LED on the CO2 Wing Board is turned ON. If the problem is resolved by the time of the next sample, the warning LED is turned OFF. The LED remaining ON indicates a problem with the voltage, temperature, or communication. Contact the sensor support team.
You can configure the measurement period of the sensor. It is the sampling interval in seconds for the sensor to measure the CO2 level. Supported values are in the range of 10-4095. The default value is 10 Seconds.
For details, see the pasco2 library API documentation.
You can debug the example to step through the code. In the IDE, use the <Application Name> Debug (KitProg3_MiniProg4) configuration in the Quick Panel. For more details, see the "Program and Debug" section in the Eclipse IDE for ModusToolbox User Guide.
Note: (Only while debugging) On the CM4 CPU, some code in main() may execute before the debugger halts at the beginning of main(). This means that some code executes twice - once before the debugger stops execution, and again after the debugger resets the program counter to the beginning of main(). See KBA231071 to learn about this and for the workaround.
This example provides a possible way to use the pasco2 library. It shows how to initialize the library and read the data from the sensor.
Table 1. Application Source Files
| File Name | Comments |
|---|---|
| main.c | Has the application entry function. It sets up the BSP, global interrupts, and UART, and then initializes the controller tasks. |
| pasco2_task.c | Initializes the LEDs, power, and I2C enable switch for the PAS CO2 Wing Board. Has the task entry function for the pasco2 library. |
| pasco2_terminal_ui.c | Has the task entry function for a simple version of the terminal UI configuration |
Table 2. Functions in main.c
| Function Name | Functionality |
|---|---|
main |
Main function for the CM4 CPU. It does the following: 1. Initializes the BSP 2. Enables global interrupts 3. Initializes Retarget IO 4. Creates the pasco2 task and terminal UI tasks 6. Starts the scheduler |
Table 3. Functions in pasco2_task.c
| Function Name | Functionality |
|---|---|
pasco2_task |
Initializes LEDs, enables power, and the I2C communication channel of the PAS CO2 Wing Board, configures the PAS CO2 module, and starts reading the sensor values |
pasco2_display_ppm |
Enables the terminal output for the CO2 value |
pasco2_enable_internal_logging |
Enables/disbales additional sensor information prints |
Table 4. Functions in radar_terminal_ui.c
| Function Name | Functionality |
|---|---|
pasco2_terminal_ui_task |
Starts the terminal UI task loop |
terminal_ui_readline |
Gets user input from terminal |
terminal_ui_info |
Prints the help information |
terminal_ui_menu |
Prints the menu for parameter configuration |
| Application Notes | |
|---|---|
| AN228571 – Getting Started with PSoC 6 MCU on ModusToolbox | Describes PSoC 6 MCU devices and how to build your first application with ModusToolbox |
| Code Examples | |
| Using ModusToolbox | |
| Device Documentation | |
| PSoC 6 MCU Datasheets | PSoC 6 Technical Reference Manuals |
| Development Kits | |
| Connected Sensor Kit | CYSBSYSKIT-DEV-01 Rapid IoT Connect Developer Kit |
| Libraries | |
| PSoC 6 Peripheral Driver Library (PDL) and docs | mtb-pdl-cat1 on GitHub |
| Cypress Hardware Abstraction Layer (HAL) Library and docs | mtb-hal-cat1 on GitHub |
| Retarget IO - A utility library to retarget the standard input/output (STDIO) messages to a UART port | retarget-io on GitHub |
| PASCO2 Library API - A library to configure PAS CO2 sensor and get ppm value | sensor-xensiv-pasco2 on Github | | Middleware | | | Links to all PSoC 6 MCU Middleware | psoc6-middleware on GitHub | | Tools | | | Eclipse IDE for ModusToolbox | The cross-platform, Eclipse-based IDE for IoT designers that supports application configuration and development targeting converged MCU and wireless systems. |
Cypress provides a wealth of data at www.cypress.com to help you select the right device, and quickly and effectively integrate it into your design.
For PSoC 6 MCU devices, see How to Design with PSoC 6 MCU - KBA223067 in the Cypress community.
Document Title: CE232623 - Connected Sensor Kit: PAS CO2 Application on FreeRTOS
| Version | Description of Change |
|---|---|
| 0.5.0 | New code example |
All other trademarks or registered trademarks referenced herein are the property of their respective owners.
© Cypress Semiconductor Corporation (An Infineon Technologies Company), 2021. This document is the property of Cypress Semiconductor Corporation and its affiliates ("Cypress"). This document, including any software or firmware included or referenced in this document ("Software"), is owned by Cypress under the intellectual property laws and treaties of the United States and other countries worldwide. Cypress reserves all rights under such laws and treaties and does not, except as specifically stated in this paragraph, grant any license under its patents, copyrights, trademarks, or other intellectual property rights. If the Software is not accompanied by a license agreement and you do not otherwise have a written agreement with Cypress governing the use of the Software, then Cypress hereby grants you a personal, non-exclusive, nontransferable license (without the right to sublicense) (1) under its copyright rights in the Software (a) for Software provided in source code form, to modify and reproduce the Software solely for use with Cypress hardware products, only internally within your organization, and (b) to distribute the Software in binary code form externally to end users (either directly or indirectly through resellers and distributors), solely for use on Cypress hardware product units, and (2) under those claims of Cypress's patents that are infringed by the Software (as provided by Cypress, unmodified) to make, use, distribute, and import the Software solely for use with Cypress hardware products. Any other use, reproduction, modification, translation, or compilation of the Software is prohibited.
TO THE EXTENT PERMITTED BY APPLICABLE LAW, CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS DOCUMENT OR ANY SOFTWARE OR ACCOMPANYING HARDWARE, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. No computing device can be absolutely secure. Therefore, despite security measures implemented in Cypress hardware or software products, Cypress shall have no liability arising out of any security breach, such as unauthorized access to or use of a Cypress product. CYPRESS DOES NOT REPRESENT, WARRANT, OR GUARANTEE THAT CYPRESS PRODUCTS, OR SYSTEMS CREATED USING CYPRESS PRODUCTS, WILL BE FREE FROM CORRUPTION, ATTACK, VIRUSES, INTERFERENCE, HACKING, DATA LOSS OR THEFT, OR OTHER SECURITY INTRUSION (collectively, "Security Breach"). Cypress disclaims any liability relating to any Security Breach, and you shall and hereby do release Cypress from any claim, damage, or other liability arising from any Security Breach. In addition, the products described in these materials may contain design defects or errors known as errata which may cause the product to deviate from published specifications. To the extent permitted by applicable law, Cypress reserves the right to make changes to this document without further notice. Cypress does not assume any liability arising out of the application or use of any product or circuit described in this document. Any information provided in this document, including any sample design information or programming code, is provided only for reference purposes. It is the responsibility of the user of this document to properly design, program, and test the functionality and safety of any application made of this information and any resulting product. "High-Risk Device" means any device or system whose failure could cause personal injury, death, or property damage. Examples of High-Risk Devices are weapons, nuclear installations, surgical implants, and other medical devices. "Critical Component" means any component of a High-Risk Device whose failure to perform can be reasonably expected to cause, directly or indirectly, the failure of the High-Risk Device, or to affect its safety or effectiveness. Cypress is not liable, in whole or in part, and you shall and hereby do release Cypress from any claim, damage, or other liability arising from any use of a Cypress product as a Critical Component in a High-Risk Device. You shall indemnify and hold Cypress, its directors, officers, employees, agents, affiliates, distributors, and assigns harmless from and against all claims, costs, damages, and expenses, arising out of any claim, including claims for product liability, personal injury or death, or property damage arising from any use of a Cypress product as a Critical Component in a High-Risk Device. Cypress products are not intended or authorized for use as a Critical Component in any High-Risk Device except to the limited extent that (i) Cypress's published data sheet for the product explicitly states Cypress has qualified the product for use in a specific High-Risk Device, or (ii) Cypress has given you advance written authorization to use the product as a Critical Component in the specific High-Risk Device and you have signed a separate indemnification agreement.
Cypress, the Cypress logo, Spansion, the Spansion logo, and combinations thereof, WICED, PSoC, CapSense, EZ-USB, F-RAM, and Traveo are trademarks or registered trademarks of Cypress in the United States and other countries. For a more complete list of Cypress trademarks, visit cypress.com. Other names and brands may be claimed as property of their respective owners.