X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/cb779e3d7d32d7c43e0a45bb526de0a04135b0c7..0da99447d3e88e83f9977501bee56af5c7aa56c0:/LUFA/Drivers/Board/Temperature.h

diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h
index 8832c0c66..54ca957a6 100644
--- a/LUFA/Drivers/Board/Temperature.h
+++ b/LUFA/Drivers/Board/Temperature.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2012.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -29,24 +29,38 @@
 */
 
 /** \file
- *  \brief Master include file for the board temperature sensor driver.
+ *  \brief NTC Temperature Sensor board hardware driver.
  *
  *  Master include file for the board temperature sensor driver, for the USB boards which contain a temperature sensor.
  */
 
 /** \ingroup Group_BoardDrivers
- *  @defgroup Group_Temperature Temperature Sensor Driver - LUFA/Drivers/Board/Temperature.h
+ *  \defgroup Group_Temperature Temperature Sensor Driver - LUFA/Drivers/Board/Temperature.h
+ *  \brief NTC Temperature Sensor board hardware driver.
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *    - LUFA/Drivers/Board/Temperature.c <i>(Makefile source module name: LUFA_SRC_TEMPERATURE)</i>
  *
- *  \section Module Description
+ *  \section Sec_ModDescription Module Description
  *  Temperature sensor driver. This provides an easy to use interface for the hardware temperature sensor located
  *  on many boards. It provides an interface to configure the sensor and appropriate ADC channel, plus read out the
  *  current temperature in degrees C. It is designed for and will only work with the temperature sensor located on the
  *  official Atmel USB AVR boards, as each sensor has different characteristics.
  *
+ *  \section Sec_ExampleUsage Example Usage
+ *  The following snippet is an example of how this module may be used within a typical
+ *  application.
+ *
+ *  \code
+ *      // Initialize the ADC and board temperature sensor drivers before first use
+ *      ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128);
+ *      Temperature_Init();
+ *      
+ *      // Display converted temperature in degrees Celsius
+ *      printf("Current Temperature: %d Degrees\r\n", Temperature_GetTemperature());
+ *  \endcode
+ *
  *  @{
  */
 
@@ -54,19 +68,23 @@
 #define __TEMPERATURE_H__
 
 	/* Includes: */
-		#include <avr/pgmspace.h>
-
 		#include "../../Common/Common.h"
-		#include "../Peripheral/ADC.h"
 
-		#if (BOARD == BOARD_NONE)
-			#error The Board Temperature Sensor driver cannot be used if the makefile BOARD option is not set.
-		#elif ((BOARD != BOARD_USBKEY) && (BOARD != BOARD_STK525) && \
-		       (BOARD != BOARD_STK526) && (BOARD != BOARD_USER) &&   \
-			   (BOARD != BOARD_EVK527))
-			#error The selected board does not contain a temperature sensor.
+	/* Preprocessor Checks: */
+		#if ((BOARD == BOARD_USBKEY) || (BOARD == BOARD_STK525) || \
+		     (BOARD == BOARD_STK526) || (BOARD == BOARD_EVK527))
+			#define TEMPERATURE_SENSOR_DRIVER_COMPATIBLE
+		#endif
+		
+		#if !defined(__INCLUDE_FROM_TEMPERATURE_C) && !defined(TEMPERATURE_SENSOR_DRIVER_COMPATIBLE)
+			#error The selected board does not contain a compatible temperature sensor.
 		#endif
 
+	#if defined(TEMPERATURE_SENSOR_DRIVER_COMPATIBLE)
+
+	/* Includes: */
+		#include "../Peripheral/ADC.h"
+
 	/* Enable C linkage for C++ Compilers: */
 		#if defined(__cplusplus)
 			extern "C" {
@@ -80,14 +98,17 @@
 			/** ADC channel MUX mask for the temperature sensor. */
 			#define TEMP_ADC_CHANNEL_MASK  ADC_CHANNEL0
 
+			/** Size of the temperature sensor lookup table, in lookup values */
+			#define TEMP_TABLE_SIZE        120
+
 			/** Minimum returnable temperature from the \ref Temperature_GetTemperature() function. */
-			#define TEMP_MIN_TEMP          TEMP_TABLE_OFFSET
+			#define TEMP_MIN_TEMP          TEMP_TABLE_OFFSET_DEGREES
 
 			/** Maximum returnable temperature from the \ref Temperature_GetTemperature() function. */
-			#define TEMP_MAX_TEMP          ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET)
+			#define TEMP_MAX_TEMP          ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET_DEGREES)
 
 		/* Inline Functions: */
-			/** Initialises the temperature sensor driver, including setting up the appropriate ADC channel.
+			/** Initializes the temperature sensor driver, including setting up the appropriate ADC channel.
 			 *  This must be called before any other temperature sensor routines.
 			 *
 			 *  \pre The ADC itself (not the ADC channel) must be configured separately before calling the
@@ -110,8 +131,7 @@
 	/* Private Interface - For use in library only: */
 	#if !defined(__DOXYGEN__)
 		/* Macros: */
-			#define TEMP_TABLE_SIZE   (sizeof(Temperature_Lookup) / sizeof(Temperature_Lookup[0]))
-			#define TEMP_TABLE_OFFSET -21
+			#define TEMP_TABLE_OFFSET_DEGREES   -21
 	#endif
 
 	/* Disable C linkage for C++ Compilers: */
@@ -119,6 +139,8 @@
 			}
 		#endif
 
+	#endif
+	
 #endif
 
 /** @} */