OpenRTX/openrtx/include/core/input.h

81 wiersze
2.9 KiB
C

/***************************************************************************
* Copyright (C) 2020 - 2023 by Federico Amedeo Izzo IU2NUO, *
* Niccolò Izzo IU2KIN, *
* Silvano Seva IU2KWO *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, see <http://www.gnu.org/licenses/> *
***************************************************************************/
#ifndef INPUT_H
#define INPUT_H
#include <interfaces/keyboard.h>
#include <inttypes.h>
#include <stdbool.h>
/**
* Time interval in milliseconds after which a keypress is considered a long-press
*/
static const uint16_t input_longPressTimeout = 700;
/**
* Structure that represents a keyboard event payload
* The maximum size of an event payload is 30 bits
* For a keyboard event we use 1 bit to signal a short or long press
* And the remaining 29 bits to communicate currently pressed keys.
*/
typedef union
{
struct
{
uint32_t long_press : 1,
keys : 29,
_padding : 2;
};
uint32_t value;
}
kbd_msg_t;
/**
* Scan all the keyboard buttons to detect possible keypresses filling a
* keyboard event data structure. The function returns true if a keyboard event
* has been detected.
*
* @param msg: keyboard event message to be filled.
* @return true if a keyboard event has been detected, false otherwise.
*/
bool input_scanKeyboard(kbd_msg_t *msg);
/**
* This function returns true if at least one number is pressed on the
* keyboard.
*
* @param msg: the keyboard queue message
* @return true if at least a number is pressed on the keyboard
*/
bool input_isNumberPressed(kbd_msg_t msg);
/**
* This function returns the smallest number that is pressed on the keyboard,
* 0 if none is pressed.
*
* @param msg: the keyboard queue message
* @return the smalled pressed number on the keyboard
*/
uint8_t input_getPressedNumber(kbd_msg_t msg);
#endif /* INPUT_H */