Update manual pages to reference unfinished AVR32 port, add port status to the Future...

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

diff --git a/Projects/TemperatureDataLogger/TemperatureDataLogger.txt b/Projects/TemperatureDataLogger/TemperatureDataLogger.txt
index d31e24f..280c5fe 100644 (file)
--- a/Projects/TemperatureDataLogger/TemperatureDataLogger.txt
+++ b/Projects/TemperatureDataLogger/TemperatureDataLogger.txt
@@ -24,19 +24,22 @@
  *    <td>Device</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>Device</td>\r
  *   </tr>\r
  *   <tr>\r

- *    <td><b>USB Class:</b></td>\r
- *    <td>Mass Storage Device</td>\r
+ *    <td><b>USB Classes:</b></td>\r
+ *    <td>Mass Storage Device \n\r
+ *        Human Interface Device</td>\r

  *   </tr>\r
  *   <tr> \r
  *   </tr>\r
  *   <tr> \r

- *    <td><b>USB Subclass:</b></td>\r
- *    <td>Bulk-Only Transport</td>\r
+ *    <td><b>USB Subclasses:</b></td>\r
+ *    <td>Bulk-Only Transport \n\r
+ *        Keyboard Subclass</td>\r

  *   </tr>\r
  *   <tr>\r
  *    <td><b>Relevant Standards:</b></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
+ *    <td>USBIF Mass Storage Standard \n\r
+ *        USB Bulk-Only Transport Standard \n\r
+ *        SCSI Primary Commands Specification \n\r
+ *        SCSI Block Commands Specification \n\r
+ *        USBIF HID Specification, USBIF HID Usage Tables</td>\r

  *   </tr>\r
  *   <tr>\r
  *    <td><b>Usable Speeds:</b></td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td><b>Usable Speeds:</b></td>\r


@@ -49,14 +52,19 @@
  *  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
  *  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
+ *  device with a single text file, which contains the logged data. Files are named according to the current date when the\r
+ *  logging commences.\r

  *\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
+ *  A DS1307 or compatible RTC IC is designed to be attached to the AVR's TWI bus, for the management of timestamps on the\r
+ *  sampled data. This project will not function correctly if the RTC chip is omitted unless the DUMMY_RTC compile time token\r
+ *  is specified - see \ref SSec_Options.\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
  *\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

+ *  This project uses the FatFS library from ELM Chan (http://elm-chan.org/fsw/ff/00index_e.html) and the .NET HID device library\r
+ *  LibHIDNet (http://sourceforge.net/projects/libhidnet/).\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
  *  \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


@@ -68,16 +76,10 @@
  *    <td><b>Description:</b></td>\r
  *   </tr>\r
  *   <tr>\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
+ *    <td>DUMMY_RTC</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <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\r
+ *        stamp at all times, effectively transforming the project into a basic data logger with no specified sample times.</td>\r

  *   </tr>\r
  *  </table>\r
  */\r
  *   </tr>\r
  *  </table>\r
  */\r