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

Common User Interface for CDC application.

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

Functions
void	ui_com_close (uint8_t port)
	Called when communication port is closed. More...
void	ui_com_error (void)
	Called when a communication error occur. More...
void	ui_com_open (uint8_t port)
	Called when communication port is opened. More...
void	ui_com_overflow (void)
	Called when a overflow occur. More...
void	ui_com_rx_start (void)
	Called when a data is received on CDC. More...
void	ui_com_rx_stop (void)
	Called when all data pending are sent on port com. More...
void	ui_com_tx_start (void)
	Called when a data is received on port com. More...
void	ui_com_tx_stop (void)
	Called when all data pending are sent on CDC. More...
void	ui_init (void)
	Initializes the user interface. 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_com_close

(

uint8_t

port

)

Called when communication port is closed.

Referenced by main_cdc_set_dtr().

void ui_com_error

(

void

)

Called when a communication error occur.

Referenced by ISR().

void ui_com_open

(

uint8_t

port

)

Called when communication port is opened.

Referenced by main_cdc_set_dtr().

void ui_com_overflow

(

void

)

Called when a overflow occur.

Referenced by ISR().

void ui_com_rx_start

(

void

)

Called when a data is received on CDC.

Referenced by ISR().

void ui_com_rx_stop

(

void

)

Called when all data pending are sent on port com.

Referenced by ISR().

void ui_com_tx_start

(

void

)

Called when a data is received on port com.

Referenced by ISR().

void ui_com_tx_stop

(

void

)

Called when all data pending are sent on CDC.

Referenced by ISR().

void ui_init

(

void

)

Initializes the user interface.

Initializes the user interface.

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

framenumber

Current 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

framenumber

Current 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.