Temperature Sensor Driver - LUFA/Drivers/Board/Temperature.h
[Board Drivers]

Defines

#define TEMP_ADC_CHANNEL   0
#define TEMP_MIN_TEMP   TEMP_TABLE_OFFSET
#define TEMP_MAX_TEMP   ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET)

Functions

static void Temperature_Init (void)
int8_t Temperature_GetTemperature (void) ATTR_WARN_UNUSED_RESULT

Detailed Description

Module Source Dependencies

The following files must be built with any user project that uses this 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.


Define Documentation

#define TEMP_ADC_CHANNEL   0

ADC channel number for the temperature sensor.

#define TEMP_MAX_TEMP   ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET)

Maximum returnable temperature from the Temperature_GetTemperature() function.

#define TEMP_MIN_TEMP   TEMP_TABLE_OFFSET

Minimum returnable temperature from the Temperature_GetTemperature() function.


Function Documentation

int8_t Temperature_GetTemperature ( void   ) 

Performs a complete ADC on the temperature sensor channel, and converts the result into a valid temperature between TEMP_MIN_TEMP and TEMP_MAX_TEMP in degrees Celsius.

Returns:
Signed temperature in degrees Celsius
static void Temperature_Init ( void   )  [inline, static]

Initializes the temperature sensor driver, including setting up the appropriate ADC channel. This must be called before any other temperature sensor routines.

The ADC itself (not the ADC channel) must be configured separately before calling the temperature sensor functions.


Generated on Sun Nov 22 16:00:11 2009 for LUFA (Formerly MyUSB) Library by  doxygen 1.6.1