Microchip® Advanced Software Framework

common/services/usb/class/hid/device/kbd/example/ui.h File Reference

Common User Interface for HID Keyboard application.

Copyright (c) 2009-2018 Microchip Technology Inc. and its subsidiaries.

Functions

void ui_init (void)
 Initializes the user interface. More...
 
void ui_kbd_led (uint8_t value)
 Turn on or off the keyboard LEDs. More...
 
void ui_powerdown (void)
 Enters the user interface in power down mode. More...
 
void ui_process (uint16_t framenumber)
 This process is called each 1ms It is called only if the USB interface is enabled. More...
 
void ui_wakeup (void)
 Exits the user interface of power down mode. More...
 
void ui_wakeup_disable (void)
 Disables the asynchronous interrupts of the user interface. More...
 
void ui_wakeup_enable (void)
 Enables the asynchronous interrupts of the user interface. More...
 

void ui_init ( void  )

Initializes the user interface.

void ui_kbd_led ( uint8_t  value)

Turn on or off the keyboard LEDs.

void ui_powerdown ( void  )

Enters the user interface in power down mode.

void ui_process ( uint16_t  framenumber)

This process is called each 1ms It is called only if the USB interface is enabled.

Parameters
framenumberCurrent frame number
void ui_wakeup ( void  )

Exits the user interface of power down mode.

void ui_wakeup_disable ( void  )

Disables the asynchronous interrupts of the user interface.

void ui_wakeup_enable ( void  )

Enables the asynchronous interrupts of the user interface.