X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/dc68de15b69c2064b1b14d00659aa91054cccbe1..3703d50580c8b9ca3022e22be00b8b261d71bb3c:/Demos/Device/ClassDriver/AudioInput/AudioInput.txt diff --git a/Demos/Device/ClassDriver/AudioInput/AudioInput.txt b/Demos/Device/ClassDriver/AudioInput/AudioInput.txt index 585faec1b..dd3f6e682 100644 --- a/Demos/Device/ClassDriver/AudioInput/AudioInput.txt +++ b/Demos/Device/ClassDriver/AudioInput/AudioInput.txt @@ -1,83 +1,87 @@ -/** \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 Audio Input Device Demo - * - * \section SSec_Compat Demo Compatibility: - * - * The following list indicates what microcontrollers are compatible with this demo. - * - * - Series 7 USB AVRs - * - Series 6 USB AVRs - * - Series 4 USB AVRs - * - * \section SSec_Info USB Information: - * - * The following table gives a rundown of the USB utilization of this demo. - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
USB Mode:Device
USB Class:Audio Class
USB Subclass:Standard Audio Device
Relevant Standards:USBIF Audio Class SpecificationUSBIF Audio Class Terminal Types SpecificationUSBIF Audio Data Formats Specification
Usable Speeds:Full Speed Mode
- * - * \section SSec_Description Project Description: - * - * Audio demonstration application. This gives a simple reference - * application for implementing a USB Audio Input device using the - * basic USB Audio drivers in all modern OSes (i.e. no special drivers - * required). - * - * On start-up the system will automatically enumerate and function - * as a USB microphone. Incoming audio from the ADC channel 1 will - * be sampled and sent to the host computer. - * - * To use, connect a microphone to the ADC channel 1. - * - * Under Windows, if a driver request dialogue pops up, select the option - * to automatically install the appropriate drivers. - * - * \section SSec_Options Project Options - * - * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
Define Name:Location:Description:
MICROPHONE_BIASED_TO_HALF_RAILMakefile CDEFSWhen defined, this alters the demo so that the half VCC bias of the microphone input is subtracted.
AUDIO_SAMPLE_FREQUENCYDescriptors.hGives the audio sample rate per channel for the audio stream, in Hz.
- */ +/** \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 Audio Input Device Demo + * + * \section Sec_Compat Demo Compatibility: + * + * The following list indicates what microcontrollers are compatible with this demo. + * + * - Series 7 USB AVRs (AT90USBxxx7) + * - Series 6 USB AVRs (AT90USBxxx6) + * - Series 4 USB AVRs (ATMEGAxxU4) + * + * \section Sec_Info USB Information: + * + * The following table gives a rundown of the USB utilization of this demo. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
USB Mode:Device
USB Class:Audio Class
USB Subclass:Standard Audio Device
Relevant Standards:USBIF Audio 1.0 Class Specification \n + * USBIF Audio 1.0 Class Terminal Types Specification \n + * USBIF Audio 1.0 Data Formats Specification
Usable Speeds:Full Speed Mode
+ * + * \section Sec_Description Project Description: + * + * Audio demonstration application. This gives a simple reference + * application for implementing a USB Audio Input device using the + * basic USB Audio 1.0 drivers in all modern OSes (i.e. no special drivers + * required). + * + * On start-up the system will automatically enumerate and function as a + * USB microphone. By default, the demo will produce a square wave test tone + * when the board button is pressed. If USE_TEST_TONE is not defined in the + * project makefile, incoming audio from the ADC channel 1 will be sampled + * and sent to the host computer instead. + * + * When in microphone mode, connect a microphone to the ADC channel 2. + * + * Under Windows, if a driver request dialogue pops up, select the option + * to automatically install the appropriate drivers. + * + * \section Sec_Options Project Options + * + * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
Define Name:Location:Description:
USE_TEST_TONEMakefile LUFA_OPTSWhen defined, this alters the demo to produce a square wave test tone when the first board button is pressed + * instead of sampling the board microphone.
MICROPHONE_BIASED_TO_HALF_RAILMakefile LUFA_OPTSWhen defined, this alters the demo so that the half VCC bias of the microphone input is subtracted.
+ */ +