Temperature.h 4.84 KB
Newer Older
1
2
3
/*
             LUFA Library
     Copyright (C) Dean Camera, 2010.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
10
11
*/

/*
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)

12
  Permission to use, copy, modify, distribute, and sell this
13
  software and its documentation for any purpose is hereby granted
14
  without fee, provided that the above copyright notice appear in
15
  all copies and that both that the copyright notice and this
16
17
18
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *  \brief Master include file for the board temperature sensor driver.
 *
34
 *  Master include file for the board temperature sensor driver, for the USB boards which contain a temperature sensor.
35
36
37
38
39
40
41
 */

/** \ingroup Group_BoardDrivers
 *  @defgroup Group_Temperature Temperature Sensor Driver - LUFA/Drivers/Board/Temperature.h
 *
 *  \section Sec_Dependencies Module Source Dependencies
 *  The following files must be built with any user project that uses this module:
42
 *    - LUFA/Drivers/Board/Temperature.c <i>(Makefile source module name: LUFA_SRC_TEMPERATURE)</i>
43
44
45
46
47
48
49
 *
 *  \section 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.
 *
50
51
52
53
54
55
56
57
58
59
 *  <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
 * 
60
61
62
63
64
65
66
67
68
69
70
 *  @{
 */

#ifndef __TEMPERATURE_H__
#define __TEMPERATURE_H__

	/* Includes: */
		#include <avr/pgmspace.h>

		#include "../../Common/Common.h"
		#include "../Peripheral/ADC.h"
71

72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
		#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.
		#endif

	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

	/* Public Interface - May be used in end-application: */
		/* Macros: */
			/** ADC channel number for the temperature sensor. */
			#define TEMP_ADC_CHANNEL       0
89

90
91
92
93
94
95
96
97
			/** ADC channel MUX mask for the temperature sensor. */
			#define TEMP_ADC_CHANNEL_MASK  ADC_CHANNEL0

			/** Minimum returnable temperature from the \ref Temperature_GetTemperature() function. */
			#define TEMP_MIN_TEMP          TEMP_TABLE_OFFSET

			/** Maximum returnable temperature from the \ref Temperature_GetTemperature() function. */
			#define TEMP_MAX_TEMP          ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET)
98

99
		/* Inline Functions: */
100
			/** Initialises the temperature sensor driver, including setting up the appropriate ADC channel.
101
102
103
104
105
106
107
108
109
110
			 *  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
			 *       temperature sensor functions.
			 */
			static inline void Temperature_Init(void) ATTR_ALWAYS_INLINE;
			static inline void Temperature_Init(void)
			{
				ADC_SetupChannel(TEMP_ADC_CHANNEL);
			}
111
112
113
114
115

		/* Function Prototypes: */
			/** Performs a complete ADC on the temperature sensor channel, and converts the result into a
			 *  valid temperature between \ref TEMP_MIN_TEMP and \ref TEMP_MAX_TEMP in degrees Celsius.
			 *
116
			 *  \return Signed temperature value in degrees Celsius.
117
118
119
120
121
122
			 */
			int8_t Temperature_GetTemperature(void) ATTR_WARN_UNUSED_RESULT;

	/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
		/* Macros: */
123
			#define TEMP_TABLE_OFFSET_DEGREES   -21
124
125
126
127
128
129
	#endif

	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
130

131
132
133
#endif

/** @} */
134