Add svn:eol-style property to source files, so that the line endings are correctly...
[pub/lufa.git] / Projects / TemperatureDataLogger / TemperatureDataLogger.txt
index 280c5fe..136d038 100644 (file)
@@ -1,85 +1,85 @@
-/** \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 Classes:</b></td>\r
- *    <td>Mass Storage Device \n\r
- *        Human Interface Device</td>\r
- *   </tr>\r
- *   <tr> \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
- *    <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
- *    <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. Files are named according to the current date when the\r
- *  logging commences.\r
- *\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
- *  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
- *\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>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
+/** \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 Temperature Datalogger Project
+ *
+ *  \section SSec_Compat Demo Compatibility:
+ *
+ *  The following list indicates what microcontrollers are compatible with this demo.
+ *
+ *  - Series 7 USB AVRs
+ *  - Series 6 USB AVRs
+ *  - Series 4 USB AVRs (with >16KB of FLASH)
+ *
+ *  \section SSec_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 Classes:</b></td>
+ *    <td>Mass Storage Device \n
+ *        Human Interface Device</td>
+ *   </tr>
+ *   <tr> 
+ *    <td><b>USB Subclasses:</b></td>
+ *    <td>Bulk-Only Transport \n
+ *        Keyboard Subclass</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Relevant Standards:</b></td>
+ *    <td>USBIF Mass Storage Standard \n
+ *        USB Bulk-Only Transport Standard \n
+ *        SCSI Primary Commands Specification \n
+ *        SCSI Block Commands Specification \n
+ *        USBIF HID Specification, USBIF HID Usage Tables</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Usable Speeds:</b></td>
+ *    <td>Full Speed Mode</td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section SSec_Description Project Description: 
+ *
+ *  Temperature Data Logger project. This project is a very basic USB data logger for the current temperature as reported by
+ *  the board's temperature sensor, writing the temperature to a file stored on the board's Dataflash in a FAT filesystem
+ *  each time a specified interval elapses. When inserted into a PC, the datalogger will appear as a standard USB Mass Storage
+ *  device with a single text file, which contains the logged data. Files are named according to the current date when the
+ *  logging commences.
+ *
+ *  A DS1307 or compatible RTC IC is designed to be attached to the AVR's TWI bus, for the management of timestamps on the
+ *  sampled data. This project will not function correctly if the RTC chip is omitted unless the DUMMY_RTC compile time token
+ *  is specified - see \ref SSec_Options.
+ *
+ *  Due to the host's need for exclusive access to the filesystem, the device will not log samples while connected to a host.
+ *  For the logger to store data, the Dataflash must first be formatted by the host so that it contains a valid FAT filesystem.
+ *
+ *  This project uses the FatFS library from ELM Chan (http://elm-chan.org/fsw/ff/00index_e.html) and the .NET HID device library
+ *  LibHIDNet (http://sourceforge.net/projects/libhidnet/).
+ *
+ *  \section SSec_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>
+ *    <td><b>Define Name:</b></td>
+ *    <td><b>Location:</b></td>
+ *    <td><b>Description:</b></td>
+ *   </tr>
+ *   <tr>
+ *    <td>DUMMY_RTC</td>
+ *    <td>Makefile CDEFS</td>
+ *    <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
+ *        stamp at all times, effectively transforming the project into a basic data logger with no specified sample times.</td>
+ *   </tr>
+ *  </table>
+ */