/** \file * * This file contains special DoxyGen information for the generation of the main page and other special * documentation pages. It is not a project source file. */ /** \mainpage XPLAIN UART Bridge Project * * \section SSec_Compat Project Compatibility: * * The following list indicates what microcontrollers are compatible with this project. * * - AT90USB1287 * * \section SSec_Info USB Information: * * The following table gives a rundown of the USB utilization of this project. * * * * * * * * * * * * * * * * * * * * * * *
USB Mode:Device
USB Class:Communications Device Class (CDC)
USB Subclass:Abstract Control Model (ACM)
Relevant Standards:USBIF CDC Class Standard
Usable Speeds:Full Speed Mode
* * \section SSec_Description Project Description: * * This is a virtual serial port to soft-UART converter, for use on the Atmel XPLAIN boards. This project replaces the firmware * preloaded onto the XPLAIN's onboard AT90USB1287 microcontroller to act as a a UART-to-USB bridge between the device and the * host. When inserted, the device will enumerate as a regular COM port on the host, which can then be opened and data exchanged * between the XMEGA and Host as if the XMEGA was connected directly to the host's serial port. * * After running this project for the first time on a new computer, you will need to supply the .INF file located in this project * project's directory as the device's driver when running under Windows. This will enable Windows to use its inbuilt CDC drivers, * negating the need for custom drivers for the device. Other Operating Systems should automatically use their own inbuilt CDC-ACM * drivers. * * \section SSec_Options Project Options * * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value. * * * * * * * * * * * * *
Define Name:Location:Description:
BUFF_STATICSIZERingBuff.hDefines the maximum number of bytes which can be buffered in each Ring Buffer.
*/