KEY_ATY.h File Reference

functions of keys for all embedded device More...

#include "INCLUDE_ATY.h"
#include "HW_GPIO_ATY.h"

Go to the source code of this file.

Macros
#define	MAX_KEY_NUMBER   3
#define	KEY_INDEX_PW   0
#define	KEY_INDEX_UP   1
#define	KEY_INDEX_DOWN   2
#define	KEY_PORT   P2
#define	KEY_AD_Threshold   800
#define	KEY_TYPE_RELASE   0
#define	KEY_TYPE_SINGLE   11
#define	KEY_TYPE_LONG   21
#define	KEY_TYPE_VLONG   22
#define	KEY_TYPE_ACCESS_NEW   0xFF
#define	KEY_RELEASE_DEBOUNCE_TIME   20
#define	KEY_PRESS_DEBOUNCE_TIME   100
#define	KEY_TYPE_LONG_TIME   800
#define	KEY_TYPE_VLONG_TIME   (KEY_TYPE_LONG_TIME * 3)
#define	KEY_ACCESS_NEW(index)

Functions
void	KeyStateMachine (uint8_t keyIndex)
	process key state from IO level
float	KeyStateMachine_AD (uint8_t keyIndex)

Variables
uint8_t	KEY_PIN_GROUP [MAX_KEY_NUMBER]
uint8_t	KEY_PIN_GROUP_AD [MAX_KEY_NUMBER]
uint8_t	lastKeyType [MAX_KEY_NUMBER]
uint8_t	keyExportType [MAX_KEY_NUMBER]
uint16_t	keyScanCount [MAX_KEY_NUMBER]
uint16_t	keyReleaseCount [MAX_KEY_NUMBER]

Detailed Description

functions of keys for all embedded device

Parameters

Project

DEVICE_GENERAL_ATY_LIB

Author

ATY

Copyright

• Copyright 2017 - 2023 MZ-ATY
• This code follows:
  • MZ-ATY Various Contents Joint Statement - https://mengze.top/MZ-ATY_VCJS
  • CC 4.0 BY-NC-SA - https://creativecommons.org/licenses/by-nc-sa/4.0/
• Your use will be deemed to have accepted the terms of this statement.

Version

• 1_01_230514 > ATY
  1. Preliminary version, first Release

Definition in file KEY_ATY.h.

Macro Definition Documentation

KEY_ACCESS_NEW

#define KEY_ACCESS_NEW

(

index

)

Value:

do{ \
    if(lastKeyType[index] != KEY_TYPE_RELASE) \
        lastKeyType[index] = KEY_TYPE_ACCESS_NEW; \
} while(0)

Definition at line 67 of file KEY_ATY.h.

KEY_AD_Threshold

#define KEY_AD_Threshold   800

Definition at line 45 of file KEY_ATY.h.

KEY_INDEX_DOWN

#define KEY_INDEX_DOWN   2

Definition at line 42 of file KEY_ATY.h.

KEY_INDEX_PW

#define KEY_INDEX_PW   0

Definition at line 40 of file KEY_ATY.h.

KEY_INDEX_UP

#define KEY_INDEX_UP   1

Definition at line 41 of file KEY_ATY.h.

KEY_PORT

#define KEY_PORT   P2

Definition at line 44 of file KEY_ATY.h.

KEY_PRESS_DEBOUNCE_TIME

#define KEY_PRESS_DEBOUNCE_TIME   100

Definition at line 58 of file KEY_ATY.h.

KEY_RELEASE_DEBOUNCE_TIME

#define KEY_RELEASE_DEBOUNCE_TIME   20

Definition at line 57 of file KEY_ATY.h.

KEY_TYPE_ACCESS_NEW

#define KEY_TYPE_ACCESS_NEW   0xFF

Definition at line 56 of file KEY_ATY.h.

KEY_TYPE_LONG

#define KEY_TYPE_LONG   21

Definition at line 54 of file KEY_ATY.h.

KEY_TYPE_LONG_TIME

#define KEY_TYPE_LONG_TIME   800

Definition at line 59 of file KEY_ATY.h.

KEY_TYPE_RELASE

#define KEY_TYPE_RELASE   0

Definition at line 52 of file KEY_ATY.h.

KEY_TYPE_SINGLE

#define KEY_TYPE_SINGLE   11

Definition at line 53 of file KEY_ATY.h.

KEY_TYPE_VLONG

#define KEY_TYPE_VLONG   22

Definition at line 55 of file KEY_ATY.h.

KEY_TYPE_VLONG_TIME

#define KEY_TYPE_VLONG_TIME   (KEY_TYPE_LONG_TIME * 3)

Definition at line 60 of file KEY_ATY.h.

MAX_KEY_NUMBER

#define MAX_KEY_NUMBER   3

Definition at line 38 of file KEY_ATY.h.

Function Documentation

KeyStateMachine()

void KeyStateMachine

(

uint8_t

keyIndex

)

process key state from IO level

Parameters

keyIndex

key IO pin to monitor

Note

SINGLE and DOUBLE type need key release to response

Definition at line 50 of file KEY_ATY.c.

{
    // P_SW2 |= 0x80;
    // P2IM0 = 0xE0;
    // P2IM1 = 0xE0;       // high level IT
    // P2INTE = 0xE0;      // 25,26,27 enable IT
    // P_SW2 &= ~0x80;
    // EA = 1;             // enable alla IT
 
    if((KEY_PORT & KEY_PIN_GROUP[keyIndex]) == 0){      // release
        // key debounce, 20ms miss when state machine put at 1ms cycle
        if(keyReleaseCount[keyIndex] > KEY_RELEASE_DEBOUNCE_TIME){
            // key debounce, 100ms miss when state machine put at 1ms cycle
            if(keyScanCount[keyIndex] >= KEY_PRESS_DEBOUNCE_TIME
                && keyScanCount[keyIndex] < KEY_TYPE_LONG_TIME){
                keyExportType[keyIndex] = KEY_TYPE_SINGLE;
                keyScanCount[keyIndex] = 0;
                keyReleaseCount[keyIndex] = 0;
            }
            else{
                // access new key after use last press until last press release
                if(lastKeyType[keyIndex] == KEY_TYPE_ACCESS_NEW)
                    lastKeyType[keyIndex] = 0;
                keyExportType[keyIndex] = KEY_TYPE_RELASE;
                keyScanCount[keyIndex] = 0;
            }
        }
        if(keyReleaseCount[keyIndex] < KEY_RELEASE_DEBOUNCE_TIME * 2)   // 2 margin
            keyReleaseCount[keyIndex]++;
    }
    else{
        if(keyScanCount[keyIndex] < KEY_TYPE_VLONG_TIME * 1.2)          // 1.2 margin
            keyScanCount[keyIndex]++;
        // 1000ms long press
        if(keyScanCount[keyIndex] >= KEY_TYPE_LONG_TIME
            && keyScanCount[keyIndex] < KEY_TYPE_VLONG_TIME){
            keyExportType[keyIndex] = KEY_TYPE_LONG;
        }
        // 2000ms very long press
        else if(keyScanCount[keyIndex] >= KEY_TYPE_VLONG_TIME){
            keyExportType[keyIndex] = KEY_TYPE_VLONG;
        }
    }
 
    if(keyExportType[keyIndex] != KEY_TYPE_RELASE
        && lastKeyType[keyIndex] == 0){
        lastKeyType[keyIndex] = keyExportType[keyIndex];
    }
}

KeyStateMachine_AD()

float KeyStateMachine_AD

(

uint8_t

keyIndex

)

Definition at line 101 of file KEY_ATY.c.

{
    float tempData = ADC_Get(KEY_PIN_GROUP_AD[keyIndex]);
    if(tempData < KEY_AD_Threshold){     // release
        // key debounce, 20ms miss when state machine put at 1ms cycle
        if(keyReleaseCount[keyIndex] > KEY_RELEASE_DEBOUNCE_TIME){
            // key debounce, 100ms miss when state machine put at 1ms cycle
            if(keyScanCount[keyIndex] >= KEY_PRESS_DEBOUNCE_TIME
                && keyScanCount[keyIndex] < KEY_TYPE_LONG_TIME){
                keyExportType[keyIndex] = KEY_TYPE_SINGLE;
                keyScanCount[keyIndex] = 0;
                keyReleaseCount[keyIndex] = 0;
            }
            else{
                // access new key after use last press until last press release
                if(lastKeyType[keyIndex] == KEY_TYPE_ACCESS_NEW)
                    lastKeyType[keyIndex] = 0;
                keyExportType[keyIndex] = KEY_TYPE_RELASE;
                keyScanCount[keyIndex] = 0;
            }
        }
        if(keyReleaseCount[keyIndex] < KEY_RELEASE_DEBOUNCE_TIME * 2)   // 2 margin
            keyReleaseCount[keyIndex]++;
    }
    else{
        if(keyScanCount[keyIndex] < KEY_TYPE_VLONG_TIME * 1.2)          // 1.2 margin
            keyScanCount[keyIndex]++;
        // 1000ms long press
        if(keyScanCount[keyIndex] >= KEY_TYPE_LONG_TIME
            && keyScanCount[keyIndex] < KEY_TYPE_VLONG_TIME){
            keyExportType[keyIndex] = KEY_TYPE_LONG;
        }
        // 2000ms very long press
        else if(keyScanCount[keyIndex] >= KEY_TYPE_VLONG_TIME){
            keyExportType[keyIndex] = KEY_TYPE_VLONG;
        }
    }
 
    if(keyExportType[keyIndex] != KEY_TYPE_RELASE
        && lastKeyType[keyIndex] == 0){
        lastKeyType[keyIndex] = keyExportType[keyIndex];
    }
    return tempData;
}

Variable Documentation

KEY_PIN_GROUP

uint8_t KEY_PIN_GROUP[MAX_KEY_NUMBER]

extern

Definition at line 35 of file KEY_ATY.c.

KEY_PIN_GROUP_AD

uint8_t KEY_PIN_GROUP_AD[MAX_KEY_NUMBER]

extern

Definition at line 36 of file KEY_ATY.c.

keyExportType

uint8_t keyExportType[MAX_KEY_NUMBER]

extern

Definition at line 41 of file KEY_ATY.c.

keyReleaseCount

uint16_t keyReleaseCount[MAX_KEY_NUMBER]

extern

Definition at line 43 of file KEY_ATY.c.

keyScanCount

uint16_t keyScanCount[MAX_KEY_NUMBER]

extern

Definition at line 42 of file KEY_ATY.c.

lastKeyType

uint8_t lastKeyType[MAX_KEY_NUMBER]

extern

Definition at line 40 of file KEY_ATY.c.