Files
hsb/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/KeyboardDevice.h
dvl cfb55967c7 Doxygen update
git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@428 05563f52-14a8-4384-a975-3d1654cca0fa
2018-01-15 11:40:43 +00:00

87 lines
2.4 KiB
C

// -----------------------------------------------------------------------------
/// @file KeyboardDevice.h
/// @brief File description
// -----------------------------------------------------------------------------
// Micro-Key bv
// Industrieweg 28, 9804 TG Noordhorn
// Postbus 92, 9800 AB Zuidhorn
// The Netherlands
// Tel: +31 594 503020
// Fax: +31 594 505825
// Email: support@microkey.nl
// Web: www.microkey.nl
// -----------------------------------------------------------------------------
/// $Revision$
/// $Author$
/// $Date$
// (c) 2015 Micro-Key bv
// -----------------------------------------------------------------------------
/**
* %KeyboardDevice implementation
* \defgroup KeyboardDevice Package KeyboardDevice
* \ingroup HAL
* @{
*/
#ifndef INC_KEYBOARDDEVICE_H_
#define INC_KEYBOARDDEVICE_H_
// -----------------------------------------------------------------------------
// Include files
// -----------------------------------------------------------------------------
#include <stdbool.h>
#include "stm32f10x.h"
#include "keypadMatrix.h"
// -----------------------------------------------------------------------------
// Constant and macro definitions
// -----------------------------------------------------------------------------
// -----------------------------------------------------------------------------
// Type definitions.
// -----------------------------------------------------------------------------
struct KeyboardDevice;
typedef ErrorStatus (*KeyboardReadFunction)(const struct KeyboardDevice* self, char* buffer, Keypad_KeyState* keyState);
struct KeyboardDeviceParameters
{
int numberOfKeys;
};
struct KeyboardDevice
{
KeyboardReadFunction _read;
struct KeyboardDeviceParameters parameters;
bool initialized;
};
// -----------------------------------------------------------------------------
// Function declarations
// -----------------------------------------------------------------------------
/**
* \memberof KeyboardDevice
*/
extern ErrorStatus KeyboardDevice_construct (struct KeyboardDevice* self, struct KeyboardDeviceParameters* parameters, KeyboardReadFunction read);
/**
* \memberof KeyboardDevice
*/
extern ErrorStatus KeyboardDevice_read(const struct KeyboardDevice* self, char* buffer, Keypad_KeyState* keyState);
#endif /* INC_KEYBOARDDEVICE_H_ */
/** @} */