Skip to content
Permalink
91879bd656
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-capsense-proximity-sensing/README.md

Go to file
 
 
Cannot retrieve contributors at this time
PSoC™ 4: CAPSENSE™ proximity sensing Requirements Supported toolchains (make variable 'TOOLCHAIN') Supported kits (make variable 'TARGET') Hardware setup Software setup Using the code example Create the project Open the project Operation Debugging Design and implementation Operation at custom power supply voltages Resources and settings Related resources Other resources Document history
344 lines (200 sloc) 25.1 KB
Raw Blame

PSoC™ 4: CAPSENSE™ proximity sensing

This code example demonstrates a CAPSENSE™-based proximity sensing design to control the brightness of an onboard LED. It helps to learn how to design a proximity sensor using a PSoC™ 4 device, and see how an approaching hand controls the intensity of an onboard LED. It employs the CAPSENSE™ auto-tuning ability, SmartSense, to tune the proximity sensor for any wire or trace length.

View this README on GitHub.

Provide feedback on this code example.

Requirements

Supported toolchains (make variable 'TOOLCHAIN')

  • GNU Arm® Embedded Compiler v11.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')

Hardware setup

For a few BSPs, this example requires adding an external proximity wire loop to the kit.

  1. CY8CKIT-149, CY8CKIT-145-40XX, and CY8CKIT-045S: Connect a proximity wire loop as shown in Figure 1 to the following respective pins:

    BSP Proximity Loop pin
    CY8CKIT-045S P5.5
    CY8CKIT-145-40XX P2.7
    CY8CKIT-149 P3.7

    Figure 1. Connecting the proximity wire loop to the CY8CKIT-045S kit

  2. CY8CKIT-041-41XX: This kit has an inbuilt proximity loop equipped so the code example uses the board's default configuration.

Software setup

See the ModusToolbox™ tools package installation guide for information about installing and configuring the tools package.

Install a terminal emulator if you don't have one. Instructions in this document use Tera Term.

This example requires no additional software or tools.

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.

Use Project Creator GUI

  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 (locally available at {ModusToolbox™ 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.

    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.

Use Project Creator CLI

The 'project-creator-cli' tool can be used to create applications from a CLI terminal or from within batch files or shell scripts. This tool is available in the {ModusToolbox™ install directory}/tools_{version}/project-creator/ directory.

Use a CLI terminal to invoke the 'project-creator-cli' tool. On Windows, use the command-line 'modus-shell' program provided in the ModusToolbox™ installation instead of a standard Windows command-line application. This shell provides access to all ModusToolbox™ tools. You can access it by typing "modus-shell" in the search box in the Windows menu. In Linux and macOS, you can use any terminal application.

The following example clones the "CAPSENSE™ Proximity Tuning" application with the desired name "CAPSENSE_Proximity_Tuning" configured for the CY8CKIT-045S BSP into the specified working directory, C:/mtb_projects:

project-creator-cli --board-id CY8CKIT-045S --app-id mtb-example-psoc4-capsense-proximity-tuning --user-app-name CAPSENSE_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 field of the BSP manifest Required
--app-id Defined in the field of the CE manifest Required
--target-dir Specify the directory in which the application is to be created if you prefer not to use the default current working directory Optional
--user-app-name Specify the name of the application if you prefer to have a name other than the example's default name Optional

Note: The project-creator-cli tool uses the git 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™ tools package user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf).

Open the project

After the project has been created, you can open it in your preferred development environment.

Eclipse IDE

If you opened the Project Creator tool from the included Eclipse IDE, the project will open in Eclipse automatically.

For more details, see the Eclipse IDE for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_ide_user_guide.pdf).

Visual Studio (VS) Code

Launch VS Code manually, and then open the generated {project-name}.code-workspace file located in the project directory.

For more details, see the Visual Studio Code for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_vscode_user_guide.pdf).

Keil µVision

Double-click the generated {project-name}.cprj file to launch the Keil µVision IDE.

For more details, see the Keil µVision for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_uvision_user_guide.pdf).

IAR Embedded Workbench

Open IAR Embedded Workbench manually, and create a new project. Then select the generated {project-name}.ipcf file located in the project directory.

For more details, see the IAR Embedded Workbench for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_iar_user_guide.pdf).

Command line

If you prefer to use the CLI, open the appropriate terminal, and navigate to the project directory. On Windows, use the command-line 'modus-shell' program; on Linux and macOS, you can use any terminal application. From there, you can run various make commands.

For more details, see the ModusToolbox™ tools package user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf).

Operation

  1. Ensure that the proximity wire loop is connected as mentioned in the Hardware setup section, and make sure that in the CAPSENSE™ Configurator, the CSD tuning mode is in SmartSense (Full Auto-Tune).

    Figure 2. CSD tuning mode in CAPSENSE™ Configurator

  2. Connect the board to your PC using the provided USB cable through the KitProg3 USB connector.

  3. Program the board using one of the following:

    Using Eclipse IDE

    1. Select the application project in the Project Explorer.

    2. In the Quick Panel, scroll down, and click <Application Name> Program (KitProg3_MiniProg4).

    In other IDEs

    Follow the instructions in your preferred IDE.

    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 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

  4. After programming, the application starts automatically.

  5. Move a hand slowly closer to the proximity sensor present on the board or proximity wire loop connected to the board, and confirm that the LED glows brighter.

  6. Now, move a hand slowly away from the proximity sensor present on the board or proximity wire loop connected to the board and observe that the LED gets dimmer.

Monitor Data Using CAPSENSE™ Tuner

  1. Open CAPSENSE™ Tuner from the IDE Quick Panel.

  2. Ensure that the kit is in KitProg3 mode. For more details on how to update the firmware and switch to KitProg3 mode, see Firmware-loader.

  3. In the Tuner application, click Tuner Communication Setup or select Tools > Tuner Communication Setup. In the popup window, select the I2C checkbox under KitProg3 and configure as follows:

         I2C Address: 8
     Sub-address: 2-Bytes
     Speed (kHz): 400

    Figure 3. I2C Tuner Communication Setup

  4. Click Connect or select Communication > Connect.

  5. Click Start or select Communication > Start.

  6. Under the Widget View tab, you can see the proximity widget highlighted in blue color when active. You can also view the sensor data in the Graph View tab as shown in Figure 4.

    Figure 4. Sensor data in Graph View when it is active

  7. The CAPSENSE™ Tuner can also be used for CAPSENSE™ parameter tuning, and measuring signal-to-noise ratio (SNR).

Note: This code example uses SmartSense and Full Auto-Tune. For Manual tuning the CAPSENSE™ Proximity Sensing, see the ModusToolbox™ CAPSENSE™ Tuner guide (Help > View Help) and AN85951 – PSoC™ 4 and PSoC™ 6 MCU CAPSENSE™ design guide for more details on selecting the tuning parameters.

Debugging

You can debug the example to step through the code.

In Eclipse 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™ user guide.

In other IDEs

Follow the instructions in your preferred IDE.

Design and implementation

This code example uses a Proximity Sensor or a Proximity Wire Loop and controls the brightness of the onboard LED depends on the depends on the closeness of a hand (object to be sensed) to the proximity sensor. The LED glows brighter as the hand approaches the proximity sensor and glows dimmer as the hand is taken away from the proximity sensor.

The project uses the CAPSENSE™ middleware (for more details on selecting a middleware, see ModusToolbox™ user guide). For more details on CAPSENSE™ features and usage, see AN85951 – PSoC™ 4 and PSoC™ 6 MCU CAPSENSE™ design guide.

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 on-board KitProg, which in turn enables reading the CAPSENSE™ raw data by the CAPSENSE™ Tuner. The proximity sensor may be tuned using CAPSENSE™ tuner. Once tuned, the new parameters may be applied to project. For more details, see ModusToolbox™ CAPSENSE™ Tuner guide.

Operation at custom power supply voltages

The application is configured to work with the default operating voltage of the kit.

Operating voltages supported by the kits

Kit Supported operating voltages Default operating voltage
CY8CKIT-045S 5.0 V/1.8 V 3.3 V
CY8CKIT-149 5.0 V/1.8 V 5.0 V
CY8CKIT-145-40XX 5.0 V/1.8 V 5.0 V
CY8CKIT-041-41XX 5.0 V/1.8 V 3.3 V

For kits that support multiple operating voltages, the default BSP configuration is provided by the design.modus file should be customized. Do the dollowing to use the example at a custom power supply, such as 3.3 V:

  1. Create a directory at the root of the application to hold any custom BSP configuration files. <application_folder>/templates.

  2. Create a subdirectory for each target that needs to be modified to work at a custom power supply. <application_folder>/templates/TARGET_/config.

  3. Copy the design.modus file and other configuration files (from the path bsp/TARGET_/config) and paste them into the new directory for the target.

  4. Launch the Device Configurator tool using the Quick Panel link in the IDE. This opens the design.modus file from the newly created templates/TARGET_/config folder; and you are now free to customize the configuration as required.

  5. Update the Operating Conditions parameters in Power Settings with the desired voltage as shown in Figure 5 and select File > Save.

    Figure 5. Power settings to work with 3.3 V

  6. Change the jumper/switch setting to operate at 1.8 V/3.3 V/5.0 V for the following kits:

    Kit Jumper/switch
    CY8CKIT-045S J6
    CY8CKIT-041-41XX SW6

    Note: To use custom power supply for CY8CKIT-149 and CY8CKIT-145-40XX kits, use an external power supply connected to VTARG or VDDD within the supported voltage range.

  7. Re-build and program the application to evaluate the application at the new power setting.

Resources and settings

Resource Alias/object Purpose
SCB (I2C) CYBSP_EZI2C EZI2C slave driver to communicate with the CAPSENSE™ Tuner
TCPWM (PWM) CYBSP_PWM PWM controls the brightness of the LED based on proximity sensor
CAPSENSE™ CYBSP_CSD CAPSENSE™ driver to interact with CAPSENSE™ hardware and interface CAPSENSE™ sensors
Digital pins CYBSP_USER_LED To visually indicate the closeness of a hand to the proximity sensor

Related resources

Resources Links
Application notes AN79953 – Getting started with PSoC™ 4
AN85951 – PSoC™ 4 and PSoC™ 6 MCU CAPSENSE™ design guide
Code examples Using ModusToolbox™ on GitHub
Device documentation PSoC™ 4 datasheets
PSoC™ 4 technical reference manuals
Development kits Select your kits from the Evaluation board finder page.
Libraries on GitHub mtb-pdl-cat2 – PSoC™ 4 Peripheral Driver Library (PDL)
mtb-hal-cat2 – Hardware Abstraction Layer (HAL) library
Tools ModusToolbox™ – ModusToolbox™ software is a collection of easy-to-use libraries and tools enabling rapid development with Infineon MCUs for applications from wireless and cloud-connected systems, edge AI/ML, embedded sense and control, to wired USB connectivity using PSoC™ Industrial/IoT MCUs, AIROC™ Wi-Fi and Bluetooth® connectivity devices, XMC™ Industrial MCUs, and EZ-USB™/EZ-PD™ wired connectivity controllers. ModusToolbox™ incorporates a comprehensive set of BSPs, HAL, libraries, configuration tools, and provides support for industry-standard IDEs to fast-track your embedded application 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: CE238477 - PSoC™ 4: CAPSENSE™ proximity sensing

Version Description of change
1.0.0 New code example

All referenced product or service names and trademarks are the property of their respective owners.

The Bluetooth® 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. 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, 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.