Skip to content
Permalink
25297007ef
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

mtb-example-psoc4-msclp-liquid-tolerant-proximity/README.md

Go to file
 
 
Cannot retrieve contributors at this time
1143 lines (624 sloc) 66.3 KB
Raw Blame
# PSoC™ 4: MSCLP CAPSENSE™ liquid-tolerant proximity-sensing
This code example demonstrates an implementation of a robust liquid-tolerant proximity-sensing application to detect a target (a hand) at a distance of up to 40 mm. It demonstrates recommended liquid tolerance techniques and adjustments of tuning parameters. This example uses a 5th-generation low-power CAPSENSE™ (MSCLP) proximity widget, implemented on PSoC™ 4000T CAPSENSE™ Evaluation Kit (`CY8CKIT-040T`) to demonstrate low-power mode.
This code example also demonstrates how to use a 'guard sensor' to detect the presence of liquid using the CSX sensing technique. The term 'liquid tolerance' in this case includes following scenarios only.
Scenario | System response
:-----------------| :----------------
Small liquid droplets present on the sensing area | No reaction, system still able to sense proximity target
Medium and large liquid droplets present on the sensing area | System goes to the liquid active state and turns OFF the proximity sensing until the liquid is removed/wiped off
Floating liquid flowing on the sensing area | System goes to the liquid active state and turns OFF the proximity sensing until the liquid is removed/wiped off
The resulting solution in this implementation can effectively be called as 'Splash Proof'.
[View this README on GitHub.](https://github.com/Infineon/mtb-example-psoc4-msclp-liquid-tolerant-proximity)
[Provide feedback on this code example.](https://cypress.co1.qualtrics.com/jfe/form/SV_1NTns53sK2yiljn?Q_EED=eyJVbmlxdWUgRG9jIElkIjoiQ0UyMzgyMjgiLCJTcGVjIE51bWJlciI6IjAwMi0zODIyOCIsIkRvYyBUaXRsZSI6IlBTb0MmdHJhZGU7IDQ6IE1TQ0xQIENBUFNFTlNFJnRyYWRlOyBsaXF1aWQtdG9sZXJhbnQgcHJveGltaXR5LXNlbnNpbmciLCJyaWQiOiJiaGF2aWsgYmhhbnNhbGkiLCJEb2MgdmVyc2lvbiI6IjIuMC4wIiwiRG9jIExhbmd1YWdlIjoiRW5nbGlzaCIsIkRvYyBEaXZpc2lvbiI6Ik1DRCIsIkRvYyBCVSI6IklDVyIsIkRvYyBGYW1pbHkiOiJQU09DIn0=)
## Requirements
- [ModusToolbox™](https://www.infineon.com/modustoolbox) v3.2 or later (tested with v3.2)
- Board support package (BSP) minimum required version: 3.2.0
- Programming language: C
- Associated parts: [PSoC™ 4000T](https://www.infineon.com/cms/en/product/microcontroller/32-bit-psoc-arm-cortex-microcontroller/psoc-4-32-bit-arm-cortex-m0-mcu/psoc-4000/psoc-4000t/)
## Supported toolchains (make variable 'TOOLCHAIN')
- GNU Arm® Embedded Compiler v10.3.1 (`GCC_ARM`) – Default value of `TOOLCHAIN`
- Arm® Compiler v6.16 (`ARM`)
- IAR C/C++ Compiler v9.30.1 (`IAR`)
## Supported kits (make variable 'TARGET')
- [PSoC™ 4000T CAPSENSE™ Evaluation Kit](https://www.infineon.com/CY8CKIT-040T) (`CY8CKIT-040T`) – Default value of `TARGET`
## Hardware setup
This example uses the board's default configuration. See the [kit user guide](https://www.infineon.com/002-34870) to ensure that the board is configured correctly to use VDDA at 1.8 V.
> **Note:** PSoC™ 4000T CAPSENSE™ Evaluation Kit (`CY8CKIT-040T`) ship with KitProg2 installed. ModusToolbox™ 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](https://github.com/Infineon/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".
## Software setup
See the [ModusToolbox™ tools package installation guide](https://www.infineon.com/ModusToolboxInstallguide) for information about installing and configuring the tools package.
This example requires no additional software or tools.
## Using the code example
### Create the project
The ModusToolbox™ tools package provides the Project Creator as both a GUI tool and a command line tool.
<details><summary><b>Use Project Creator GUI</b></summary>
1. 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](https://www.infineon.com/ModusToolboxProjectCreator) (locally available at *{ModusToolbox&trade; install directory}/tools_{version}/project-creator/docs/project-creator.pdf*).
2. On the **Choose Board Support Package (BSP)** page, select a kit supported by this code example. See [Supported kits](#supported-kits-make-variable-target).
> **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.
3. 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.
</details>
<details><summary><b>Use Project Creator CLI</b></summary>
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&trade; 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&trade; installation instead of a standard Windows command-line application. This shell provides access to all ModusToolbox&trade; 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 "[PSoC&trade; 4: MSCLP CAPSENSE&trade; low-power proximity tuning](https://github.com/Infineon/mtb-example-psoc4-msclp-capsense-lp-proximity)" application with the desired name "CAPSENSE_Low_Power_Proximity_Tuning" configured for the *CY8CKIT-040T* BSP into the specified working directory, *C:/mtb_projects*:
```
project-creator-cli --board-id CY8CKIT-040T --app-id mtb-example-psoc4-msclp-capsense-lp-proximity --user-app-name CAPSENSE_Low_Power_Proximity_Tuning --target-dir "C:/mtb_projects"
```
The 'project-creator-cli' tool has the following arguments:
Argument | Description | Required/optional
---------|-------------|-----------
`--board-id` | Defined in the <id> field of the [BSP](https://github.com/Infineon?q=bsp-manifest&type=&language=&sort=) manifest | Required
`--app-id` | Defined in the <id> field of the [CE](https://github.com/Infineon?q=ce-manifest&type=&language=&sort=) 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 clone` and `make getlibs` commands to fetch the repository and import the required libraries. For details, see the "Project creator tools" section of the [ModusToolbox&trade; tools package user guide](https://www.infineon.com/ModusToolboxUserGuide) (locally available at {ModusToolbox&trade; install directory}/docs_{version}/mtb_user_guide.pdf).
</details>
### Open the project
After the project has been created, you can open it in your preferred development environment.
<details><summary><b>Eclipse IDE</b></summary>
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&trade; user guide](https://www.infineon.com/MTBEclipseIDEUserGuide) (locally available at *{ModusToolbox&trade; install directory}/docs_{version}/mt_ide_user_guide.pdf*).
</details>
<details><summary><b>Visual Studio (VS) Code</b></summary>
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&trade; user guide](https://www.infineon.com/MTBVSCodeUserGuide) (locally available at *{ModusToolbox&trade; install directory}/docs_{version}/mt_vscode_user_guide.pdf*).
</details>
<details><summary><b>Keil µVision</b></summary>
Double-click the generated *{project-name}.cprj* file to launch the Keil µVision IDE.
For more details, see the [Keil µVision for ModusToolbox&trade; user guide](https://www.infineon.com/MTBuVisionUserGuide) (locally available at *{ModusToolbox&trade; install directory}/docs_{version}/mt_uvision_user_guide.pdf*).
</details>
<details><summary><b>IAR Embedded Workbench</b></summary>
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&trade; user guide](https://www.infineon.com/MTBIARUserGuide) (locally available at *{ModusToolbox&trade; install directory}/docs_{version}/mt_iar_user_guide.pdf*).
</details>
<details><summary><b>Command line</b></summary>
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&trade; tools package user guide](https://www.infineon.com/ModusToolboxUserGuide) (locally available at *{ModusToolbox&trade; install directory}/docs_{version}/mtb_user_guide.pdf*).
</details>
## Operation
1. Connect the board to your PC using the provided Micro-B USB cable through the KitProg3 USB connector as shown in the following figure.
**Figure 1. Connecting the CY8CKIT-040T kit with the PC**
<img src="images/psoc4000t_kit_connected.jpg" alt="Figure 1" width="350"/>
2. Program the board using one of the following:
<details><summary><b>Using Eclipse IDE</b></summary>
1. Select the application project in the Project Explorer.
2. In the **Quick Panel**, scroll down, and click **\<Application Name> Program (KitProg3_MiniProg4)**.
</details>
<details><summary><b>In other IDEs</b></summary>
Follow the instructions in your preferred IDE.
</details>
<details><summary><b>Using CLI</b></summary>
From the terminal, execute the `make program` command 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
```
</details>
3. After programming, the application starts automatically.
> **Note:** After programming, you see the following error message if debug mode is disabled. This can be ignored or enabling the debug mode will solve this error.
``` c
"Error: Error connecting Dp: Cannot read IDR"
```
4. To test the application, hover a hand on top of the CAPSENSE&trade; proximity sensor and notice that LED1 turn ON with green color and turn OFF when the hand is moved away. In this case, the maximum distance the proximity sensor can sense an object is 40 mm.
The sensor can also detect a touch. When the sensor is touched, the LED1 turn ON with blue color.
Note that the proximity sensor detects objects from all directions. Implementing directional proximity sensing in an end system presents a significant challenge due to its dependence on various factors, including the overall enclosure design, hardware components, and PCB layout. To achieve directional sensitivity in proximity sensors, position a ground plane at the bottom to reduce sensitivity from below. Because the ground plane can decrease sensitivity, it must be placed with some separation from the shield below the proximity sensor. The optimal distance varies based on different system factors and necessitates testing on the actual system to determine the best distance..
**Figure 2. LED1 turn green after hovering the hand on top of the sensor**
<img src="images/proximity.png" alt="Figure 2" width="400"/>
5. Spray water over the sensors and observe that LED3 turn ON with red color indicating system is in **Liquid Active state** because of the presence of water.
**Figure 3. Spraying water on top of the sensors**
<img src="images/psoc_4000t_sensors_water_spray.jpg" alt="Figure 3" width="450"/>
6. Use a water dropper (shipped with the kit package) to place water droplets on top of the sensors. Observe that LED3 turns ON with red color, indicating system is in **Liquid Active state** because of the presence of water.
**Figure 4. Droplets of water on top of the sensors**
<img src="images/floating-water-out-of-boundry.png" alt="Figure 4" width="450"/>
**Table 1. LED indications for proximity, touch, and liquid detection**
Scenario | LED | Color
:------------------| :-----| :-----
Hand in proximity | LED1 |Green
Touch | LED1 | Blue
Liquid | LED3 | Red
<br>
### Monitor data using CAPSENSE&trade; Tuner
1. Open CAPSENSE&trade; Tuner from the BSP Configurators section in the IDE **Quick Panel**.
You can also run the CAPSENSE&trade; Tuner application in standalone mode from *{ModusToolbox&trade; 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 of the respective application, which is present in the *{Application root directory}/bsps/TARGET_APP_\<BSP-NAME>/COMPONENT_BSP_DESIGN_MODUS/* folder.
See the [ModusToolbox&trade; user guide](https://www.infineon.com/ModusToolboxUserGuide) (locally available at *{ModusToolbox&trade; install directory}/docs_{version}/mtb_user_guide.pdf*)for options to open the CAPSENSE&trade; Tuner application using the CLI.
2. Ensure the kit is in CMSIS-DAP bulk mode (KitProg3 status LED is ON and not blinking). See [Firmware-loader](https://github.com/Infineon/Firmware-loader) to learn how to update the firmware and switch modes in KitProg3.
3. In the tuner application, click on the **Tuner Communication Setup** icon or select **Tools** > **Tuner Communication Setup**. In the window, select I2C under KitProg3 and configure as follows:
- **I2C address:** 8
- **Sub-address:** 2-Bytes
- **Speed (kHz):** 400
These are the same values set in the EZI2C resource.
**Figure 5. Tuner Communication Setup parameters**
<img src="images/tuner-comm-setup.png" alt="Figure 5" width="750"/>
4. Click **Connect** or select **Communication** > **Connect** to establish a connection.
**Figure 6. Establish connection**
<img src="images/tuner-connect.png" alt="Figure 6" width="450" />
5. Click **Start** or select **Communication** > **Start** to start data streaming from the device.
**Figure 7. Start tuner communication**
<img src="images/tuner-start.png" alt="Figure 7" width="450" />
The **Widget/Sensor Parameters** tab is updated with the parameters configured in the CAPSENSE&trade; Configurator window. The tuner displays the data from the sensor in the **Widget View** and **Graph View** tabs.
6. Set the **Read mode** to **Synchronized** mode. Navigate to the **Widget View** tab and observe that the **Proximity0** widget is highlighted in blue color when your hand is in proximity range.
**Figure 8. Widget view of the CAPSENSE&trade; Tuner**
<img src="images/tuner-widget-view.png" alt="Figure 8" width="1000"/>
7. Go to the **Graph View** tab to view the raw count, baseline, difference count, and status for each sensor. Observe that the low-power widget sensor's (**LowPower0_Sns0**) raw count is plotted after the device completes a full-frame scan (or detects a touch) in **WOT** mode and moves to **Active/ALR** mode.
**Figure 9. Graph view of the CAPSENSE&trade; Tuner**
<img src="images/tuner-graph-view-intro.png" alt="Figure 9" width="1000"/>
8. Observe the **Widget/Sensor parameters** section in the CAPSENSE&trade; Tuner window as shown in **Figure 8** and **Figure 9**.
9. Switch to the **SNR Measurement** tab for measuring the SNR and verify that the SNR is above 5:1 and the signal count is above 50; select the **Proximity0** and **Proximity0_Sns0** sensors, and then click **Acquire Noise** as shown in the following figure.
**Figure 10. CAPSENSE&trade; Tuner - SNR measurement: Acquire Noise**
<img src="images/tuner-acquire-noise.png" alt="Figure 10" width="1000"/>
> **Note:** Because the scan refresh rate is lower in **ALR** mode, it takes more time to acquire noise. Touch the CAPSENSE&trade; proximity loop once before clicking **Acquire Noise** to transition the device to **ACTIVE** mode to complete the measurement faster.
10. After noise is acquired, bring your hand over the proximity loop at a distance of around **40 mm** above it and then click **Acquire Signal**. Ensure that the hand remains stable above the proximity loop as long as the signal acquisition is in progress. Observe that the SNR is above 5:1 and the signal count is above 50. If not, repeat signal acquisition by lowering the hand, and therefore, getting a higher signal.
The calculated SNR on this proximity widget is displayed, as shown in the following figure.
**Figure 11. CAPSENSE&trade; Tuner - SNR measurement: Acquire signal**
<img src="images/tuner-acquire-signal.png" alt="Figure 11" width="1000"/>
The maximum distance the proximity sensor can sense is at the distance where the SNR is greater than 5:1. [Tuning procedure](#tuning-procedure) section explains how changing the configuration affects the distance and SNR.
11. To measure the SNR of the low-power sensor (**LowPower0_Sns0**), set the **Finger threshold** to maximum (65535) in **Widget/Sensor Parameters** for the **LowPower0** widget as shown in **Figure 12**. Set the **Proximity threshold** and **Proximity touch threshold** to their maximum (65535) values in the Widget/Sensor Parameters of the **Proximity0** widget, as shown in **Figure 13**.
This is required to keep the application in Low Power mode. Otherwise, the application will stop scanning the low-power sensor when there is a proximity or touch detected and will transition to active mode.
**Figure 12. CAPSENSE&trade; update finger threshold**
<img src="images/tuner-threshold-update.png" alt="Figure 12" width="1000"/>
**Figure 13. CAPSENSE&trade; update proximity and touch threshold**
<img src="images/tuner-threshold-update-proximity.png" alt="Figure 13" width="1000"/>
12. Repeat steps 9 and 10 to observe the SNR and signal, as shown in **Figure 10** and **Figure 11**.
**Figure 14. CAPSENSE&trade; Tuner - SNR measurement: low-power widget**
<img src="images/tuner-lowpower-snr.png" alt="Figure 14" width="1000"/>
### Current consumption
Follow the instructions in the **Measure current at different power modes** section of the code example [PSoC&trade; 4: MSCLP CAPSENSE&trade; low power](https://github.com/Infineon/mtb-example-psoc4-msclp-capsense-low-power) to measure the current consumption.
## Operation at other voltages
[CY8CKIT-040T kit](https://www.infineon.com/CY8CKIT-040T) supports operating voltages of 1.8 V, 3.3 V, and 5 V. Use voltage selection switch available on top of the kit to set the preferred operating voltage and see the [Set up the VDDA supply voltage and debug mode in Device Configurator](#set-up-the-vdda-supply-voltage-and-debug-mode-in-device-configurator) section.
This application functionalities are optimally tuned for 1.8 V. However, you can observe the basic functionalities working across other voltages.
It is recommended to tune application at the preferred voltages for optimum performance.
## Tuning procedure
<details><summary><b> Create custom BSP for your board </b></summary>
1. Create a custom BSP for your board with any device by following the steps given in [ModusToolbox&trade; BSP Assistant user guide](https://www.infineon.com/ModusToolboxBSPAssistant). This code example is created for the CY8C4046LQI-T452 device.
2. Open the *design.modus* file from the *{Application root directory}/bsps/TARGET_APP_\<BSP-NAME>/config/* folder obtained in the previous step and enable CAPSENSE&trade; to get the *design.cycapsense* file. CAPSENSE&trade; configuration can be started from scratch as follows:
</details>
The following steps explain the tuning procedure for the proximity loop and the low-power widget.
> **Note:** See the "Manual Tuning" section in the [AN92239 - Proximity sensing with CAPSENSE&trade;](https://www.infineon.com/AN92239) to learn about the considerations for selecting each parameter values. In addition, see the "Low-power widget parameters" section in the [AN234231 - Achieving lowest-power capacitive sensing with PSoC&trade; 4000T](https://www.infineon.com/AN234231) to learn about the considerations for parameter values specific to low-power widgets.
The tuning flow of the proximity widget is shown in the following figure.
**Figure 15. Proximity widget tuning flow**
<img src="images/flowchart-for-tuning.png" alt="Figure 15" width="1000"/>
To tune the low-power widget, see the **Tuning flow** section of the code example [PSoC&trade; 4: MSCLP CAPSENSE&trade; low power](https://github.com/Infineon/mtb-example-psoc4-msclp-capsense-low-power).
Do the following to tune the proximity widget:
- [Stage 1: Set initial hardware parameters](#stage-1-set-initial-hardware-parameters)
- [Stage 2: Set sense clock frequency](#stage-2-set-sense-clock-frequency)
- [Stage 3: Fine-tune for required SNR, power, and refresh rate](#stage-3-fine-tune-for-required-snr-power-and-refresh-rate)
- [Stage 4: Tune threshold parameters](#stage-4-tune-threshold-parameters)
- [Stage 5: Re-tune threshold parameters for liquid tolerance](#stage-5-re-tune-threshold-parameters-for-liquid-tolerance)
### Stage 1: Set initial hardware parameters
-------------------------
1. Connect the board to your PC using the provided USB cable through the KitProg3 USB connector.
2. Launch the Device Configurator tool.
You can launch the Device Configurator in Eclipse IDE for ModusToolbox&trade; from the **Tools** section in the IDE **Quick Panel** or in standalone mode from *{ModusToolbox&trade; install directory}/ModusToolbox/tools_{version}/device-configurator/device-configurator*. In this case, after opening the application, select **File** > **Open** and open the *design.modus* file of the respective application located in the *{Application root directory}/bsps/TARGET_APP_\<BSP-NAME>/COMPONENT_BSP_DESIGN_MODUS* folder.
3. Enable CAPSENSE&trade; channel in Device Configurator as shown in the following figure.
**Figure 16. Enable CAPSENSE&trade; in Device Configurator**
<img src="images/device-configurator.png" alt="Figure 16" width="1000"/>
Save the changes and close the window.
4. Launch the CAPSENSE&trade; Configurator tool.
You can launch the CAPSENSE&trade; Configurator tool in Eclipse IDE for ModusToolbox&trade; from the CAPSENSE&trade; peripheral setting in the Device Configurator or directly from the Tools section in the IDE Quick Panel.
You can also launch it in standalone mode from *{ModusToolbox&trade; install directory}/ModusToolbox&trade;/tools_{version}/capsense-configurator/capsense-configurator*. In this case, after opening the application, select **File** > **Open** and open the *design.cycapsense* file of the respective application, which is present in the *{Application root directory}/bsps/TARGET_APP_\<BSP-NAME>/COMPONENT_BSP_DESIGN_MODUS* folder.
See the [ModusToolbox&trade; CAPSENSE&trade; Configurator tool guide](https://www.infineon.com/ModusToolboxCapSenseConfig) for step-by-step instructions on how to configure and launch CAPSENSE&trade; in ModusToolbox&trade;.
5. In the **Basic** tab, add a proximity widget **Proximity0** and a low-power widget **LowPower0**. Set their sensing mode as CSD RM (self-cap) and set the **CSD tuning mode** as **Manual tuning**.
6. Add a button widget **CsxGuard**, set the sensing mode to CSX, and add 4 Rx sensing elements as shown in the following figure. This widget acts as a water sensor to turn OFF the sensing until water is present on the surface.
**Figure 17. CAPSENSE&trade; Configurator - Basic tab**
<img src="images/basic-csd-settings.png" alt="Figure 17" width="1000"/>
7. Do the following in the **General** tab under the **Advanced** tab:
1. Select **CAPSENSE&trade; IMO Clock frequency** as **46** MHz.
2. Set the **Modulator clock divider** to **1** to obtain the optimum modulator clock frequency.
3. Set the **Number of init sub-conversions** based on the hint shown when you hover over the edit box. Retain the default value (which will be set in [Stage 2: Set sense clock frequency](#stage-2-set-sense-clock-frequency)).
4. Use **Wake-On-Touch settings** to set the refresh rate and frame timeout while in the lowest power mode (Wake-on-Touch mode).
5. Set **Wake-on-Touch scan interval (ms)** based on the required low-power state scan refresh rate. For example, to get a 16-Hz refresh rate, set the value to **63**.
6. Set the **Number of frames in Wake-on-Touch** as the maximum number of frames to be scanned in WoT mode if there is no touch detected. This determines the maximum time the device will be kept in the lowest-power mode if there is no user activity. The maximum time can be calculated by multiplying this parameter with the **Wake-on-Touch scan interval (ms)** value.
For example, to get 10 seconds as the maximum time in WoT mode, set **Number of frames in Wake-on-Touch** to **160** for the scan interval set as 63 ms.
> **Note:** For tuning low-power widgets, **Number of frames in Wake-on-Touch** must be less than the **Maximum number of raw counts values in SRAM** based on the number of sensors in WoT mode as follows:
**Table 2. Maximum number of raw counts values in SRAM**
Number of low power widgets | Maximum number of raw counts in SRAM
:---------------------| :-----
1 | 245
2 | 117
3 | 74
4 | 53
5 | 40
6 | 31
7 | 25
8 | 21
<br>
7. Retain the default settings for all regular and low-power widget filters. You can enable or update the filters later depending on the signal-to-noise ratio (SNR) requirements in [Stage 3: Fine-tune for required SNR, power, and refresh rate](#stage-3-fine-tune-for-required-snr-power-and-refresh-rate).
Filters are used to reduce the peak-to-peak noise; however, using filters will result in a higher scan time.
**Figure 18. CAPSENSE&trade; Configurator - General settings**
<img src="images/advanced-general-settings.png" alt="Figure 18" width="1000"/>
> **Note:** Each tab has a **Restore Defaults** button to restore the parameters of that tab to their default values.
7. Go to the **CSD Settings** tab and make the following changes:
1. Set **Inactive sensor connection** as **Shield**.
Connect the inactive sensor, hatch pattern, or any trace that is surrounding the proximity sensor to the driven shield instead of connecting them to ground. This minimizes the signal due to the liquid droplets falling on the sensor.
2. Set **Shield mode** as **Active**.
Setting the shield to active: The driven shield is a signal that replicates the sensor-switching signal. This minimizes the signal because of the liquid droplets falling on the sensor.
3. Set **Total shield count** as **6** (Enabling all the inactive sensors as shield during CSD sensor scan).
4. Set **Raw count calibration level (%)** to **70**.
This helps in removing flat spots by adding white noise that moves the conversion point around the flat-spots region. See the [CAPSENSE&trade; design guide](https://www.infineon.com/AN85951) for more information.
**Figure 19. CAPSENSE&trade; Configurator - Advanced CSD settings**
<img src="images/advanced-csd-settings.png" alt="Figure 19" width="1000"/>
9. Go to the **Widget Details** tab.
Select **Proximity0** from the left pane and then set the following:
- **Sense clock divider:** Retain the default value (will be set in [Stage 2: Set sense clock frequency](#stage-2-set-sense-clock-frequency))
- **Clock source:** Direct
> **Note:** Spread spectrum clock (SSC) or PRS clock can be used as a clock source to deal with EMI/EMC issues.
- **Number of sub-conversions:** 60
60 is a good starting point to ensure a fast scan time and sufficient signal. This value will be adjusted as required in [Stage 3: Fine-tune for required SNR, power, and refresh rate](#stage-3-fine-tune-for-required-snr-power-and-refresh-rate).
- **Proximity threshold:** 65535
Proximity threshold is set to the maximum to avoid waking the device up from WoT mode because of touch detection; this is required to find the signal and SNR. This will be adjusted in [Stage 4: Tune threshold parameters](#stage-4-tune-threshold-parameters).
- **Touch threshold:** 65535
Touch threshold is also set to the maximum to avoid the waking up of the device from WoT mode.
- **Noise threshold:** 40
- **Negative noise threshold:** 40
- **Low baseline reset:** 255
- **Hysteresis:** 40
- **ON debounce:** 3
**Figure 20. CAPSENSE&trade; Configurator - Proximity Widget Details tab under the Advanced tab**
<img src="images/advanced-widget-settings_proximity.png" alt="Figure 20" width="1000"/>
Now, select **LowPower0** from the left pane, and then set the following:
- **Sense clock divider:** Retain the default value (will be set in [Stage 2: Set sense clock frequency](#stage-2-set-sense-clock-frequency))
- **Clock source:** Direct
> **Note:** Spread spectrum clock (SSC) or PRS clock can be used as the clock source to deal with EMI/EMC issues.
- **Number of sub-conversions:** 60
60 is a good starting point to ensure a fast scan time and sufficient signal. This value will be adjusted as required in [Stage 3: Fine-tune for required SNR, power, and refresh rate](#stage-3-fine-tune-for-required-snr-power-and-refresh-rate).
- **Finger threshold:** 65535
- **Noise threshold:** 40
- **Negative noise threshold:** 40
- **Low baseline reset:** 255
- **ON debounce:** 1
**Figure 21. CAPSENSE&trade; Configurator - LowPower0 Widget details tab under the Advanced tab**
<img src="images/advanced-widget-settings.png" alt="Figure 21" width="1000"/>
> **Note:** These values reduce the influence of the baseline on the sensor signal, which helps to get the true difference count. Retain the default values for all other threshold parameters; these parameters are set in [Stage 4: Tune threshold parameters](#stage-4-tune-threshold-parameters).
10. Select **CsxGaurd** from the left pane and then set the following:
- **Sense clock divider:** Retain the default value (will be set in [Stage 2: Set sense clock frequency](#stage-2-set-sense-clock-frequency))
- **Clock source:** Direct
> **Note:** Spread spectrum clock (SSC) or PRS clock can be used as a clock source to deal with EMI/EMC issues. Refer to the [CAPSENSE&trade; design guide](https://www.infineon.com/AN85951) for more information.
- **Number of sub-conversions:** 60
60 is a good starting point to ensure a fast scan time and sufficient signal. This value will be adjusted as required in [Stage 3: Fine-tune for required SNR, power, and refresh rate](#stage-3-fine-tune-for-required-snr-power-and-refresh-rate).
- **Finger threshold:** 65535
Finger threshold is set to the maximum to avoid the waking up of the device from WoT mode due to touch detection so that you can acquire signal for SNR measurement.
- **Noise threshold:** 40
- **Negative noise threshold:** 40
- **Low baseline reset:** 255
Here we have to note that for liquid level detection we have keep low baseline reset to 255 so it will get disable. This will help in liquid detection.
- **Hysteresis:** 40
- **ON debounce:** 3
**Figure 22. CAPSENSE&trade; Configurator - CSXGaurd Widget Details tab under the Advanced tab**
<img src="images/csx-guard-widget-details.png" alt="Figure 22" width="1000"/>
11. Go to the **Scan Configuration** tab to select the pins and scan slots. Do the following:
1. Configure the pins for electrodes using the drop-down menu.
2. Configure the scan slots using the **Auto-assign slots** option. The other option is to allot each sensor a scan slot based on the entered slot number.
3. Select Proximity0_Sns0 as **Ganged** under the **LowPower0** widget as shown in **Figure 24**.
4. Select CsxGaurd Rx0 electrode and set it as **Ganged** as shown in **Figure 25**. The proximity electrode loop will act as Tx and the electrodes at the edge of the touchpad will act as ganged Rx electrode, as shown in the following figure.
**Figure 23. CSX Guard widget electrodes on PCB**
<img src="images/csx-electrodes.jpg" alt="Figure 23" width= "650"/>
5. Check the notice list for warning or errors.
**Figure 24. Scan Configuration tab**
<img src="images/scan-configuration.png" alt="Figure 24" width="1000"/>
**Figure 25. Scan Configuration tab CSX Rx Ganging**
<img src="images/csx-ganged-rx0.png" alt="Figure 25" width="1000"/>
12. Click **Save** to apply the settings.
See the [CAPSENSE&trade; design guide](https://www.infineon.com/AN85951) for detailed information on tuning parameters mentioned here.
### Stage 2: Set sense clock frequency
-------------------------
The sense clock is derived from the modulator clock using a clock-divider and is used to scan the sensor by driving the CAPSENSE&trade; switched capacitor circuits. Both the clock source and clock divider are configurable.
Select the maximum sense clock frequency such that the sensor and shield capacitance are charged and discharged completely in each cycle. This can be verified using an oscilloscope and an active probe. To view the charging and discharging waveforms of the sensor, probe at the sensor (or as close as possible to the sensors), and not at the pins or resistor.
See **Figure 26** and **Figure 27** for waveforms observed on the shield. **Figure 26** shows proper charging when the sense clock frequency is correctly tuned. The pulse width is at least 5 Tau i.e., the voltage is reaching at least 99.3% of the required voltage at the end of each phase. **Figure 27** shows incomplete settling (charging/discharging).
**Figure 26. Proper charge cycle of a sensor**
<img src="images/csdrm-waveform.png" alt="" width="1000"/>
**Figure 27. Improper charge cycle of a sensor**
<img src="images/csdrm-waveform_improper.png" alt="" width="1000"/>
To set the proper sense clock frequency, follow these steps:
1. Program the board and launch CAPSENSE&trade; Tuner.
2. Observe the charging waveform of the sensor and shield as described earlier.
3. If the charging is incomplete, increase the sense clock divider. Do this in CAPSENSE&trade; Tuner by selecting the sensor and editing the sense clock divider parameter in the **Widget/Sensor Parameters** panel.
> **Note:** The sense clock divider should be **divisible by 4**. This ensures that all four scan phases have equal durations. After editing the value, click the **Apply to Device** button and observe the waveform again. Repeat this until complete settling is observed. Using a passive probe will add an additional parasitic capacitance of around 15 pF; therefore, should be considered during the tuning.
4. Click the **Apply to Project** button so that the configuration is saved to your project.
**Figure 28. Sense clock divider setting**
<img src="images/sense-clock-divider-setting.png" alt="Figure 28" width="1000"/>
5. Repeat this process for all the sensors and the shield. Each sensor may require a different sense clock divider value to charge/discharge completely. But all the sensors which are in the same scan slot need to have the same sense clock source, sense clock divider, and number of sub-conversions. Therefore, take the largest sense clock divider in a given scan slot and apply it to all the other sensors that share that slot.
**Table 3. Sense clock parameters obtained based on sensors for CY8CKIT-040T kit**
Parameter | Value
:-------- |:-----------
Modulator clock divider | 1
Sense clock divider | 44
<br>
### Stage 3: Fine-tune for required SNR, power, and refresh rate
-------------------------
The sensor should be tuned to have a minimum SNR of 5:1 and a minimum signal of 50 to ensure reliable operation. The sensitivity can be increased by increasing number of sub-conversions and noise can be decreased by enabling available filters.
The steps for optimizing these parameters are as follows:
1. Measure the SNR as mentioned in the [Operation](#operation) section.
Measure the SNR by placing your hand above the proximity loop at maximum proximity height (40 mm in this case).
2. If the SNR is less than 5:1 increase the number of sub-conversions. Edit the number of sub-conversions (N<sub>sub</sub>) directly in the **Widget/Sensor parameters** tab of the **CAPSENSE&trade; Tuner**.
> **Note:** Number of sub-conversion should be greater than or equal to 8.
3. PSoC&trade; 4000T CAPSENSE&trade; has a built-in CIC2 filter which increases the resolution for the same scan time. This example has the CIC2 filter enabled.
Calculate the decimation rate of the CIC2 filter using **Equation 1**. Note that for our case this value comes automatically. The resolution increases with an increase in the decimation rate; therefore, set the maximum decimation rate indicated by the equation.
**Equation 1. Decimation rate**
<br><br>
**$$DecimationRate = min\left(\frac {SnsClkDiv * N_{sub}}{3},255\right) $$**
Where,
- $N_{sub}$ is Number of Sub-Conversions
- $SnsClkDiv$ is Sense Clock Divider value
4. Load the parameters to the device and measure SNR as mentioned in steps 10 and 11 in the [Operation](#operation) section.
Repeat steps 1 to 4 until the following conditions are met:
- Measured SNR from the previous stage is greater than 5:1
- Signal count is greater than 50
5. If the system is noisy (>40% of signal), enable filters.
Whenever the CIC2 filter is enabled, it is recommended to enable the IIR filter for optimal noise reduction. Therefore, this example has the IIR filter enabled as well.
To enable and configure filters available in the system:
a. Open **CAPSENSE&trade; Configurator** from ModusToolbox&trade; **Quick Panel** and select the appropriate filter:
**Figure 29. Filter settings in CAPSENSE&trade; Configurator**
<img src="images/advanced-filter-settings.png" alt="Figure 29" width="1000"/>
- Add the filter based on the type of noise in your measurements. See [ModusToolbox&trade; CAPSENSE&trade; Configurator user guide](https://www.infineon.com/ModusToolboxCapSenseConfig) for details.
b. Click **Save** and close CAPSENSE&trade; Configurator. Program the device to update the filter settings.
> **Note** : Increasing number of sub-conversions and enabling filters increases the scan time which in turn decreases the responsiveness of the sensor. Increase in scan time also increases the power consumption. Therefore, the number of sub-conversions and filter configuration must be optimized to achieve a balance between SNR, power, and refresh rate.
### Stage 4: Tune threshold parameters
-------------------------
Various thresholds, relative to the signal, need to be set for each sensor. Do the following in CAPSENSE&trade; Tuner to set up the thresholds for a widget:
1. Switch to the **Graph View** tab and select **Proximity0**.
2. Place your hand at 40 mm directly above the proximity sensor and monitor the touch signal in the **Sensor signal** graph, as shown in the following figure.
**Figure 30. Sensor signal when the sensor is touched**
<img src="images/tuner-threshold-settings.png" alt="Figure 30" width="1000"/>
3. Note the signal measured and set the thresholds according to the following recommendations:
- **Proximity threshold** = 80% of the signal
- **Proximity touch threshold** = 80% of the signal
Here, the touch threshold denotes the threshold for the proximity sensor to detect a touch when it is touched by a finger. When the proximity sensor is touched, the sensor yields a higher signal compared the proximity signal; therefore, it is the **touch signal**. To measure the touch signal count, touch the sensor and monitor the signal in the **Sensor signal** graph.
- **Noise threshold** = 40% of the signal
- **Negative noise threshold** = 40% of the signal
- **Hysteresis** = 10% of signal
- **Low baseline reset** = 255
- **Hysteresis** = 10% of the signal
- **ON debounce** = 3
4. For the **LowPower0** sensor, first configure the **Finger threshold** to 65535 and wait for the application to enter Low Power mode. Because the **Finger threshold** is set to maximum, touching the low power button will not switch the application to active mode. Repeat steps 2 to 4 for the low power button.
5. Apply the settings to the device by clicking **To device**.
**Figure 31. Apply settings to device**
<img src="images/tuner-apply-settings-device.png" alt="Figure 31" width="450"/>
If your sensor is tuned correctly, you will observe that the proximity status goes from 0 to 1 in the **Status** sub-window of the **Graph View** window as **Figure 35** shows. The successful tuning of the proximity sensor is also indicated by LED3 in the kit; it turns ON when the hand comes closer than the maximum distance and turns OFF when the hand is moved away from the proximity sensor.
**Figure 32. Sensor status in CAPSENSE&trade; Tuner showing proximity status**
<img src="images/tuner-status.png" alt="Figure 32"/>
After touching the proximity loop, a further change in status from `1` to `3` can be observed, which indicates a touch. Along with this, LED1 will turn ON in blue color.
**Figure 33. Sensor status in CAPSENSE&trade; Tuner showing touch status**
<img src="images/tuner-status-touch.png" alt="Figure 33" width="1000"/>
7. Click **Apply to Project** as **Figure 38** shows. The change is updated in the *design.cycapsense* file.
Close **CAPSENSE&trade; Tuner** and launch **CAPSENSE&trade; Configurator**. You should now see all the changes that you made in the CAPSENSE&trade; Tuner reflected in the **CAPSENSE&trade; Configurator**.
**Figure 34. Apply settings to Project**
<img src="images/tuner-apply-settings-project.png" alt="Figure 34" width="400"/>
**Table 4. Tuning parameters obtained based on sensors for CY8CKIT-040T kit**
Parameter | Proximity0 | LowPower0
:-------- |:-----------|:---------
Proximity signal | 120 |120
Touch signal | 3100 | -
Proximity threshold | 96 |96
Touch threshold | 2480 |-
Noise threshold |48|48
Negative noise threshold |48 |48
Low baseline reset | 255 |255
Hysteresis | 12 |12
ON debounce | 3|3
<br>
> **Note:** For the low-power widget the touch threshold is the finger threshold.
### Stage 5: Re-tune threshold parameters for liquid tolerance
-------------------------
The **Csx Guard Widget** is configured as a mutual capacitance sensor (CSX) to be triggered when liquid (for example, water) is present at the intersection of the touchpad boundary and proximity sensor loop. When a liquid droplet is present on this sensor setup, mutual capacitance increases, and the raw count detected by CSX drops can be used to deactivate the proximity loop. Once the liquid droplets are removed/wiped off, the raw count again increases and the proximity loop can be re-activated.
See the algorithm implemented in the code example.
2. Tune the proximity sensor for liquid tolerance:
1. Sprinkle some water on the surface of the kit such that only a few water droplets are present on the area marked as the proximity sensor. This is the scenario where target object can still be detected.
2. Measure the signal of proximity sensor (Proximity0_Sns0) as per step 11 mentioned in the **Monitor data using CAPSENSE&trade; Tuner** section.
3. Set the **Proximity threshold** three times that of the signal when water droplets are present on the Proximity sensor. In this case, it is set to 750.
2. To tune the Csx widget for liquid tolerance, follow the below steps:
1. Sprinkle water on the surface of the kit such that water droplets cover the inside and slightly outside of the entire area marked as the proximity sensor. This is the scenario where proximity detection will be disabled to prevent false triggers.
2. Open the **SNR Measurement** tab and then select **CsxGuard** in the Widget Explorer panel.
3. Measure the signal of CSX Guard according to Step 11 mentioned in the **Monitor data using CAPSENSE&trade; Tuner** section.
4. Set **Number of sub-conversions:**
Since the CsxGuard sensor widget also uses the CIC2 filter, keep the Number of sub-conversions and decimation rate the same as those of the **Proximity0** widget.
5. Set **Finger threshold:**
Since presence of liquid droplets will reduce the raw count below the baseline, positive raw count (above baseline) is not of interest and can be ignored.
6. Set **Negative noise threshold:**
40% of the signal raw count is measured below the baseline when liquid is present on the surface.
7. Set **Noise threshold:** the same as the **Negative noise threshold**
Since the presence of liquid droplets will reduce the raw count below the baseline, a positive raw count (above baseline) is not of interest and can be ignored. The value mentioned here is to make sure the baseline is updated in accordance to noise present in the system.
8. Set **Low baseline reset:**
Since this widget is configured as guard, raw count value lower than baseline will be used to detect liquid presence. 'Low baseline reset' is set to 65535, so that the baseline does not reset at all when there is a dip in raw count due to the presence of liquid.
9. Set **Hysteresis**: 10% of the signal raw count measured below the baseline when liquid is present on the surface
**Table 5. CSX guard sensor threshold parameters for liquid tolerance for CY8CKIT-040T**
Parameter | Raw Count value
:-------- |:-----------
Number of sub conversions | 255
Noise threshold |50
Liquid signal | 125
Negative noise threshold |50
Low baseline reset | 255
Hysteresis | 13
ON debounce | 3
Liquid active threshold | 100
Liquid active hysteresis | 10
Liquid active ON debounce | 3
<br>
> **Note:** Liquid tolerarance active parameters are mentioned in *main.c* as the following user macro:
```
#define LIQUID_GUARD_NEG_RAWCOUNT_THRESHOLD (100u)
#define LIQUID_GUARD_HYSTERESIS (10u)
#define LIQUID_GUARD_DEBOUNCE (3u)
```
> **Note:** To prevent low baseline from resetting add below code in *main.c* just next line to `InitializeCapsense();` This will set the CSX Guard widget's low baseline variable to 256 and will prevent resetting.
```
cy_capsense_context.ptrWdContext[2].lowBslnRst = 256;
```
<br>
### **Process time measurement**
--------------------
To set the optimum refresh rate for each power mode, measure the processing time of the application.
Follow these steps to measure the process time of the blocks of application code while excluding the scan time:
1. Enable ENABLE_RUN_TIME_MEASUREMENT macro in *main.c* as follows:
```
#define ENABLE_RUN_TIME_MEASUREMENT (1u)
```
This macro enables the system tick configuration and runtime measurement functionalities.
2. Place the start_runtime_measurement() function call before your application code and the stop_runtime_measurement() function call after it. The stop_runtime_measurement() function will return the execution time in microseconds (µs).
```
#if ENABLE_RUN_TIME_MEASUREMENT
uint32_t run_time = 0;
start_runtime_measurement();
#endif
/* User Application Code Start */
.
.
.
/* User Application Code Stop */
#if ENABLE_RUN_TIME_MEASUREMENT
run_time = stop_runtime_measurement();
#endif
```
3. Run the application in debug mode with breakpoints placed at the active_processing_time and alr_processing_time variables as follows:
```
#if ENABLE_RUN_TIME_MEASUREMENT
active_processing_time = stop_runtime_measurement();
#endif
and
#if ENABLE_RUN_TIME_MEASUREMENT
alr_processing_time = stop_runtime_measurement();
#endif
```
4. Read the variables by adding them into **Expressions view** tab.
5. Update related macros with the earlier measured processing times in main.c as follows:
```
#define ACTIVE_MODE_PROCESS_TIME (xx)
#define ALR_MODE_PROCESS_TIME (xx)
```
### **Scan time measurement**
--------------------
Scan time is also required for calculating the refresh rate of the application power modes. The total scan time of all the widgets in this code example is 10 µs.
It can be calculated as follows:
The scan time includes the MSCLP initialization time, Cmod, and the total sub-conversions of the sensor.
To control the Cmod initialization sequence, set the "Enable Coarse initialization bypass" configurator option as listed in the following table:
Enable coarse initialization bypass | Behavior
:-------------|:---------
TRUE|Cmod initialization happens only once before scanning the sensors of the widget
FALSE| Cmod initialization happens before scanning each sensor of the widget
Use the following equations to measure the widgets scan time based on coarse initialization bypass options selected:
**Equation 2. Scan time calculation of a widget with coarse initialization bypass enabled**
<br><br>
$$ScanTime_{widget} = \left(\sum_{sensor=1}^n \left((N_{init} + N_{sub}) * \frac {SnsClkDiv}{F_{mod}}\right)\right) +k $$
<br><br>
**Equation 3. Scan time calculation of a widget with coarse initialization bypass disabled**
<br><br>
$$ScanTime_{widget} = \sum_{sensor=1}^n \left((N_{init} + N_{sub}) * \frac {SnsClkDiv}{F_{mod}} +k \right) $$
<br>
Where,
- $n$ - Total number of sensors in the widget
- $N_{sub}$ - Number of sub-conversions
- $N_{init}$ - Number of init sub-conversions
- $SnsClkDiv$ - Sense clock divider
- $F_{mod}$ - Modulator clock frequency
- $k$ - Measured Initialization time (MSCLP+Cmod).
This value of 'k' measured for this application is ~9 µs. It remains constant for all widgets, and can be measured using oscilloscope as shown in the following figure.
**Figure 35. 'k' value measurement**
<img src="images/scantime_wave.png" alt="Figure 35" width="1000"/>
Update the following macros in *main.c* using the scan time calculated. The value remains the same for both the macros for this application.
```
#define ACTIVE_MODE_FRAME_SCAN_TIME (xx)
#define ALR_MODE_FRAME_SCAN_TIME (xx)
```
> **Note:** If the application has more than one widget, add the scan times of individual widgets calculated.
## Debugging
You can debug the example to step through the code.
<details><summary><b>In Eclipse IDE</b></summary>
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&trade; user guide](https://www.infineon.com/MTBEclipseIDEUserGuide).
</details>
<details><summary><b>In other IDEs</b></summary>
Follow the instructions in your preferred IDE.
</details>
By default, the debug option is disabled in the Device Configurator. To enable the debug option, see the [Set up VDDA and debug mode in Device Configurator](#set-up-the-vdda-supply-voltage-and-debug-mode-in-device-configurator) section. To achieve low power consumption, it is recommended to disable it.
## Design and implementation
The project contains the following widgets:
1. Proximity widget with 1 electrode configured in CSD-RM Sensing mode
2. Low power widget with 1 electrode configured in CSD-RM sensing mode
3. Mutual-capacitance guard widget with 1 Tx electrode and 4 Rx electrodes configured in CSX sensing mode
See the [Tuning procedure](#tuning-procedure) section for step-by-step instructions on configuring these widgets.
<br>
The project uses the [CAPSENSE&trade; middleware](https://infineon.github.io/capsense/capsense_api_reference_manual/html/index.html); see the [ModusToolbox&trade; user guide](https://www.infineon.com/ModusToolboxUserGuide) for more details on selecting a middleware.
See [AN85951 – PSoC&trade; 4 and PSoC&trade; 6 MCU CAPSENSE&trade; design guide](https://www.infineon.com/an85951) for more details of CAPSENSE&trade; features and usage.
The design also has an EZI2C peripheral and a SPI master peripheral. The EZI2C slave peripheral is used to monitor the information of sensor raw and processed data on a PC using the CAPSENSE&trade; Tuner available in the Eclipse IDE for ModusToolbox&trade; via I2C communication.
The MOSI pin of the SPI slave peripheral is used to transfer data to the three serially connected LEDs for controlling color, brightness, and ON/OFF operation.
The firmware is designed to support the following application states:
- Active state
- Active low-refresh rate state
- Wake-on-touch state
- Liquid active state
**Figure 36. State machine showing different CAPSENSE&trade; states**
<img src="images/psoc_4000t_simple_state_machine.png" alt="Figure 36" width="1000"/>
The firmware state machine and the operation of the device in four different states are explained in the following steps:
1. Initializes and starts all hardware components after reset.
2. The device starts CAPSENSE&trade; operation in the Active state. In this state, the following steps occur:
1. The device scans all CAPSENSE&trade; sensors present on the board.
2. During the ongoing scan operation, the CPU moves to the Deep Sleep state.
3. The interrupt generated on scan completion wakes the CPU, which processes the sensor data and transfers the data to CAPSENSE&trade; Tuner through EZI2C.
4. Turn ON the serial LED with specific colors and patterns to indicate the specific proximity or touch detection.
In Active state, a scan of the selected sensors happen with the highest refresh rate of 128 Hz.
3. Enters the Active low-refresh rate state when there is no touch or object in proximity detected for a timeout period. In this state, selected sensors are scanned with a lower refresh rate of 32 Hz. Because of this, power consumption in the Active low-refresh rate state is lower compared to the Active state. The state machine returns to the Active state if there is touch or object in proximity detected by the sensor.
4. Enters the Wake-on-Touch state when there is no touch or object in proximity detected in Active low-refresh rate state for a timeout period. In this state, the CPU is set to deep sleep, and is not involved in CAPSENSE&trade; operation. This is the lowest power state of the device. In the Wake-on-Touch state, the CAPSENSE&trade; hardware executes the scanning of the selected sensors called "low-power widgets" and processes the scan data for these widgets. If touch is detected, the CAPSENSE&trade; block wakes up the CPU and the device enters to the Active state.
5. Enters the 'Liquid Active' state when the guard sensors is activated. Guard sensors are used to detect the presence of liquid on the surface. When the CY8CKIT-040T kit is dipped inside liquid, or liquid is sprayed on the surface, device enters into the 'Liquid Active' state. In this state, no other sensors other than the guard sensor is scanned. This state restricts normal scan operation and avoids any false touch by deactivating the scan operation of active sensors. When the liquid is removed from the surface, system returns to the Active state.
There are three onboard RGB LEDs connected to the SPI MOSI pin of the device. These LEDs form a daisy-chain connection and communicate over the serial interface. See the [LED datasheet](https://media.digikey.com/pdf/Data%20Sheets/Everlight%20PDFs/12-23C_RSGHBHW-5V01_2C_Rev4_12-17-18.pdf) for more details.
### Firmware flow
**Figure 37. Firmware flowchart**
<img src="images/firmware-flowchart.png" alt="Figure 37" width="1200"/>
### Set up the VDDA supply voltage and debug mode in Device Configurator
1. Open Device Configurator from the **Quick Panel**.
2. Go to the **System** tab. Select the **Power** resource, and set the VDDA value under **Operating conditions** as shown in the following figure.
**Figure 38. Setting the VDDA supply in the System tab of Device Configurator**
<img src="images/vdda-settings.png" alt="Figure 38" width="1000"/>
3. By default, the debug mode is disabled for this application to reduce power consumption. Enable the debug mode to enable the SWD pins as shown in the following figure.
**Figure 39. Enable debug mode in the System tab of Device Configurator**
<img src="images/enable_debug.png" alt="Figure 39" width="1000"/>
### Resources and settings
**Figure 40. EZI2C settings**
<img src="images/ezi2c-config.png" alt="Figure 40" width="1000"/>
**Figure 41 SPI settings**
<img src="images/spi-config.png" alt="Figure 41" width="1000"/>
**Table 6. Application resources**
Resource | Alias/object | Purpose
:------- | :------------ | :------------
SCB (I2C) (PDL) | CYBSP_EZI2C | EZI2C slave driver to communicate with CAPSENSE&trade; Tuner
SCB (SPI) (PDL) | CYBSP_MASTER_SPI | SPI master driver to control serial LEDs
CAPSENSE&trade; | CYBSP_MSC | CAPSENSE&trade; driver to interact with the MSC hardware and interface the CAPSENSE&trade; sensors
Digital pin | CYBSP_SERIAL_LED | To show the proximity operation and power mode states
<br>
## Related resources
Resources | Links
-----------|----------------------------------
Application notes | [AN79953](https://www.infineon.com/AN79953) – Getting started with PSoC&trade; 4 <br> [AN85951](https://www.infineon.com/AN85951) – PSoC&trade; 4 and PSoC&trade; 6 MCU CAPSENSE&trade; design guide <br> [AN234231](https://www.infineon.com/AN234231) – Achieving lowest-power capacitive sensing with PSoC&trade; 4000T <br> [AN92239](https://www.infineon.com/AN92239) – Proximity sensing with CAPSENSE&trade;
Code examples | [Using ModusToolbox&trade;](https://github.com/Infineon/Code-Examples-for-ModusToolbox-Software) on GitHub
Device documentation | [PSoC&trade; 4 datasheets](https://www.infineon.com/cms/en/search.html#!view=downloads&term=psoc4&doc_group=Data%20Sheet) <br>[PSoC&trade; 4 technical reference manuals](https://www.infineon.com/cms/en/search.html#!view=downloads&term=psoc4&doc_group=Additional%20Technical%20Information)
Development kits | Select your kits from the [Evaluation board finder](https://www.infineon.com/cms/en/design-support/finder-selection-tools/product-finder/evaluation-board).
Libraries on GitHub | [mtb-pdl-cat2](https://github.com/Infineon/mtb-pdl-cat2) – PSoC&trade; 4 Peripheral Driver Library (PDL) <br> [mtb-hal-cat2](https://github.com/Infineon/mtb-hal-cat2) – Hardware Abstraction Layer (HAL) library
Middleware on GitHub | [capsense](https://github.com/Infineon/capsense) – CAPSENSE&trade; library and documents <br> [psoc4-middleware](https://github.com/Infineon/modustoolbox-software#libraries) – Links to all PSoC&trade; 4 middleware
Tools | [ModusToolbox&trade;](https://www.infineon.com/modustoolbox) – ModusToolbox&trade; software is a collection of easy-to-use libraries and tools enabling rapid development with Infineon MCUs for applications ranging from wireless and cloud-connected systems, edge AI/ML, embedded sense and control, to wired USB connectivity using PSoC&trade; Industrial/IoT MCUs, AIROC&trade; Wi-Fi and Bluetooth&reg; connectivity devices, XMC&trade; Industrial MCUs, and EZ-USB&trade;/EZ-PD&trade; wired connectivity controllers. ModusToolbox&trade; incorporates a comprehensive set of BSPs, HAL, libraries, configuration tools, and provides support for industry-standard IDEs to fast-track your embedded application development.
<br>
## Other resources
Infineon provides a wealth of data at [www.infineon.com](https://www.infineon.com) to help you select the right device, and quickly and effectively integrate it into your design.
## Document history
Document title: *CE238228* – *PSoC&trade; 4: MSCLP CAPSENSE&trade; liquid-tolerant proximity-sensing*
Version | Description of change
------- | ---------------------
1.0.0 | New code example
1.1.0 | Minor fixes
1.2.0 | Scan time calculation updates and debug disabled by default
1.2.1 | Minor fixes
2.0.0 | Major update to support ModusToolbox&trade; v3.2 and and CAPSENSE&trade; Middleware v5.0. <br> This version is not backward compatible with previous versions of ModusToolbox&trade;
<br>
All referenced product or service names and trademarks are the property of their respective owners.
The Bluetooth&reg; word mark and logos are registered trademarks owned by Bluetooth SIG, Inc., and any use of such marks by Infineon is under license.
---------------------------------------------------------
© Cypress Semiconductor Corporation, 2023-2024. 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.
<br>
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.
<br>
Cypress, the Cypress logo, and combinations thereof, 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.