TOP Contributors

  1. MIKROE (2784 codes)
  2. Alcides Ramos (405 codes)
  3. Shawon Shahryiar (307 codes)
  4. jm_palomino (133 codes)
  5. Bugz Bensce (97 codes)
  6. S P (73 codes)
  7. dany (71 codes)
  8. MikroBUS.NET Team (35 codes)
  9. NART SCHINACKOW (34 codes)
  10. Armstrong Subero (27 codes)

Most Downloaded

  1. Timer Calculator (141873 times)
  2. FAT32 Library (75036 times)
  3. Network Ethernet Library (59344 times)
  4. USB Device Library (49346 times)
  5. Network WiFi Library (45153 times)
  6. FT800 Library (44700 times)
  7. GSM click (31300 times)
  8. mikroSDK (30259 times)
  9. microSD click (27684 times)
  10. PID Library (27576 times)
Libstock prefers package manager

Package Manager

We strongly encourage users to use Package manager for sharing their code on Libstock website, because it boosts your efficiency and leaves the end user with no room for error. [more info]

< Back
mikroSDK Library

TouchKey 4 Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.19

mikroSDK Library: 2.0.0.0

Category: Capacitive

Downloaded: 458 times

Not followed.

License: MIT license  

Touch Key 4 Click is a capacitive touch sensing Click board™, with the advanced touch/proximity sensor IC.

No Abuse Reported

Do you want to subscribe in order to receive notifications regarding "TouchKey 4 Click" changes.

Do you want to unsubscribe in order to stop receiving notifications regarding "TouchKey 4 Click" changes.

Do you want to report abuse regarding "TouchKey 4 Click".

  • mikroSDK Library 1.0.0.0
  • Comments (0)

mikroSDK Library Blog


Touch Key 4 Click

Touch Key 4 Click is a capacitive touch sensing Click board™, with the advanced touch/proximity sensor IC. It has three independently configurable channels and can work in several operating modes, including multiple button pattern detection mode, combo mode, press and hold detection mode, power button mode, and more.

touchkey4_click.png

Click Product page


Click library

  • Author : MikroE Team
  • Date : Dec 2019.
  • Type : I2C type

Software Support

We provide a library for the TouchKey4 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for TouchKey4 Click driver.

Standard key functions :

  • Config Object Initialization function.

    void touchkey4_cfg_setup ( touchkey4_cfg_t *cfg );

  • Initialization function.

    TOUCHKEY4_RETVAL touchkey4_init ( touchkey4_t ctx, touchkey4_cfg_t cfg );

  • Click Default Configuration function.

    void touchkey4_default_cfg ( touchkey4_t *ctx );

Example key functions :

  • This function detects touch on sensor inputs and checks is touch detected or released.

    void touchkey4_detect_touch( touchkey4_t ctx, uint8_t input_sens );

  • This function puts device in Active mode and enables desired inputs in Active mode.

    void touchkey4_set_active_mode( touchkey4_t *ctx, const uint8_t analog_gain, const uint8_t en_input1,const uint8_t en_input2, const uint8_t en_input3 );

  • This function puts device in Standby mode and enables desired inputs in Standby mode.

    void touchkey4_set_standby_mode( touchkey4_t *ctx, const uint8_t analog_gain, const uint8_t en_input1, const uint8_t en_input2, const uint8_t en_input3 );

Examples Description

This demo performs touch & release detection functionality of the Click.

The demo application is composed of two sections :

Application Init

Device and driver initialization.


void application_init ( void )
{
    log_cfg_t log_cfg;
    touchkey4_cfg_t cfg;

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, "---- Application Init ----" );

    //  Click initialization.

    touchkey4_cfg_setup( &cfg );
    TOUCHKEY4_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    touchkey4_init( &touchkey4, &cfg );

    Delay_ms ( 1000 );

    touchkey4_default_cfg( &touchkey4 );
    log_info( &logger, "---- Configured and ready ----" );
}

Application Task

Calls function to check touch detection (is interrupt occured) and shows message on USB UART if touch is detected or if touch is released on enabled inputs.


void application_task ( void )
{
    touchkey4_detect_touch( &touchkey4, sensor_results );
    for ( cnt = 0; cnt < 3; cnt++ )
    {
        if ( sensor_results[ cnt ] == 1 )
        {
            if ( cnt == 0 )
            {
                log_info( &logger, "Input 1 is touched\r\n" );
            }
            else if ( cnt == 1 )
            {
                log_info( &logger, "Input 2 is touched\r\n" );
            }
            else
            {
                log_info( &logger, "Input 3 is touched\r\n" );
            }
        }
        else if ( sensor_results[ cnt ] == 2 )
        {
            if ( cnt == 0 )
            {
                log_info( &logger, "Input 1 is released\r\n" );
            }
            else if ( cnt == 1 )
            {
                log_info( &logger, "Input 2 is released\r\n" );
            }
            else
            {
                log_info( &logger, "Input 3 is released\r\n" );
            }
        }
    }
    Delay_ms ( 300 );
} 

Note

TouchKey 4 is configured to work in Combo mode (Active and Standby mode). Input 1 is enabled in Active mode, input 3 is enabled in Standby mode, and input 2 is enabled to work in both modes. In this example the interrupt will be generated when touch is detected and when touch is released. Standby mode should be used when fewer sensor inputs are enabled, and when they are programmed to have more sensitivity. Somethimes it is neccessary to cycle the board power supply if Click doesn't work.

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.TouchKey4

Additional notes and informations

Depending on the development board you are using, you may need USB UART Click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.


ALSO FROM THIS AUTHOR

Magic RFID Click

5

Magic RFID Click is a compact add-on board that contains an embedded RFID module. This board features the M6E-NANO, UHF RFID module with ultra-low power consumption from JADAK.

[Learn More]

Pressure 14 click

5

Pressure 14 Click is a compact add-on board that contains a board-mount pressure sensor. This board features the ABP2LANT060PG2A3XX, a piezoresistive silicon pressure sensor offering a digital output for reading pressure over the specified full-scale pressure span and a temperature range from Honeywell Sensing and Productivity Solutions.

[Learn More]

Buck 19 Click

0

Buck 19 Click is a compact add-on board that steps down the voltage from its input (supply) to its output (load). This board features the STPD01, a programmable synchronous buck converter from STMicroelectronics, providing power supply in applications following USB power delivery specifications. The STPD01 provides the desired voltage levels required by USB power delivery systems (USB PD 3.0) via I2C serial interface up to 60W output power, more precisely voltages in the range of 3V to 20V with a step of 20mV minimum, and currents from 0.1A to 3A with a minimum in steps of 50mA. It also offers advanced protection features such as overvoltage, overcurrent, and overtemperature detections.

[Learn More]