You are here

Missing API documentation for CapSense_ADC Component | Cypress Semiconductor

Missing API documentation for CapSense_ADC Component

We released a new component in PSoC Creator 3.3 SP2 called “CapSense_ADC”. Unfortunately, the API documentation is missing from the component datasheet.  To get the complete datasheet, please go here. This will be fixed in PSoC Creator 4.0.


The CapSense_ADC component supports the usual widgets such as buttons, matrix buttons, sliders, touchpads, and proximity sensors with the bonus of added analog-to-digital converter (ADC) functionality.  It has a new, easier-to-use interface as well.

One thing to note - The CapSense_P4 component is not an update of the CapSense_CSD_P4 component, which is still shipped with PSoC Creator so that existing projects will continue to work. It is completely new, with a more streamlined Customizer GUI and very different firmware API philosophy. If you are working on a project with the older component, we recommend backing up your design before replacing the component in your schematic.

The firmware changes are documented in the component datasheet in the Migration Guide section. Some notable changes are as follows.

  • The CapSense_Start() function automatically initializes the tuner interface and baselines so that, for example, there is no need to call the CapSense_InitializeAllBaselines() function.
  • Low power operation is improved with the use of a single function, CapSense_ProcessAllWidgets(), to read all results of a scan in one action.
  • Baselines are automatically updated in CapSense_ProcessAllWidgets() so there is no need to call the CapSense_UpdateEnabledBaselines() function.
  • The widget interrogation functions, such as CapSense_CheckIsWidgetActive(), are replaced by new functions, such as CapSense_IsWidgetActive(), that only look at the processed data.
  • The macros for each widget have new naming formats. For example, a single button widget would default to CapSense_BUTTON0_WDGT_ID instead of CapSense_BUTTON0__BTN with that annoying double underscore.
  • The tuner is enabled with just a single function, Capsense_RunTuner(), which no longer blocks the application.

Here is some example code to highlight the differences in the approach to a single button implementation.

CapSense_P4 (v3.0)  CapSense_CSD_P4 (v2.40)

CyGlobalIntEnable;

CapSense_Start();

CapSense_ScanAllWidgets();

for(;;)

{

  if( CapSense_NOT_BUSY == CapSense_IsBusy() )

  {

    CapSense_ProcessAllWidgets();

    if ( CapSense_IsWidgetActive(CapSense_BUTTON0_WDGT_ID) )

    {

      /* Do something */

    }

    CapSense_ScanAllWidgets();

  }

}

CyGlobalIntEnable;

CapSense_Start();

CapSense_InitializeAllBaselines();

CapSense_ScanEnabledWidgets();

for(;;)

{

  if( CapSense_NOT_BUSY == CapSense_IsBusy() )

  {

    if ( CapSense_CheckIsWidgetActive( CapSense_BUTTON0__BTN ) )

    {

      /* Do something */

    }

    CapSense_UpdateEnabledBaselines();

    CapSense_ScanEnabledWidgets();

  }

}

Comments

Carlos's picture

Hi,

Any proposed release date for Creator 4.0?

Thanks for the continuous improvement :D

jordanss123 jordanss123's picture

fake yeezy boost 350 Thanks for providing such a nice article and now i am searching for clash royale ios cheats to hack clash royale gems and golds so that i play clash royale game freely.

 

ALL CONTENT AND MATERIALS ON THIS SITE ARE PROVIDED "AS IS". CYPRESS SEMICONDUCTOR AND ITS RESPECTIVE SUPPLIERS MAKE NO REPRESENTATIONS ABOUT THE SUITABILITY OF THESE MATERIALS FOR ANY PURPOSE AND DISCLAIM ALL WARRANTIES AND CONDITIONS WITH REGARD TO THESE MATERIALS, INCLUDING BUT NOT LIMITED TO, ALL IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT OF ANY THIRD PARTY INTELLECTUAL PROPERTY RIGHT. NO LICENSE, EITHER EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, IS GRANTED BY CYPRESS SEMICONDUCTOR. USE OF THE INFORMATION ON THIS SITE MAY REQUIRE A LICENSE FROM A THIRD PARTY, OR A LICENSE FROM CYPRESS SEMICONDUCTOR.

Content on this site may contain or be subject to specific guidelines or limitations on use. All postings and use of the content on this site are subject to the Terms and Conditions of the site; third parties using this content agree to abide by any limitations or guidelines and to comply with the Terms and Conditions of this site. Cypress Semiconductor and its suppliers reserve the right to make corrections, deletions, modifications, enhancements, improvements and other changes to the content and materials, its products, programs and services at any time or to move or discontinue any content, products, programs, or services without notice.