Atmel Software Framework

services/usb/class/vendor/device/example/ui.h File Reference

Common User Interface for USB vendor class application.

Copyright (c) 2014-2015 Atmel Corporation. All rights reserved.

Functions

void ui_init (void)
 Initializes the user interface. More...
 
void ui_loop_back_state (bool b_started)
 Notify the state of loopback It is called when a the loopback is started and stopped. 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_init ( void  )

Initializes the user interface.

Initializes the user interface.

void ui_loop_back_state ( bool  b_started)

Notify the state of loopback It is called when a the loopback is started and stopped.

Parameters
b_startedloopback started if true, else stopped

Referenced by main_setup_in_received(), main_setup_out_received(), main_vendor_bulk_in_received(), main_vendor_bulk_out_received(), main_vendor_int_in_received(), main_vendor_int_out_received(), main_vendor_iso_in_received(), and main_vendor_iso_out_received().

void ui_powerdown ( void  )

Enters the user interface in power down mode.

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

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

This function processes user touch events and updates the display.

The first registered touch is used to control the cursor. Its presence is indicated with a red frame around the display. When the cursor touch moves, its movement is visualized with a trace on the display.

The second registered touch is used to control mouse buttons, and is indicated with an inner frame of which the color depends on which side the touch is for: blue for left and green for right button click. The frame is shown until the touch is released. To detect which side click it is, the position relative to the cursor touch is used, i.e., a touch to the left of the first touch will cause a left mouse click.

Parameters
framenumberCurrent USB frame number
Note
This function should be called every millisecond, e.g., for each USB frame.
void ui_wakeup ( void  )

Exits the user interface of power down mode.

Exits the user interface of power down mode.