Use the PDI REPEAT instruction in the PDI programmer code to reduce protocol overhead...
[pub/USBasp.git] / LUFA / Drivers / Board / Temperature.h
index db2643c..01727ca 100644 (file)
  */\r
 \r
 /** \ingroup Group_BoardDrivers\r
- *  @defgroup Group_Temperature Temperature Driver - LUFA/Drivers/Board/Temperature.h\r
+ *  @defgroup Group_Temperature Temperature Sensor Driver - LUFA/Drivers/Board/Temperature.h\r
  *\r
  *  \section Sec_Dependencies Module Source Dependencies\r
  *  The following files must be built with any user project that uses this module:\r
  *    - LUFA/Drivers/Board/Temperature.c\r
  *\r
  *  \section Module Description\r
- *  Functions, macros, variables, enums and types related to the control of board temperature sensors.\r
+ *  Temperature sensor driver. This provides an easy to use interface for the hardware temperature sensor located\r
+ *  on many boards. It provides an interface to configure the sensor and appropriate ADC channel, plus read out the\r
+ *  current temperature in degrees C. It is designed for and will only work with the temperature sensor located on the\r
+ *  official Atmel USB AVR boards, as each sensor has different characteristics.\r
  *\r
  *  @{\r
  */\r
@@ -62,7 +65,9 @@
        \r
                #if !defined(BOARD)\r
                        #error BOARD must be set in makefile to a value specified in BoardTypes.h.      \r
-               #elif (BOARD != BOARD_USBKEY) && (BOARD != BOARD_STK525) && (BOARD != BOARD_STK526)\r
+               #elif ((BOARD != BOARD_USBKEY) && (BOARD != BOARD_STK525) && \\r
+                      (BOARD != BOARD_STK526) && (BOARD != BOARD_USER) &&   \\r
+                          (BOARD != BOARD_EVK527))\r
                        #error The selected board does not contain a temperature sensor.\r
                #endif\r
 \r
@@ -87,8 +92,8 @@
                                /** Initializes the temperature sensor driver, including setting up the appropriate ADC channel.\r
                                 *  This must be called before any other temperature sensor routines.\r
                                 *\r
-                                *  The ADC itself (not the ADC channel) must be configured separately before calling the temperature\r
-                                *  sensor functions.\r
+                                *  \note The ADC itself (not the ADC channel) must be configured separately before calling the\r
+                                *        temperature sensor functions.\r
                                 */\r
                                static inline void Temperature_Init(void);\r
                        #else\r