diff options
Diffstat (limited to 'LUFA/Drivers/Board/Temperature.h')
| -rw-r--r-- | LUFA/Drivers/Board/Temperature.h | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h index 8832c0c66..c8b36f586 100644 --- a/LUFA/Drivers/Board/Temperature.h +++ b/LUFA/Drivers/Board/Temperature.h @@ -47,6 +47,16 @@ * 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. * + * <b>Example Usage:</b> + * \code + * // Initialise 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 + * printf("Current Temperature: %d Degrees\r\n", Temperature_GetTemperature()); + * \endcode + * * @{ */ @@ -110,8 +120,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: */ |