X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/1d433d4506113c95285f633e3553ff62d4cfd05d..55aadf97d5d2bd86f2a0c3a53d4608c0cf96471e:/LUFA/Drivers/Board/Temperature.h?ds=inline diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h index 29775b4af..b41c76290 100644 --- a/LUFA/Drivers/Board/Temperature.h +++ b/LUFA/Drivers/Board/Temperature.h @@ -29,13 +29,14 @@ */ /** \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: @@ -52,11 +53,11 @@ * application. * * \code - * // Initialise the ADC and board temperature sensor drivers before first use + * // 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 Celcius + * // Display converted temperature in degrees Celsius * printf("Current Temperature: %d Degrees\r\n", Temperature_GetTemperature()); * \endcode * @@ -67,8 +68,6 @@ #define __TEMPERATURE_H__ /* Includes: */ - #include - #include "../../Common/Common.h" #include "../Peripheral/ADC.h" @@ -77,7 +76,7 @@ #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. + #error The selected board does not contain a compatible temperature sensor. #endif /* Enable C linkage for C++ Compilers: */ @@ -103,7 +102,7 @@ #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