Projects/TemperatureDataLogger/TemperatureDataLogger.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \mainpage Temperature Datalogger Project
   8  *
   9  *  \section SSec_Compat Demo Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  - Series 7 USB AVRs
  14  *  - Series 6 USB AVRs
  15  *  - Series 4 USB AVRs (with >16KB of FLASH)
  16  *
  17  *  \section SSec_Info USB Information:
  18  *
  19  *  The following table gives a rundown of the USB utilization of this demo.
  20  *
  21  *  <table>
  22  *   <tr>
  23  *    <td><b>USB Mode:</b></td>
  24  *    <td>Device</td>
  25  *   </tr>
  26  *   <tr>
  27  *    <td><b>USB Class:</b></td>
  28  *    <td>Mass Storage Device</td>
  29  *   </tr>
  30  *   <tr>
  31  *    <td><b>USB Subclass:</b></td>
  32  *    <td>Bulk-Only Transport</td>
  33  *   </tr>
  34  *   <tr>
  35  *    <td><b>Relevant Standards:</b></td>
  36  *    <td>USBIF Mass Storage Standard</td>
  37  *    <td>USB Bulk-Only Transport Standard</td>
  38  *    <td>SCSI Primary Commands Specification</td>
  39  *    <td>SCSI Block Commands Specification</td>
  40  *   </tr>
  41  *   <tr>
  42  *    <td><b>Usable Speeds:</b></td>
  43  *    <td>Full Speed Mode</td>
  44  *   </tr>
  45  *  </table>
  46  *
  47  *  \section SSec_Description Project Description:
  48  *
  49  *  Temperature Data Logger project. This project is a very basic USB data logger for the current temperature as reported by
  50  *  the board's temperature sensor, writing the temperature to a file stored on the board's Dataflash in a FAT filesystem
  51  *  each time a specified interval elapses. When inserted into a PC, the datalogger will appear as a standard USB Mass Storage
  52  *  device with a single text file, which contains the logged data.
  53  *
  54  *  Currently there is no timestamp associated with the logged data; this project can be extended by the addition of a Real
  55  *  Time Clock chip to retain the current time/date which could be stored along with each sample.
  56  *
  57  *  Due to the host's need for exclusive access to the filesystem, the device will not log samples while connected to a host.
  58  *  For the logger to store data, the Dataflash must first be formatted by the host so that it contains a valid FAT filesystem.
  59  *
  60  *  \section SSec_Options Project Options
  61  *
  62  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  63  *
  64  *  <table>
  65  *   <tr>
  66  *    <td><b>Define Name:</b></td>
  67  *    <td><b>Location:</b></td>
  68  *    <td><b>Description:</b></td>
  69  *   </tr>
  70  *   <tr>
  71  *    <td>LOG_FILENAME</td>
  72  *    <td>TempDataLogger.h</td>
  73  *    <td>Filename of the log file to write to on the device's FAT filesystem.</td>
  74  *   </tr>
  75  *   <tr>
  76  *    <td>LOG_INTERVAL_10MS</td>
  77  *    <td>TempDataLogger.h</td>
  78  *    <td>Time between each data sample, in tens of milliseconds. Each time this period elapses, a
  79  *        temperature sample is taken and the result stored to the Dataflash's FAT filesystem.
  80  *    </td>
  81  *   </tr>
  82  *  </table>
  83  */