diff options
author | tmk <hasu@tmk-kbd.com> | 2015-05-13 11:13:10 +0900 |
---|---|---|
committer | tmk <hasu@tmk-kbd.com> | 2015-05-13 11:13:10 +0900 |
commit | f1f2066657f4a0998adc016c95d7e541b436e09f (patch) | |
tree | d056cb656b538c4f3a3c205363e0070976655e2e /tmk_core/protocol/lufa/LUFA-git/Demos/Device/LowLevel/AudioInput/AudioInput.txt | |
parent | 1c73e574f109a17566db99e399bdf86007488d2a (diff) | |
parent | f6d56675f9f981c5464f0ca7a1fbb0162154e8c5 (diff) | |
download | firmware-f1f2066657f4a0998adc016c95d7e541b436e09f.tar.gz firmware-f1f2066657f4a0998adc016c95d7e541b436e09f.tar.bz2 firmware-f1f2066657f4a0998adc016c95d7e541b436e09f.zip |
Merge commit 'f6d56675f9f981c5464f0ca7a1fbb0162154e8c5'
Diffstat (limited to 'tmk_core/protocol/lufa/LUFA-git/Demos/Device/LowLevel/AudioInput/AudioInput.txt')
m--------- | tmk_core/protocol/lufa/LUFA-git | 0 | ||||
-rw-r--r-- | tmk_core/protocol/lufa/LUFA-git/Demos/Device/LowLevel/AudioInput/AudioInput.txt | 87 |
2 files changed, 87 insertions, 0 deletions
diff --git a/tmk_core/protocol/lufa/LUFA-git b/tmk_core/protocol/lufa/LUFA-git deleted file mode 160000 -Subproject b6c18b2a7c544653efbe12a1d4e8ba65e7d83c3 diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/LowLevel/AudioInput/AudioInput.txt b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/LowLevel/AudioInput/AudioInput.txt new file mode 100644 index 000000000..9dc6c36b8 --- /dev/null +++ b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/LowLevel/AudioInput/AudioInput.txt @@ -0,0 +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 Sec_Compat Demo Compatibility: + * + * The following list indicates what microcontrollers are compatible with this demo. + * + * \li Series 7 USB AVRs (AT90USBxxx7) + * \li Series 6 USB AVRs (AT90USBxxx6) + * \li Series 4 USB AVRs (ATMEGAxxU4) + * + * \section Sec_Info USB Information: + * + * The following table gives a rundown of the USB utilization of this demo. + * + * <table> + * <tr> + * <td><b>USB Mode:</b></td> + * <td>Device</td> + * </tr> + * <tr> + * <td><b>USB Class:</b></td> + * <td>Audio Class</td> + * </tr> + * <tr> + * <td><b>USB Subclass:</b></td> + * <td>Standard Audio Device</td> + * </tr> + * <tr> + * <td><b>Relevant Standards:</b></td> + * <td>USBIF Audio 1.0 Class Specification \n + * USBIF Audio 1.0 Class Terminal Types Specification \n + * USBIF Audio 1.0 Data Formats Specification</td> + * </tr> + * <tr> + * <td><b>Supported USB Speeds:</b></td> + * <td>Full Speed Mode</td> + * </tr> + * </table> + * + * \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. + * + * <table> + * <tr> + * <th><b>Define Name:</b></th> + * <th><b>Location:</b></th> + * <th><b>Description:</b></th> + * </tr> + * <tr> + * <td>USE_TEST_TONE</td> + * <td>AppConfig.h</td> + * <td>When 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.</td> + * </tr> + * <tr> + * <td>MICROPHONE_BIASED_TO_HALF_RAIL</td> + * <td>AppConfig.h</td> + * <td>When defined, this alters the demo so that the half VCC bias of the microphone input is subtracted.</td> + * </tr> + * </table> + */ + |