Documents CapSense related enumerated types.
|
| enum | cy_en_capsense_tuner_state_t {
CY_CAPSENSE_TU_FSM_RUNNING = 0x00u,
CY_CAPSENSE_TU_FSM_SUSPENDED = 0x01u,
CY_CAPSENSE_TU_FSM_ONE_SCAN = 0x03u
} |
| | Defines MW Tuner module states. More...
|
| |
| enum | cy_en_capsense_tuner_cmd_t {
CY_CAPSENSE_TU_CMD_NONE_E = 0u,
CY_CAPSENSE_TU_CMD_SUSPEND_E = 1u,
CY_CAPSENSE_TU_CMD_RESUME_E = 2u,
CY_CAPSENSE_TU_CMD_RESTART_E = 3u,
CY_CAPSENSE_TU_CMD_RUN_SNR_TEST_E = 4u,
CY_CAPSENSE_TU_CMD_PING_E = 5u,
CY_CAPSENSE_TU_CMD_ONE_SCAN_E = 6u,
CY_CAPSENSE_TU_CMD_WRITE_E = 7u
} |
| | Defines the Tuner command codes. More...
|
| |
| enum | cy_en_capsense_widget_type_t {
CY_CAPSENSE_WD_BUTTON_E = 0x01u,
CY_CAPSENSE_WD_LINEAR_SLIDER_E = 0x02u,
CY_CAPSENSE_WD_RADIAL_SLIDER_E = 0x03u,
CY_CAPSENSE_WD_MATRIX_BUTTON_E = 0x04u,
CY_CAPSENSE_WD_TOUCHPAD_E = 0x05u,
CY_CAPSENSE_WD_PROXIMITY_E = 0x06u
} |
| | Defines widget types. More...
|
| |
| enum | cy_en_capsense_sensing_method_t {
CY_CAPSENSE_UNDEFINED_E = 0x00u,
CY_CAPSENSE_SENSE_METHOD_CSD_E = 0x01u,
CY_CAPSENSE_SENSE_METHOD_CSX_E = 0x02u
} |
| | Defines sensing methods types. More...
|
| |
| enum | cy_en_capsense_eltd_t {
CY_CAPSENSE_ELTD_TYPE_SELF_E = 0x01u,
CY_CAPSENSE_ELTD_TYPE_MUT_TX_E = 0x02u,
CY_CAPSENSE_ELTD_TYPE_MUT_RX_E = 0x03u
} |
| | Defines types of electrode. More...
|
| |
| enum | cy_en_capsense_cap_connection_t {
CY_CAPSENSE_CMODPAD_E = 0x01u,
CY_CAPSENSE_CTANKPAD_E = 0x02u,
CY_CAPSENSE_CSHIELDPAD_E = 0x03u,
CY_CAPSENSE_VREFEXTPAD_E = 0x04u
} |
| | Defines connections of sensing capacitors. More...
|
| |
| enum | cy_en_capsense_callback_event_t {
CY_CAPSENSE_START_SAMPLE_E = 0x01u,
CY_CAPSENSE_END_OF_SCAN_E = 0x02u
} |
| | Defines CapSense middleware execution events when the CapSense callback can be executed. More...
|
| |
◆ cy_en_capsense_tuner_state_t
Defines MW Tuner module states.
| Enumerator |
|---|
| CY_CAPSENSE_TU_FSM_RUNNING | Running state is a state when CapSense middleware is not blocked by the CapSense Tuner tool and application program continuously scans.
|
| CY_CAPSENSE_TU_FSM_SUSPENDED | Scanning is suspended.
|
| CY_CAPSENSE_TU_FSM_ONE_SCAN | Scanning is suspended after one scan cycle.
|
◆ cy_en_capsense_tuner_cmd_t
Defines the Tuner command codes.
| Enumerator |
|---|
| CY_CAPSENSE_TU_CMD_NONE_E | No command.
|
| CY_CAPSENSE_TU_CMD_SUSPEND_E | Suspend command.
|
| CY_CAPSENSE_TU_CMD_RESUME_E | Resume command switches state from suspend to running.
|
| CY_CAPSENSE_TU_CMD_RESTART_E | Restart command requests to perform CapSense re-initialization.
|
| CY_CAPSENSE_TU_CMD_RUN_SNR_TEST_E | Reserved.
|
| CY_CAPSENSE_TU_CMD_PING_E | Ping command to check whether application program calls Cy_CapSense_RunTuner()
|
| CY_CAPSENSE_TU_CMD_ONE_SCAN_E | Execute one scan cycle and then switch to suspend state.
|
| CY_CAPSENSE_TU_CMD_WRITE_E | Writes specified data with offset into cy_capsense_tuner.
|
◆ cy_en_capsense_widget_type_t
Defines widget types.
| Enumerator |
|---|
| CY_CAPSENSE_WD_BUTTON_E | Button widget.
|
| CY_CAPSENSE_WD_LINEAR_SLIDER_E | Linear Slider widget.
|
| CY_CAPSENSE_WD_RADIAL_SLIDER_E | Radial Slider widget.
|
| CY_CAPSENSE_WD_MATRIX_BUTTON_E | Matrix Buttons widget.
|
| CY_CAPSENSE_WD_TOUCHPAD_E | Touchpad widget.
|
| CY_CAPSENSE_WD_PROXIMITY_E | Proximity widget.
|
◆ cy_en_capsense_sensing_method_t
Defines sensing methods types.
| Enumerator |
|---|
| CY_CAPSENSE_UNDEFINED_E | Undefined method used at initialization or releasing the CSD HW block.
|
| CY_CAPSENSE_SENSE_METHOD_CSD_E | CSD sensing method.
|
| CY_CAPSENSE_SENSE_METHOD_CSX_E | CSX sensing method.
|
◆ cy_en_capsense_eltd_t
Defines types of electrode.
| Enumerator |
|---|
| CY_CAPSENSE_ELTD_TYPE_SELF_E | Electrode used as a sensor in CSD sensing method.
|
| CY_CAPSENSE_ELTD_TYPE_MUT_TX_E | Electrode used as a TX in CSX sensing method.
|
| CY_CAPSENSE_ELTD_TYPE_MUT_RX_E | Electrode used as a RX in CSX sensing method.
|
◆ cy_en_capsense_cap_connection_t
Defines connections of sensing capacitors.
| Enumerator |
|---|
| CY_CAPSENSE_CMODPAD_E | External capacitor is connected to dedicated CMOD pad.
|
| CY_CAPSENSE_CTANKPAD_E | External capacitor is connected to dedicated CSH pad.
|
| CY_CAPSENSE_CSHIELDPAD_E | External capacitor is connected to dedicated SHIELD pad.
|
| CY_CAPSENSE_VREFEXTPAD_E | External capacitor is connected to dedicated VREF pad.
|
◆ cy_en_capsense_callback_event_t
Defines CapSense middleware execution events when the CapSense callback can be executed.
| Enumerator |
|---|
| CY_CAPSENSE_START_SAMPLE_E | Start Sample Callback.
The callback will be executed before each sensor scan triggering
|
| CY_CAPSENSE_END_OF_SCAN_E | End Of Scan Callback.
The callback will be executed when sensor scan is finished and there is no other sensors in the queue to be scanned.
|
