Cypress CapSense Middleware Library
cy_stc_capsense_common_context_t Struct Reference

Description

Declares top-level Context Data Structure.

Data Fields

uint16_t configId
 16-bit CRC calculated by the CapSense Configurator tool for the CapSense configuration. More...
 
uint16_t tunerCmd
 Tuner Command Register cy_en_capsense_tuner_cmd_t. More...
 
uint16_t scanCounter
 This counter increments after each scan. More...
 
uint8_t tunerSt
 State of CapSense middleware tuner module. More...
 
uint8_t initDone
 Keep information whether initialization was done or not.
 
cy_capsense_callback_t ptrSSCallback
 Pointer to a user's Start Sample callback function. More...
 
cy_capsense_callback_t ptrEOSCallback
 Pointer to a user's End Of Scan callback function. More...
 
cy_capsense_tuner_send_callback_t ptrTunerSendCallback
 Pointer to a user's tuner callback function. More...
 
cy_capsense_tuner_receive_callback_t ptrTunerReceiveCallback
 Pointer to a user's tuner callback function. More...
 
volatile uint32_t status
 Middleware status information, scan in progress or not.
 
uint32_t timestampInterval
 Timestamp interval used at increasing the timestamp by Cy_CapSense_IncrementGestureTimestamp()
 
uint32_t timestamp
 Current timestamp should be kept updated and operational, which is vital for the operation of Gesture and Ballistic multiplier features.
 
uint8_t modCsdClk
 The modulator clock divider for the CSD widgets.
 
uint8_t modCsxClk
 The modulator clock divider for the CSX widgets.
 
uint8_t tunerCnt
 Command counter of CapSense middleware tuner module.
 

Field Documentation

◆ configId

uint16_t cy_stc_capsense_common_context_t::configId

16-bit CRC calculated by the CapSense Configurator tool for the CapSense configuration.

Used by the CapSense Tuner tool to identify if the FW corresponds to the specific user configuration.

◆ tunerCmd

uint16_t cy_stc_capsense_common_context_t::tunerCmd

Tuner Command Register cy_en_capsense_tuner_cmd_t.

Used for the communication between the CapSense Tuner tool and the middleware

◆ scanCounter

uint16_t cy_stc_capsense_common_context_t::scanCounter

This counter increments after each scan.

◆ tunerSt

uint8_t cy_stc_capsense_common_context_t::tunerSt

State of CapSense middleware tuner module.

cy_en_capsense_tuner_state_t

◆ ptrSSCallback

cy_capsense_callback_t cy_stc_capsense_common_context_t::ptrSSCallback

Pointer to a user's Start Sample callback function.

Refer to Callbacks section

◆ ptrEOSCallback

cy_capsense_callback_t cy_stc_capsense_common_context_t::ptrEOSCallback

Pointer to a user's End Of Scan callback function.

Refer to Callbacks section

◆ ptrTunerSendCallback

cy_capsense_tuner_send_callback_t cy_stc_capsense_common_context_t::ptrTunerSendCallback

Pointer to a user's tuner callback function.

Refer to Callbacks section

◆ ptrTunerReceiveCallback

cy_capsense_tuner_receive_callback_t cy_stc_capsense_common_context_t::ptrTunerReceiveCallback

Pointer to a user's tuner callback function.

Refer to Callbacks section