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();

  }

}

Blog: 

Comments

Carlos's picture

Hi,

Any proposed release date for Creator 4.0?

Thanks for the continuous improvement :D

본 사이트의 모든 컨텐츠와 자료는 "있는 그대로" 제공됩니다. CYPRESS SEMICONDUCTOR와 해당 공급자는 그 목적에 관계 없이 이러한 자료의 적합성에 대한 표현을 하지 않으며 상업성, 특정 목적에의 적합성, 권리 및 제3자 지적 재산권의 비침해에 대한 모든 묵시적 보증과 조건을 포함하여(이에 제한되지 않음) 이러한 자료와 관련한 모든 보증과 조건을 부인합니다. CYPRESS SEMICONDUCTOR에서는 명시적 또는 묵시적으로 금반언이나 여타의 다른 방법으로 라이센스를 부여하지 않습니다. 이 사이트의 정보를 사용하려면 제3자의 라이센스 또는 CYPRESS SEMICONDUCTOR에서 제공하는 라이센스가 필요할 수 있습니다.

이 사이트의 컨텐츠에는 특정 사용 지침이나 제한이 포함되거나 그러한 제한이 적용될 수 있습니다. 모든 게시물과 이 사이트 컨텐츠 사용에는 사이트 약관이 적용됩니다. 이 컨텐츠를 사용하는 제3자는 제한 또는 지침을 따르고 이 사이트의 약관을 준수할 것이라는 데 동의합니다. Cypress Semiconductor와 그 공급자는 컨텐츠와 자료, 그 제품, 프로그램 및 서비스를 언제든 수정, 삭제, 개조, 개선, 향상 및 기타 변경하거나 예고 없이 컨텐츠, 제품, 프로그램 또는 서비스를 이동 또는 중단할 수 있는 권리를 보유합니다.