CAF: Click detector module

The click detector module of the Common Application Framework (CAF) is responsible for generating a click_event when one of the known Click types is recorded for the button defined in the module configuration.

Configuration

To use the module, you must enable the following Kconfig options:

• CONFIG_CAF_CLICK_DETECTOR - This option enables the click detector module.

• CONFIG_CAF_BUTTON_EVENTS - This option enables the button_event that is required for the click detector module to work.

In addition to CONFIG_CAF_CLICK_DETECTOR, the following Kconfig options are available for the module:

• CONFIG_CAF_CLICK_DETECTOR_DEF_PATH

• CONFIG_CAF_CLICK_DETECTOR_PM_EVENTS

Adding module configuration file

In addition to setting the Kconfig options, you must also add a module configuration file that contains an array of click_detector_config.

To do so, complete the following steps:

1. Add a file that defines the following information for every key_id that should be handled by the click detector module in an array of click_detector_config:

   • click_detector_config.key_id - ID of the selected key.

   • click_detector_config.consume_button_event - Whether the button_event with the given click_detector_config.key_id should be consumed by the module.

   For example, the file content could look like follows:

   #include <caf/key_id.h>
   #include <caf/click_detector.h>
   
   static const struct click_detector_config click_detector_config[] = {
           {
                   .key_id = KEY_ID(0x00, 0x01),
                   .consume_button_event = false,
           },
   };
   

   Note

   The KEY_ID macro is defined in include/caf/key_id.h.

2. Specify the location of the file with the CONFIG_CAF_CLICK_DETECTOR_DEF_PATH Kconfig option.

Note

The configuration file should be included only by the configured module. Do not include the configuration file in other source files.

Implementation details

Tracing of key states is implemented using a periodically submitted work (k_work_delayable). The work updates the states of traced keys and sends click_event when one of the Click types is recorded. The work is not submitted if there is no key for which the state should be updated.

Click types

Click types refer to the way a button can be pressed. The module records the following click types:

• CLICK_SHORT - Button pressed and released after a short time.

• CLICK_NONE - Button pressed and held for a period of time that is too long for CLICK_SHORT, but too short for CLICK_LONG.

• CLICK_LONG - Button pressed and held for a long period of time.

• CLICK_DOUBLE - Two sequences of the button press and release in a short time interval.

The exact values of time intervals for click types are defined in the subsys/caf/modules/click_detector.c file.

Power management states

If the option CONFIG_CAF_CLICK_DETECTOR_PM_EVENTS is enabled, the module can react to power management events. The module stops tracing of key states when power_down_event is received. The module starts operating again when wake_up_event is received.