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 Classes:</b></td>
  28  *    <td>Mass Storage Device</td>
  29  *    <td>Human Interface Device</td>
  30  *   </tr>
  31  *   <tr>
  32  *    <td><b>USB Subclasses:</b></td>
  33  *    <td>Bulk-Only Transport</td>
  34  *    <td>Keyboard Subclass</td>
  35  *   </tr>
  36  *   <tr>
  37  *    <td><b>Relevant Standards:</b></td>
  38  *    <td>USBIF Mass Storage Standard</td>
  39  *    <td>USB Bulk-Only Transport Standard</td>
  40  *    <td>SCSI Primary Commands Specification</td>
  41  *    <td>SCSI Block Commands Specification</td>
  42  *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>
  43  *   </tr>
  44  *   <tr>
  45  *    <td><b>Usable Speeds:</b></td>
  46  *    <td>Full Speed Mode</td>
  47  *   </tr>
  48  *  </table>
  49  *
  50  *  \section SSec_Description Project Description:
  51  *
  52  *  Temperature Data Logger project. This project is a very basic USB data logger for the current temperature as reported by
  53  *  the board's temperature sensor, writing the temperature to a file stored on the board's Dataflash in a FAT filesystem
  54  *  each time a specified interval elapses. When inserted into a PC, the datalogger will appear as a standard USB Mass Storage
  55  *  device with a single text file, which contains the logged data. Files are named according to the current date when the
  56  *  logging commences.
  57  *
  58  *  A DS1307 or compatible RTC IC is designed to be attached to the AVR's TWI bus, for the management of timestamps on the
  59  *  sampled data. This project will not function correctly if the RTC chip is omitted unless the DUMMY_RTC compile time token
  60  *  is specified - see \ref SSec_Options.
  61  *
  62  *  Due to the host's need for exclusive access to the filesystem, the device will not log samples while connected to a host.
  63  *  For the logger to store data, the Dataflash must first be formatted by the host so that it contains a valid FAT filesystem.
  64  *
  65  *  This project uses the FatFS library from ELM Chan (http://elm-chan.org/fsw/ff/00index_e.html) and the .NET HID device library
  66  *  LibHIDNet (http://sourceforge.net/projects/libhidnet/).
  67  *
  68  *  \section SSec_Options Project Options
  69  *
  70  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  71  *
  72  *  <table>
  73  *   <tr>
  74  *    <td><b>Define Name:</b></td>
  75  *    <td><b>Location:</b></td>
  76  *    <td><b>Description:</b></td>
  77  *   </tr>
  78  *   <tr>
  79  *    <td>DUMMY_RTC</td>
  80  *    <td>Makefile CDEFS</td>
  81  *    <td>When a DS1307 RTC chip is not fitted, this token can be defined to make the demo assume a 1/1/1 01:01:01 date/time
  82  *        stamp at all times, effectively transforming the project into a basic data logger with no specified sample times.</td>
  83  *   </tr>
  84  *  </table>
  85  */