This code example features a 5-segment CAPSENSE™ slider and two CAPSENSE™ buttons. Button 0 turns the LED ON, button 1 turns the LED OFF, and the slider controls the brightness of the LED. The code example also demonstrates monitoring CAPSENSE™ data using the CAPSENSE™ tuner GUI tool. This project uses the CAPSENSE™ Middleware Library.
Provide feedback on this code example.
- ModusToolbox™ software v3.1 or later (tested with v3.1)
- Board support package (BSP) minimum required version: 4.0.0
- Programming language: C
- Associated parts: All PSoC™ 6 MCU parts, AIROC™ CYW43012 Wi-Fi & Bluetooth® combo chip, AIROC™ CYW4343W Wi-Fi & Bluetooth® combo chip, AIROC™ CYW4373 Wi-Fi & Bluetooth® combo chip, AIROC™ CYW43439 Wi-Fi & Bluetooth® combo chip
- GNU Arm® embedded compiler v11.3.1 (
GCC_ARM) - Default value ofTOOLCHAIN - Arm® compiler v6.16 (
ARM) - IAR C/C++ compiler v9.30.1 (
IAR)
- PSoC™ 6 Wi-Fi Bluetooth® prototyping kit (
CY8CPROTO-062-4343W) – Default value ofTARGET - PSoC™ 6 Wi-Fi Bluetooth® pioneer kit (
CY8CKIT-062-WIFI-BT) - PSoC™ 6 Bluetooth® LE pioneer kit (
CY8CKIT-062-BLE) - PSoC™ 62S2 Wi-Fi Bluetooth® pioneer kit (
CY8CKIT-062S2-43012) - PSoC™ 62S1 Wi-Fi Bluetooth® pioneer kit (
CYW9P62S1-43438EVB-01) - PSoC™ 62S1 Wi-Fi Bluetooth® pioneer kit (
CYW9P62S1-43012EVB-01) - PSoC™ 62S3 Wi-Fi Bluetooth® prototyping kit (
CY8CPROTO-062S3-4343W) - PSoC™ 62S2 Wi-Fi Bluetooth® prototyping kit (
CY8CPROTO-062S2-43439) - PSoC™ 64 "Secure Boot" Wi-Fi Bluetooth® pioneer kit (
CY8CKIT-064B0S2-4343W) - PSoC™ 62S4 pioneer kit (
CY8CKIT-062S4) - PSoC™ 62S2 evaluation kit (
CY8CEVAL-062S2,CY8CEVAL-062S2-LAI-4373M2,CY8CEVAL-062S2-LAI-43439M2,CY8CEVAL-062S2-MUR-4373EM2CY8CEVAL-062S2-MUR-43439M2,CY8CEVAL-062S2-MUR-4373M2,CY8CEVAL-062S2-CYW43022CUB)
Note: CY8CEVAL-062S2-MUR-4373M2 BSP public release was pending while this code example version was released. It is expected to be released shortly.
This example uses the board's default configuration. See the kit user guide to ensure that the board is configured correctly.
Note: The PSoC™ 6 Bluetooth® LE pioneer kit (CY8CKIT-062-BLE) and the PSoC™ 6 Wi-Fi Bluetooth® pioneer kit (CY8CKIT-062-WIFI-BT) ship with KitProg2 installed. The ModusToolbox™ software requires KitProg3. Before using this code example, make sure that the board is upgraded to KitProg3. The tool and instructions are available in the Firmware Loader GitHub repository. If you do not upgrade, you will see an error like "unable to find CMSIS-DAP device" or "KitProg firmware is out of date".
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.
The ModusToolbox™ tools package provides the Project Creator as both a GUI tool and a command line tool.
Use Project Creator GUI
-
Open the Project Creator GUI tool.
There are several ways to do this, including launching it from the dashboard or from inside the Eclipse IDE. For more details, see the Project Creator user guide (locally available at {ModusToolbox™ install directory}/tools_{version}/project-creator/docs/project-creator.pdf).
-
On the Choose Board Support Package (BSP) page, select a kit supported by this code example. See Supported kits.
Note: To use this code example for a kit not listed here, you may need to update the source files. If the kit does not have the required resources, the application may not work.
-
On the Select Application page:
a. Select the Applications(s) Root Path and the Target IDE.
Note: Depending on how you open the Project Creator tool, these fields may be pre-selected for you.
b. Select this code example from the list by enabling its check box.
Note: You can narrow the list of displayed examples by typing in the filter box.
c. (Optional) Change the suggested New Application Name and New BSP Name.
d. Click Create to complete the application creation process.
Use Project Creator CLI
The 'project-creator-cli' tool can be used to create applications from a CLI terminal or from within batch files or shell scripts. This tool is available in the {ModusToolbox™ install directory}/tools_{version}/project-creator/ directory.
Use a CLI terminal to invoke the 'project-creator-cli' tool. On Windows, use the command-line 'modus-shell' program provided in the ModusToolbox™ installation instead of a standard Windows command-line application. This shell provides access to all ModusToolbox™ tools. You can access it by typing "modus-shell" in the search box in the Windows menu. In Linux and macOS, you can use any terminal application.
The following example clones the "mtb-example-wifi-scan" application with the desired name "WifiScan" configured for the CY8CPROTO-062S2-43439 BSP into the specified working directory, C:/mtb_projects:
project-creator-cli --board-id CY8CPROTO-062S2-43439 --app-id mtb-example-mtb-example-wifi-scan --user-app-name WifiScan --target-dir "C:/mtb_projects"
The 'project-creator-cli' tool has the following arguments:
| Argument | Description | Required/optional |
|---|---|---|
--board-id |
Defined in the field of the BSP manifest | Required |
--app-id |
Defined in the field of the CE manifest | Required |
--target-dir |
Specify the directory in which the application is to be created if you prefer not to use the default current working directory | Optional |
--user-app-name |
Specify the name of the application if you prefer to have a name other than the example's default name | Optional |
Note: The project-creator-cli tool uses the
git cloneandmake getlibscommands to fetch the repository and import the required libraries. For details, see the "Project creator tools" section of the ModusToolbox™ tools package user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf).
After the project has been created, you can open it in your preferred development environment.
Eclipse IDE
If you opened the Project Creator tool from the included Eclipse IDE, the project will open in Eclipse automatically.
For more details, see the Eclipse IDE for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_ide_user_guide.pdf).
Visual Studio (VS) Code
Launch VS Code manually, and then open the generated {project-name}.code-workspace file located in the project directory.
For more details, see the Visual Studio Code for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_vscode_user_guide.pdf).
Keil µVision
Double-click the generated {project-name}.cprj file to launch the Keil µVision IDE.
For more details, see the Keil µVision for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_uvision_user_guide.pdf).
IAR Embedded Workbench
Open IAR Embedded Workbench manually, and create a new project. Then select the generated {project-name}.ipcf file located in the project directory.
For more details, see the IAR Embedded Workbench for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_iar_user_guide.pdf).
Command line
If you prefer to use the CLI, open the appropriate terminal, and navigate to the project directory. On Windows, use the command-line 'modus-shell' program; on Linux and macOS, you can use any terminal application. From there, you can run various make commands.
For more details, see the ModusToolbox™ tools package user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf).
If using a PSoC™ 64 "Secure" MCU kit (like CY8CKIT-064B0S2-4343W), the PSoC™ 64 device must be provisioned with keys and policies before being programmed. Follow the instructions in the "Secure Boot" SDK user guide to provision the device. If the kit is already provisioned, copy-paste the keys and policy folder to the application folder.
-
Connect the board to your PC using the provided USB cable through the KitProg3 USB connector.
-
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™ software
-
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. The default toolchain is specified in the application's Makefile but you can override this value manually:make program TOOLCHAIN=<toolchain>Example:
make program TOOLCHAIN=GCC_ARM -
-
After programming, the application starts automatically. Confirm that "PSoC 6 MCU: CAPSENSE buttons and slider" is displayed on the UART terminal. Confirm that the user LED is glowing.
-
To test the application, touch CAPSENSE™ button 1 (BTN1) to turn the LED OFF, touch CAPSENSE™ Button 0 (BTN0) to turn the LED ON, and touch the slider in different positions to change the brightness.
-
You can also monitor the CAPSENSE™ data using the CAPSENSE™ Tuner application as follows:
-
Open CAPSENSE™ Tuner from the IDE Quick Panel.
You can also run the CAPSENSE™ Tuner application standalone from {ModusToolbox™ install directory}/ModusToolbox/tools_{version}/capsense-configurator/capsense-tuner. In this case, after opening the application, select File > Open and open the design.cycapsense file for the respective kit, which is present in the bsps/TARGET_<BSP-NAME>/config folder.
-
Ensure that the kit is in KitProg3 mode. See Firmware-loader to learn how to update the firmware and switch to KitProg3 mode.
-
In the tuner application, click Tuner Communication Setup or select Tools > Tuner Communication Setup. In the window that appears, select the I2C checkbox under KitProg3 and configure it as follows:
I2C address: 8 Sub-address: 2-bytes Speed (kHz): 400 -
Click Connect or select Communication > Connect.
-
Click Start or select Communication > Start.
Under the Widget View tab, you can see the corresponding widgets highlighted in blue color when you touch the button or slider. You can also view the sensor data in the Graph View tab. For example, to view the sensor data for Button 0, select Button0_Rx0 under Button0.
Figure 1 shows the CAPSENSE™ Tuner displaying the status of CAPSENSE™ touch on Button 0 and LinearSlider 0.
Figure 1. CAPSENSE™ Tuner showing touch data
CAPSENSE™ Tuner can also be used for CAPSENSE™ parameter tuning and measuring signal-to-noise ratio (SNR). See the ModusToolbox™ CAPSENSE™ tuner guide (Help > View Help) and AN85951 – PSoC™ 4 and PSoC™ 6 MCU CAPSENSE™ design guide for more details on selecting the tuning parameters.
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 details, see the "Program and debug" section in the Eclipse IDE for ModusToolbox™ software 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.
In this project, PSoC™ 6 MCU scans a self-capacitance (CSD) based 5-element CAPSENSE™ slider, and two mutual capacitance (CSX) CAPSENSE™ buttons for user input. The project uses the CAPSENSE™ Middleware (see ModusToolbox™ user guide for more details on selecting a middleware).
See AN85951 – PSoC™ 4 and PSoC™ 6 MCU CAPSENSE™ design guide for more details on CAPSENSE™ features and usage.
In this application, the state of the user LED is controlled based on user inputs provided using the CAPSENSE™ buttons and slider. A PWM HAL resource is configured for controlling the brightness of the LED. Touching button 0 turns the LED ON, and button 1 turns the LED OFF. The brightness of the LED is set based on the touch position on the CAPSENSE™ slider.
The ModusToolbox™ CAPSENSE™ configurator tool guide describes step-by-step instructions on how to configure CAPSENSE™ in the application. The CAPSENSE™ configurator and tuner tools can be launched from the CSD personality in the device configurator tool.
The application uses an EZI2C HAL interface for communicating with the CAPSENSE™ tuner.
The application is configured to work with the default operating voltage of the kit.
Table 1. Operating voltages supported by the kits
| Kit | Supported operating voltages | Default operating voltage |
|---|---|---|
| CY8CPROTO-062-4343W | 3.3V / 1.8V | 3.3V |
| CY8CKIT-062-BLE | 3.3V / 1.8V | 3.3V |
| CY8CKIT-062-WIFI-BT | 3.3V / 1.8V | 3.3V |
| CY8CKIT-062S2-43012 | 3.3V / 1.8V | 3.3V |
| CYW9P62S1-43438EVB-01 | 3.3V only | 3.3V |
| CYW9P62S1-43012EVB-01 | 1.8V only | 1.8V |
| CY8CPROTO-062S3-4343W | 3.3V / 1.8V | 3.3V |
| CY8CKIT-064B0S2-4343W | 3.3V / 1.8V | 3.3V |
| CY8CKIT-062S4 | 3.3V / 1.8V | 3.3V |
| CY8CEVAL-062S2 | 3.3V / 1.8V | 3.3V |
| CY8CEVAL-062S2-LAI-4373M2 | 3.3V / 1.8V | 3.3V |
| CY8CEVAL-062S2-LAI-43439M2 | 3.3V / 1.8V | 3.3V |
| CY8CEVAL-062S2-MUR-43439M2 | 3.3V / 1.8V | 3.3V |
| CY8CEVAL-062S2-MUR-4373EM2 | 3.3V / 1.8V | 3.3V |
| CY8CEVAL-062S2-MUR-4373M2 | 3.3V / 1.8V | 3.3V |
| CY8CPROTO-062S2-43439 | 3.3V / 1.8V | 3.3V |
| CY8CEVAL-062S2-CYW43022CUB | 3.3V / 1.8v | 3.3V |
For kits that support multiple operating voltages, the default BSP configuration is provided by the design.modus file should be customized. Follow the instructions to use the example at a custom power supply, such as 1.8 V:
-
Create a directory at the root of the application to hold any custom BSP configuration files <application_folder>/templates.
-
Create a subdirectory for each target that needs to be modified to work at a custom power supply <application_folder>/templates/TARGET_<kit>/config.
-
Copy the design.modus file and other configuration files (from the path bsps/TARGET_<BSP_NAME>/config) and paste them into the new directory for the target(<application_folder>/templates/TARGET_<kit>/config).
-
Launch the Device Configurator tool using the Quick Panel link in the IDE. This opens the design.modus file from the newly created templates/TARGET_<kit>/config folder; and you are now free to customize the configuration as required.
-
Update the Operating Conditions parameters in power settings with the desired voltage and select File > Save.
Figure 2. Power settings to work with 1.8V
-
Change the jumper/switch setting as follows:
Table 2. Jumper/switch position for 1.8-V operation
Kit Jumper/switch position CY8CPROTO-062-4343W J3 (1-2) CY8CKIT-062-BLE SW5 (1-2) CY8CKIT-062-WIFI-BT SW5 (1-2) CY8CKIT-062S2-43012 J14 (1-2) CYW9P62S1-43438EVB-01 J14 (1-2) CYW9P62S1-43012EVB-01 J14 (1-2) CY8CPROTO-062S3-4343W J3 (1-2) CY8CKIT-064B0S2-4343W J14 (1-2) CY8CKIT-062S4 J12 (1-2) CY8CEVAL-062S2 J18 (1-2) CY8CEVAL-062S2-LAI-4373M2 J18 (1-2) CY8CEVAL-062S2-LAI-43439M2 J18 (1-2) CY8CEVAL-062S2-MUR-43439M2 J18 (1-2) CY8CPROTO-062S2-43439 J3 (1-2) CY8CEVAL-062S2-CYW43022CUB J18 (1-2) -
Re-build and program the application to evaluate the application at the new power setting.
Table 3. Application resources
| Resource | Alias/object | Purpose |
|---|---|---|
| GPIO (HAL) | CYBSP_USER_LED | User LED to show visual output |
| PWM (HAL) | pwm_led | PWM HAL object used to vary LED brightness |
| EZI2C (HAL) | sEzI2C | Slave EZI2C object used to tune Capsense |
| UART (HAL) | cy_retarget_io_uart_obj | UART HAL object used by retarget-io for Debug UART |
| Resources | Links |
|---|---|
| Application notes | AN228571 – Getting started with PSoC™ 6 MCU on ModusToolbox™ software AN215656 – PSoC™ 6 MCU: Dual-CPU system design |
| Code examples | Using ModusToolbox™ software on GitHub |
| Device documentation | PSoC™ 6 MCU datasheets PSoC™ 6 technical reference manuals |
| Development kits | Select your kits from the evaluation board finder |
| Libraries on GitHub | mtb-pdl-cat1 – PSoC™ 6 peripheral driver library (PDL) mtb-hal-cat1 – Hardware abstraction layer (HAL) library retarget-io – Utility library to retarget STDIO messages to a UART port |
| Middleware on GitHub | capsense – CAPSENSE™ library and documents psoc6-middleware – Links to all PSoC™ 6 MCU middleware |
| Tools | Eclipse IDE for ModusToolbox™ software – ModusToolbox™ software is a collection of easy-to-use software and tools enabling rapid development with Infineon MCUs, covering applications from embedded sense and control to wireless and cloud-connected systems using AIROC™ Wi-Fi and Bluetooth® connectivity devices. |
Infineon provides a wealth of data at www.infineon.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 Infineon Developer community.
Document title: CE227004 - PSoC™ 6 MCU: CAPSENSE™ buttons and slider
| Version | Description of change |
|---|---|
| 1.0.0 | New code example |
| 1.1.0 | Added support for CY8CPROTO-062S3-4343W kit Updated to use EzI2C HAL for CAPSENSE™ Tuner interface Updated to support ModusToolbox™ software v2.1 |
| 2.0.0 | Major update to support ModusToolbox™ software v2.2, added support for new kits This version is not backward compatible with ModusToolbox™ software v2.1 |
| 3.0.0 | Updated to BSP v3.X and added support for new kits |
| 4.0.0 | Major update to support ModusToolbox™ v3.0 and BSPs v4.X. This version is not backward compatible with previous versions of ModusToolbox™ |
| 4.1.0 | Added Support for CY8CEVAL-062S2-LAI-43439M2 |
| 4.2.0 | Added Support for CY8CPROTO-062S2-43439 |
| 4.3.0 | Updated to support ModusToolbox™ v3.1 and CAPSENSE™ middleware v4.X, added support for CY8CEVAL-062S2-MUR-4373EM2, CY8CEVAL-062S2-MUR-4373M2 |
| 4.4.0 | Added support for CY8CEVAL-062S2-CYW43022CUB |
© Cypress Semiconductor Corporation, 2020-2023. This document is the property of Cypress Semiconductor Corporation, an Infineon Technologies company, 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, including its affiliates, and its directors, officers, employees, agents, 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, and combinations thereof, WICED, ModusToolbox, PSoC, CapSense, EZ-USB, F-RAM, and Traveo are trademarks or registered trademarks of Cypress or a subsidiary of Cypress in the United States or in other countries. For a more complete list of Cypress trademarks, visit www.infineon.com. Other names and brands may be claimed as property of their respective owners.