Buttons Driver - LUFA/Drivers/Board/Buttons.h
[Board Drivers]

Modules

 ATAVRUSBRF01
 BENITO
 BUMBLEB
 EVK527
 JMDBU2
 STK525
 STK526
 USBKEY
 USBTINYMKII

Functions

static void Buttons_Init (void)
static uint8_t Buttons_GetStatus (void) ATTR_WARN_UNUSED_RESULT

Detailed Description

Module Source Dependencies

The following files must be built with any user project that uses this module:

Description

Hardware buttons driver. This provides an easy to use driver for the hardware buttons present on many boards. It provides a way to easily configure and check the status of all the buttons on the board so that appropriate actions can be taken.

If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project directory. Otherwise, it will include the appropriate built in board driver header file.


Function Documentation

static uint8_t Buttons_GetStatus ( void   )  [inline, static]

Returns a mask indicating which board buttons are currently pressed.

Returns:
Mask indicating which board buttons are currently pressed
static void Buttons_Init ( void   )  [inline, static]

Initializes the BUTTONS driver, so that the current button position can be read. This sets the appropriate I/O pins to an inputs with pull-ups enabled.

This must be called before any Button driver functions are used.

Generated by  doxygen 1.6.3