Add new TemperatureDataLogger project, a simple USB Mass Storage class Temperature...

[pub/lufa.git] / Projects / TemperatureDataLogger / TemperatureDataLogger.txt

diff --git a/Projects/TemperatureDataLogger/TemperatureDataLogger.txt b/Projects/TemperatureDataLogger/TemperatureDataLogger.txt
new file mode 100644 (file)
index 0000000..d31e24f
--- /dev/null
+++ b/Projects/TemperatureDataLogger/TemperatureDataLogger.txt
@@ -0,0 +1,83 @@
+/** \file\r
+ *\r
+ *  This file contains special DoxyGen information for the generation of the main page and other special\r
+ *  documentation pages. It is not a project source file.\r
+ */\r
+ \r
+/** \mainpage Temperature Datalogger Project\r
+ *\r
+ *  \section SSec_Compat Demo Compatibility:\r
+ *\r
+ *  The following list indicates what microcontrollers are compatible with this demo.\r
+ *\r
+ *  - Series 7 USB AVRs\r
+ *  - Series 6 USB AVRs\r
+ *  - Series 4 USB AVRs (with >16KB of FLASH)\r
+ *\r
+ *  \section SSec_Info USB Information:\r
+ *\r
+ *  The following table gives a rundown of the USB utilization of this demo.\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>USB Mode:</b></td>\r
+ *    <td>Device</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>USB Class:</b></td>\r
+ *    <td>Mass Storage Device</td>\r
+ *   </tr>\r
+ *   <tr> \r
+ *    <td><b>USB Subclass:</b></td>\r
+ *    <td>Bulk-Only Transport</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Relevant Standards:</b></td>\r
+ *    <td>USBIF Mass Storage Standard</td>\r
+ *    <td>USB Bulk-Only Transport Standard</td>\r
+ *    <td>SCSI Primary Commands Specification</td>\r
+ *    <td>SCSI Block Commands Specification</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Usable Speeds:</b></td>\r
+ *    <td>Full Speed Mode</td>\r
+ *   </tr>\r
+ *  </table>\r
+ *\r
+ *  \section SSec_Description Project Description: \r
+ *\r
+ *  Temperature Data Logger project. This project is a very basic USB data logger for the current temperature as reported by\r
+ *  the board's temperature sensor, writing the temperature to a file stored on the board's Dataflash in a FAT filesystem\r
+ *  each time a specified interval elapses. When inserted into a PC, the datalogger will appear as a standard USB Mass Storage\r
+ *  device with a single text file, which contains the logged data.\r
+ *\r
+ *  Currently there is no timestamp associated with the logged data; this project can be extended by the addition of a Real\r
+ *  Time Clock chip to retain the current time/date which could be stored along with each sample.\r
+ *\r
+ *  Due to the host's need for exclusive access to the filesystem, the device will not log samples while connected to a host.\r
+ *  For the logger to store data, the Dataflash must first be formatted by the host so that it contains a valid FAT filesystem.\r
+ *\r
+ *  \section SSec_Options Project Options\r
+ *\r
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>Define Name:</b></td>\r
+ *    <td><b>Location:</b></td>\r
+ *    <td><b>Description:</b></td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>LOG_FILENAME</td>\r
+ *    <td>TempDataLogger.h</td>\r
+ *    <td>Filename of the log file to write to on the device's FAT filesystem.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>LOG_INTERVAL_10MS</td>\r
+ *    <td>TempDataLogger.h</td>\r
+ *    <td>Time between each data sample, in tens of milliseconds. Each time this period elapses, a\r
+ *        temperature sample is taken and the result stored to the Dataflash's FAT filesystem.\r
+ *    </td>\r
+ *   </tr>\r
+ *  </table>\r
+ */\r