PSoC™ 4: MSCLP multitouch mutual-capacitance touchpad tuning
This code example demonstrates how to use the CAPSENSE™ middleware to detect two finger touch positions on a mutual-capacitance-based touchpad widget in PSoC™ 4 devices with multi sense converter low power (MSCLP).
In addition, this code example also explains how to manually tune the mutual-capacitance-based touchpad for optimum performance with respect to parameters such as reliability, power consumption, response time, and linearity using the CSX-RM sensing technique and CAPSENSE™ tuner GUI. Here, CAPSENSE™ crosspoint (CSX) represents the mutual-capacitance sensing technique and RM represents the ratiometric method.
Provide feedback on this code example.
Requirements
-
ModusToolbox™ software v3.1 or later
Note: This code example version requires ModusToolbox™ software version 3.1 or later, and is not backward compatible with v3.0 or older versions.
-
Board support package (BSP) minimum required version: 3.1.0
-
Programming language: C
-
Associated parts: PSoC™ 4000T
Supported toolchains (make variable 'TOOLCHAIN')
- 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
)
Supported kits (make variable 'TARGET')
- PSoC™ 4000T CAPSENSE™ Evaluation Kit (
CY8CKIT-040T
) - DefaultTARGET
Hardware setup
This example uses the board's default configuration. See the kit user guide to ensure that the board is configured correctly.
Note: The PSoC™ 4 kits (except CY8CKIT-040T and CY8CKIT-041S-MAX) 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".
Software setup
This example requires no additional software or tools.
Using the code example
Create the project and open it using one of the following:
In Eclipse IDE for ModusToolbox™ software
-
Click the New Application link in the Quick Panel (or, use File > New > ModusToolbox™ Application). This launches the Project Creator tool.
-
Pick a kit supported by the code example from the list shown in the Project Creator – Choose Board Support Package (BSP) dialog.
When you select a supported kit, the example is reconfigured automatically to work with the kit. To work with a different supported kit later, use the Library Manager to choose the BSP for the supported kit. You can use the Library Manager to select or update the BSP and firmware libraries used in this application. To access the Library Manager, click the link from the Quick Panel.
You can also just start the application creation process again and select a different kit.
If you want to use the application 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.
-
In the Project Creator - Select Application dialog, choose the example by enabling the checkbox.
-
(Optional) Change the suggested New Application Name.
-
The Application(s) Root Path defaults to the Eclipse workspace, which is usually the desired location for the application. If you want to store the application in a different location, you can change the Application(s) Root Path value. Applications that share libraries should be in the same root path.
-
Click Create to complete the application creation process.
For more details, see the Eclipse IDE for ModusToolbox™ software user guide (locally available at {ModusToolbox™ software install directory}/docs_{version}/mt_ide_user_guide.pdf).
In command-line interface (CLI)
ModusToolbox™ software provides the Project Creator as both a GUI tool and the command line tool, "project-creator-cli". The 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™ software 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™ software installation instead of a standard Windows command-line application. This shell provides access to all ModusToolbox™ software 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 "project-creator-cli" tool has the following arguments:
Argument | Description | Required/optional |
---|---|---|
--board-id |
Defined in the <id> field of the BSP manifest |
Required |
--app-id |
Defined in the <id> 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 |
The following example will clone the "CAPSENSE™ MSCLP mutual capacitance touchpad tuning" application with the desired name "MSCLPMutualCapTouchpadTuning" 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-mutual-capacitance-touchpad --user-app-name MSCLPMutualCapTouchpadTuning --target-dir "C:/mtb_projects"
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™ software user guide (locally available at {ModusToolbox™ software install directory}/docs_{version}/mtb_user_guide.pdf).
To work with a different supported kit later, use the Library Manager to choose the BSP for the supported kit. You can invoke the Library Manager GUI tool from the terminal using make library-manager
command or use the Library Manager CLI tool "library-manager-cli" to change the BSP.
The "library-manager-cli" tool has the following arguments:
Argument | Description | Required/optional |
---|---|---|
--add-bsp-name |
Name of the BSP that should be added to the application | Required |
--set-active-bsp |
Name of the BSP that should be as active BSP for the application | Required |
--add-bsp-version |
Specify the version of the BSP that should be added to the application if you do not wish to use the latest from manifest | Optional |
--add-bsp-location |
Specify the location of the BSP (local/shared) if you prefer to add the BSP in a shared path | Optional |
Following example adds the CY8CKIT-040T BSP to the already created application and makes it the active BSP for the app:
library-manager-cli --project "C:/mtb_projects/MSCLPMutualCapTouchpadTuning" --add-bsp-name CY8CKIT-040T --add-bsp-version "latest-v3.X" --add-bsp-location "local"
library-manager-cli --project "C:/mtb_projects/MSCLPMutualCapTouchpadTuning" --set-active-bsp APP_CY8CKIT-040T
In third-party IDEs
Use one of the following options:
-
Use the standalone Project Creator tool:
-
Launch Project Creator from the Windows Start menu or from {ModusToolbox™ software install directory}/tools_{version}/project-creator/project-creator.exe.
-
In the initial Choose Board Support Package screen, select the BSP, and click Next.
-
In the Select Application screen, select the appropriate IDE from the Target IDE drop-down menu.
-
Click Create and follow the instructions printed in the bottom pane to import or open the exported project in the respective IDE.
-
-
Use command-line interface (CLI):
-
Follow the instructions from the In command-line interface (CLI) section to create the application, and then import the libraries using the
make getlibs
command. -
Export the application to a supported IDE using the
make <ide>
command. -
Follow the instructions displayed in the terminal to create or import the application as an IDE project.
-
For a list of supported IDEs and more details, see the "Exporting to IDEs" section of the ModusToolbox™ software user guide (locally available at {ModusToolbox™ software install directory}/docs_{version}/mtb_user_guide.pdf).
The project already has the necessary settings by default, so you can go to Operation to test the example. If you want to understand the tuning process and follow the stages for this kit or your own board, go to Tuning procedure and then test it using Operation.
Operation
-
Connect the board to your PC using the provided micro-B USB cable through the KitProg3 USB connector as follows:
Figure 1. Connecting the CY8CKIT-040T kit with the PC
-
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 program
command to build and program the application using the default toolchain to the default target. The target and the toolchain is specified manually:make program TARGET=<BSP> TOOLCHAIN=<toolchain>
Example:
make program TARGET=CY8CKIT-040T TOOLCHAIN=GCC_ARM
-
-
After programming, the application starts automatically.
-
To test the application, slide your finger over the CAPSENSE™ touchpad and notice that LED1 and LED3 turn ON with green color when touched and turn OFF when the finger is lifted.
- LED1 brightness increases when finger is moved from bottom to up, with bottom row having minimum and top row having maximum brightness.
- LED3 brightness increases when finger is moved from left to right, with left column having minimum and right column having maximum brightness.
-
You can also monitor the CAPSENSE™ data using the CAPSENSE™ tuner application as follows:
Monitor data using CAPSENSE™ tuner
-
Open CAPSENSE™ Tuner from the tools section in the IDE Quick Panel.
You can also run the CAPSENSE™ Tuner application in standalone mode 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 of the respective application, which is present in the {Application root directory}/bsps/TARGET_APP_<BSP-NAME>/config/ folder.
See the ModusToolbox™ software user guide (locally available at ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf) for options to open the CAPSENSE™ Tuner application using the CLI.
-
Ensure the kit is in CMSIS-DAP bulk mode (KitProg3 status LED is ON and not blinking). See Firmware-loader to learn how to update the firmware and switch modes in KitProg3.
-
In the tuner application, click on the Tuner Communication Setup icon or select Tools > Tuner Communication Setup. In the window, select the I2C checkbox 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 2. Tuner communication setup parameters
-
Click Connect or select Communication > Connect to establish a connection.
Figure 3. Establish a connection
-
Click Start or select Communication > Start to start data streaming from the device.
Figure 4. Start tuner communication
The Widget/Sensor parameters tab gets updated with the parameters configured in the CAPSENSE™ configurator window. The tuner displays the data from the sensor in the Widget View and Graph View tabs.
-
-
Set the Read Mode to the Synchronized mode. Under the Widget View tab, you can see the touchpad widget sensors highlighted when you touch it.
Figure 5. Widget view of the CAPSENSE™ tuner
-
You can view the raw count, baseline, difference count for each sensor and also the touchpad position in the Graph View tab. For example, to view the sensor data for a single sensor in Touchpad, select Touchpad_Rx0_Tx0 under Touchpad.
Figure 6. Graph view of the CAPSENSE™ tuner
-
The Touchpad View tab shows the heat map view and the finger movement can be visualized on the same.
Figure 7. Touchpad view of the CAPSENSE™ Tuner
-
Observe the Widget/Sensor Parameters section in the CAPSENSE™ Tuner window. The compensation CDAC values for each touchpad sensor element calculated by the CAPSENSE™ resource is displayed as shown in Figure 7.
-
Verify that the SNR is greater than 5:1 by following the steps given in Stage 5 Tuning procedure.
The linearity of the position graph, non-reporting of false touches, and no discontinuity in the line drawing indicate a proper tuning.
Tuning procedure
Create custom BSP for your board
-
Create a custom BSP for your board with any device by following the steps given in ModusToolbox™ BSP Assistant user guide. This code example was created for the device "CY8C4046LQI-T452".
-
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™ to get the design.cycapsense file. CAPSENSE™ configuration can then be started from scratch as explained below.
The following steps explain the tuning procedure.
Note: See the "Selecting CAPSENSE™ hardware parameters" section in the PSoC™ 4 and PSoC™ 6 MCU CAPSENSE™ design guide to learn about the considerations for selecting each parameter values.
Figure 8. CSX touchpad widget tuning flow
Do the following to tune the touchpad widget:
Stage 1: Set initial hardware parameters
-
Connect the board to your PC using the provided USB cable through the KitProg3 USB connector.
-
Launch the device configurator tool.
You can launch the device configurator in Eclipse IDE for ModusToolbox™ from the Tools section in the IDE Quick panel or in standalone mode from {ModusToolbox™ 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, which is present in the {Application root directory}/bsps/TARGET_APP_<BSP-NAME>/config/ folder.
-
In the PSoC™ 4000T Kit, the touchpad pins are connected to CAPSENSE™ channel (MSCLP 0). Therefore, make sure that you enable CAPSENSE™ channel in the Device Configurator, as shown in Figure 9.
Figure 9. Enable MSCLP channel in device configurator
Save the changes and close the window.
-
Launch the CAPSENSE™ configurator tool.
You can launch the CAPSENSE™ configurator tool in Eclipse IDE for ModusToolbox™ from the 'CAPSENSE™' 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™ install directory}/ModusToolbox/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>/config/ folder.
See the ModusToolbox™ CAPSENSE™ configurator tool guide for step-by-step instructions on how to configure and launch CAPSENSE™ in ModusToolbox™.
-
In the Basic tab, note that a touchpad Touchpad is configured with CSX RM (Mutual-cap) Sensing Mode.
Figure 10. CAPSENSE™ configurator - Basic tab
-
Do the following in the General tab under the Advanced tab:
-
Select CAPSENSE™ IMO clock frequency as 46 MHz.
-
Set Modulator clock divider to "1" to obtain the maximum available modulator clock frequency as recommended in the PSoC™ 4 and PSoC™ 6 MCU CAPSENSE™ design guide.
Note: The modulator clock frequency can be set to 46,000 kHz after changing the CAPSENSE™ IMO clock frequency to 46 MHz, because the modulator clock is derived from the CAPSENSE™ IMO clock. In the CAPSENSE™ IMO clock frequency drop-down list, select 46 MHz.
-
Number of init sub-conversions is set based on the hint shown when you hover over the edit box. Retain the default value.
-
Because CIC2 filter is enabled, it is recommended to enable IIR filter. Retain the default settings for all filters. You can enable the filters later depending on the signal-to-noise ratio (SNR) requirements mentioned in Stage 5.
Filters are used to reduce the peak-to-peak noise. Using filters will result in longer scan time.
Figure 11. CAPSENSE™ Configurator - General settings
Note: Each tab has a Restore Defaults button to restore the parameters of that tab to their default values.
-
-
Go to the CSX Settings tab and make the following changes:
-
Set Inactive Sensor connection to Ground.
-
Set Number of reported fingers to 2 for two-finger detection.
-
Select Enable CDAC auto-calibration and Enable compensation CDAC.
This helps in achieving the required CDAC calibration levels (40% of the maximum count) for all sensors in the widget, while maintaining the same sensitivity across the sensor elements.
-
Select Enable CDAC dither.
This helps in removing flat-spots, by adding white noise that moves the conversion point around the flat-spots region.
Figure 12. CAPSENSE™ configurator - Advanced CSX settings
-
-
Go to the Widget Details tab. Select Touchpad from the left pane, and then set the following:
-
Maximum X-Axis position and Maximum Y-Axis position to 255.
-
Tx clock divider: Retain default value (will be set in Stage 3)
-
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: 25
25 is a good starting point to ensure a fast scan time and sufficient signal. This value will be adjusted as required in Stage 4.
-
Finger Threshold: 20
Finger Threshold is initially set to a low value, which allows the Touchpad View to track the finger movement during tuning.
-
Noise Threshold: 10
-
Negative Noise Threshold: 10
-
Hysteresis: 5
-
ON debounce: 10
These values reduces the influence of baseline on the sensor signal, which helps to get the true difference-count. Retain the default values for the widget threshold parameters; these parameters are set in Stage 6.
Figure 13. CAPSENSE™ configurator - Widget details settings
-
-
Go to the Scan Configuration tab to select the pins, the scan slots, and do the following:
-
Configure the pin for the electrode using the drop-down menu.
-
Configure the scan slot using the Auto-Assign Slots option or each sensor is allotted a scan slot based on the entered slot number.
-
Check the notice list for warning or errors.
Note: Enable the Notice List in the View menu if it is not visible.
Figure 14. Scan configuration tab
-
-
Click Save to apply the settings.
Stage 2: Measure the sensor capacitance to set CDAC Dither
The CAPSENSE™ middleware provides the built-in self-test (BIST) APIs to measure capacitances of sensors configured in the application. The sensor capacitances are referred to as Cp for CSD sensors and Cm for CSX sensor.
Follow these steps to measure the Cp/Cm using BIST:
- Open CAPSENSE™ Configurator from Quick Panel and enable the BIST library.
Figure 15. Enabling self test library
- Follow these steps to get the capacitance(Cp/Cm):
- Add a breakpoint at the function call "measure_sensor_capacitance()" in main.c.
- Run the application in debug mode.
- Click the Step over button once break point hits.
- Add an array variable sensor_capacitance to the Expressions view tab that holds the measured Cp values of configured sensors.
Figure 16. Measure Cp/Cm using BIST
- The index of the sensor_capacitance array matches the sensor configuration in CAPSENSE™ Configurator, as shown in Figure 17.
Figure 17. Cp array index alignment
- For more details on BIST, See CAPSENSE™ library and documents.
- Keep this feature disabled in CAPSENSE™ Configurator, if not used in application.
CDAC Dither scale setting
MSCLP uses CDAC dithering to reduce flat spots. Select the optimal dither scale parameter based on the sensor capacitance measured using BIST library.
See the following table for general recommended values of Dither scale.
Table 1. Dither scale recommendation for CSD sensors
Parasitic capacitance (Cp) | Scale |
---|---|
2pF <= Cp < 3pF | 3 |
3pF <= Cp < 5pF | 2 |
5pF <= Cp < 10pF | 1 |
Cp >= 10pF | 0 |
Table 2. Dither Scale recommendation for CSX sensors
Mutual capacitance (Cm) | Scale |
---|---|
300fF <= Cm < 500fF | 5 |
500fF <= Cm < 1000fF | 4 |
1000fF <= Cm < 2000fF | 3 |
Cm >= 2pF | Follow Table 1 |
Set the scale value in CAPSENSE™ Configurator as follows.
Figure 18. CDAC Dither scale setting
Stage 3: Set the 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™ switched capacitor circuits. Both the clock source and clock divider are configurable. The sense clock divider should be configured such that the pulse width of the sense clock is long enough to allow the sensor capacitance to charge and discharge completely. This is verified by observing the charging and discharging waveforms of the sensor using an oscilloscope and an active probe. The sensors should be probed close to the electrode and not at the sense pins or the series resistor.
See Figure 19 and Figure 20 for waveforms observed on the shield. Figure 19 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 20 shows incomplete settling (charging/discharging).
Figure 19. Proper charge cycle of a sensor
Figure 20. Improper charge cycle of a sensor
-
Program the board and launch CAPSENSE™ Tuner.
-
See the charging waveform of the sensor as described earlier.
-
If the charging is incomplete, increase the sense clock divider. This can be done in CAPSENSE™ 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 2. This ensures that both the 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.
-
Click the Apply to Project button so that the configuration is saved to your project.
Figure 21. Sense Clock Divider setting
-
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 that 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.
Stage 4: Obtain crossover point and noise
-
Program the board.
-
Launch the CAPSENSE™ Tuner to monitor the CAPSENSE™ data and for CAPSENSE™ parameter tuning and SNR measurement.
See the CAPSENSE™ Tuner guide for step-by-step instructions on how to launch and configure the CAPSENSE™ Tuner in ModusToolbox™ software.
-
Capture the raw counts of each sensor element in the touchpad (as shown in Figure 22) and verify that they are approximately (+/- 5%) equal to 40% of the MaxCount. See design guide for the MaxCount equation.
-
Go to the Touchpad View tab and change the Display settings as follows:
-
Data type: RawCount
-
Value type: Current
-
Number of samples: 1000
-
Figure 22. Raw counts obtained on the Touchpad View tab in the tuner window
-
-
Capture and note the peak-to-peak noise of each sensor element in the touchpad.
-
From the Widget Explorer section, select the Touchpad widget.
-
Go to the Touchpad View tab and change the Display settings as follows:
-
Display mode: Touch Reporting
-
Data type: RawCount
-
Value type: Max-Min
-
Number of Samples: 1000
Capture the variation in the raw counts for 1000 samples, without placing a finger (which gives the peak-to-peak noise) and note the highest noise.
Note: Under Widget selection, enable Swap XY-axes for proper visualization of finger movement on the touchpad.
Figure 23. Noise obtained on the Touchpad View tab in the tuner window
Table 3. Max peak-to-peak noise obtained in CY8CKIT-040T
Kit Max peak-to-peak noise CY8CKIT-040T 173 -
-
-
A finger (6 mm) should be held on the touchpad in the least touch intensity (LTI) position (at the intersection of four nodes) as shown in the following figure.
Figure 24. Least touch intensity (LTI) position
Note: Finger movement during the test can artificially increase the noise level.
-
Go to the Touchpad View tab and change the Display settings as follows:
-
Display mode: Touch Reporting
-
Data type: DiffCount
-
Value type: Current
-
-
Place the finger such that an almost equal signal is obtained in all four intersecting nodes (look at the heat map displayed in the Touchpad View tab as shown in Figure 25).
Note: The LTI signal is measured at the farthest point of the touchpad from the sensor pin connection, where the sensors have the worst-case RC-time constant.
Figure 25. LTI position in touchpad view
LTI Signal = (1145 + 1060 + 1114 + 1183)/4 = 1125
-
Stage 5. Fine-tune sensitivity for 5:1 SNR
The CAPSENSE™ system may be required to work reliably in adverse conditions such as a noisy environment. The touchpad sensors should be tuned with SNR > 5:1 to avoid triggering false touches and to make sure that all intended touches are registered in these adverse conditions.
Note: For gesture detection, it is recommended to have approximately 10:1 SNR.
-
Ensure that the LTI Signal count is greater than 50 and meets at least 5:1 SNR (using Equation 1).
In the CAPSENSE™ Tuner window, increase the Number of sub-conversions (located in the Widget/Sensor Parameters section, under Widget Hardware Parameters) by 10 until you achieve this requirement.
Equation 1: Measuring the SNR
Where,
-
LTI signal is the signal obtained as shown in Figure 25
-
Pk-Pk noise is the peak-to-peak noise obtained as shown in Figure 23
SNR is measured using Equation 1.
Here, from Figure 23 and Figure 25,
SNR = 1125/173 = 6.5
Note: Ensure that the Number of sub-conversions (Nsub) does not exceed the max limit and saturate the raw count.
-
-
Update the number of sub-conversions
-
Update the number of sub-conversions (Nsub) directly in the Widget/Sensor parameters tab of the CAPSENSE™ tuner.
-
CY8CKIT-040T has an in-built CIC2 filter which increases the resolution for the same scan time, see AN234231 - Achieving lowest-power capacitive sensing with PSoC™ 4000T for detailed information on CIC2 filter.
-
Current consumption is directly proportional to number of sub-conversion, therefore decrease the number of sub-conversions to achieve lower current consumption.
Note: Number of sub-conversion should be greater than or equal to 8.
-
Calculate decimation rate using Equation 2. Resolution increases with increase in decimation rate, therefore set the maximum decimation rate.
Equation 2. Decimation rate
Note: Decimation rate should not exceed 255.
-
-
After changing the Number of sub-conversions, click Apply to Device to send the setting to the device. The change is reflected in the graphs.
Note: The Apply to Device option is enabled only when the Number of sub-conversions is changed.
-
If the SNR condition is not achieved even with the maximum number of sub-conversions, enable filters in the General settings (go to the Advanced tab of the CAPSENSE™ configurator). This is generally not required for this kit.
Stage 6: Tune threshold parameters
After confirming that your design meets the timing parameters and power requirements, and the SNR is greater than 5:1, set your threshold parameters.
Note: Thresholds are set based on the LTI position, because it is the least valid touch signal that can be obtained.
Set the recommended threshold values for the Touchpad widget using the LTI signal value obtained in Stage 5:
-
Finger Threshold: 80% of the LTI signal
-
Noise Threshold: Twice the highest noise or 40% of the LTI signal (whichever is greater)
-
Negative Noise Threshold: Twice the highest noise or 40% of the LTI signal (whichever is greater)
-
Hysteresis
Do the following:
-
ON Debounce: 10 (Set to 1 for gesture detection)
-
Low Baseline Reset: Default value of 30
-
Velocity: Default value of 2500
Note: For multiple finger detection, if the velocity value is low, two touches at different positions are considered to be two different finger touches. On the other hand, if it is set at a higher value, it is considered to be the same finger moving to a different position.
Table 4. Software tuning parameters obtained for CY8CKIT-040T
Parameter | CY8CKIT-040T |
---|---|
Number of Sub-conversions | 180 |
Finger threshold | 900 |
Noise threshold | 450 |
Negative noise threshold | 450 |
Low baseline reset | 30 |
Hysteresis | 107 |
ON debounce | 10 |
Velocity | 2500 |
Apply settings to firmware
-
Click Apply to Device and Apply to Project in the CAPSENSE™ Tuner window to apply the settings to the device and project, respectively. Close the tuner.
Figure 27. Apply to Project
## Debugging
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.
Design and implementation
The project contains a touchpad widget configured in CSX-RM Sensing Mode. See the Tuning procedure section for step-by-step instructions to configure the other settings of the CAPSENSE™ configurator.
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.
The ModusToolbox™ software provides a GUI-based tuner application for debugging and tuning the CAPSENSE™ system. The CAPSENSE™ Tuner application works with EZI2C and UART communication interfaces. This project has an SCB block configured in EZI2C mode to establish communication with the onboard KitProg, which in turn enables reading the CAPSENSE™ raw data by the CAPSENSE™ Tuner; see Figure 24.
The CAPSENSE™ data structure that contains the CAPSENSE™ raw data is exposed to the CAPSENSE™ tuner by setting up the I2C communication data buffer with the CAPSENSE™ data structure. This enables the tuner to access the CAPSENSE™ raw data for tuning and debugging CAPSENSE™.
The successful tuning of the touchpad is indicated by the RGB LED in the evaluation kit; the LED1 brightness increases when finger is moved from bottom to up and LED3 brightness increases when finger is moved from left to right on the touchpad.
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 or OFF operation. The three LEDs form a daisy-chain connection and the communication happens over the serial interface to create an RGB configuration. The LED accepts a 32-bit input code, with three bytes for red, green, and blue color, five bits for global brightness, and three blank ‘1’ bits. See the LED datasheet for more details.
Steps to set up the VDDA supply voltage in device configurator
-
Open Device configurator from the Quick panel.
-
Go to the Systems tab, select the Power resource, and set the VDDA value under Operating Conditions as shown in Figure 28.
Figure 28. Setting the VDDA supply in the system tab of device configurator
Resources and settings
See the Operation section for step-by-step instructions to configure the CAPSENSE™ configurator.
Figure 29. Device configurator - EZI2C peripheral parameters
Figure 30. SPI settings
Table 5. Application resources
Resource | Alias/object | Purpose |
---|---|---|
SCB (I2C) (PDL) | CYBSP_EZI2C | EZI2C slave driver to communicate with CAPSENSE™ tuner GUI |
CAPSENSE™ | CYBSP_MSCLP0 | CAPSENSE™ driver to interact with the MSCLP hardware and interface the CAPSENSE™ sensors |
Digital pin | CYBSP_USER_LED | To visualise the touchpad response |
Firmware flow
Figure 31. Firmware flowchart
Related resources
Resources | Links |
---|---|
Application notes | AN79953 – Getting started with PSoC™ 4 AN85951 – PSoC™ 4 and PSoC™ 6 MCU CAPSENSE™ design guide AN234231 - Achieving lowest-power capacitive sensing with PSoC™ 4000T |
Code examples | Using ModusToolbox™ software on GitHub Using PSoC™ Creator |
Device documentation | PSoC™ 4 datasheets PSoC™ 4 technical reference manuals |
Development kits | Select your kits from the evaluation board finder |
Libraries on GitHub | mtb-hal-cat2 – Hardware abstraction layer (HAL) library |
Middleware on GitHub | capsense – CAPSENSE™ library and documents |
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. PSoC™ Creator – IDE for PSoC™ and FM0+ MCU development |
Other resources
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.
Document history
Document title: CE235339 - PSoC™ 4: MSCLP multi-touch mutual-capacitance touchpad tuning
Version | Description of change |
---|---|
1.0.0 | New code example. This version is not backward compatible with ModusToolbox™ software v2.4. |
1.0.1 | Project dependency update. |
1.1.0 | Minor folder structure changes that doesn't break backward compatibility. |
1.2.0 | Minor README and configuration update. |
2.0.0 | Major update to support ModusToolbox™ software v3.1 This version is not backward compatible with ModusToolbox™ software v3.0. |
All other trademarks or registered trademarks referenced herein are the property of their respective owners.
© Cypress Semiconductor Corporation, 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.