X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/208edeee0f97a56697f0b15b519a9e723436f007..e9307382479c0f3ae500e6e8d8b55f7a682c423b:/Projects/TemperatureDataLogger/TemperatureDataLogger.txt diff --git a/Projects/TemperatureDataLogger/TemperatureDataLogger.txt b/Projects/TemperatureDataLogger/TemperatureDataLogger.txt index d31e24f36..136d0385b 100644 --- a/Projects/TemperatureDataLogger/TemperatureDataLogger.txt +++ b/Projects/TemperatureDataLogger/TemperatureDataLogger.txt @@ -1,83 +1,85 @@ -/** \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. - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
USB Mode:Device
USB Class:Mass Storage Device
USB Subclass:Bulk-Only Transport
Relevant Standards:USBIF Mass Storage StandardUSB Bulk-Only Transport StandardSCSI Primary Commands SpecificationSCSI Block Commands Specification
Usable Speeds:Full Speed Mode
- * - * \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. - * - * Currently there is no timestamp associated with the logged data; this project can be extended by the addition of a Real - * Time Clock chip to retain the current time/date which could be stored along with each sample. - * - * 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. - * - * \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. - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
Define Name:Location:Description:
LOG_FILENAMETempDataLogger.hFilename of the log file to write to on the device's FAT filesystem.
LOG_INTERVAL_10MSTempDataLogger.hTime between each data sample, in tens of milliseconds. Each time this period elapses, a - * temperature sample is taken and the result stored to the Dataflash's FAT filesystem. - *
- */ +/** \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. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
USB Mode:Device
USB Classes:Mass Storage Device \n + * Human Interface Device
USB Subclasses:Bulk-Only Transport \n + * Keyboard Subclass
Relevant Standards: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
Usable Speeds:Full Speed Mode
+ * + * \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. + * + * + * + * + * + * + * + * + * + * + * + * + *
Define Name:Location:Description:
DUMMY_RTCMakefile CDEFSWhen 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.
+ */