libspicboard-doc

adc.h
Go to the documentation of this file.
1 #ifndef ADC_H
2 #define ADC_H
3 
4 #include <stdint.h>
5 
6 #include "check.h"
7 
8 /**
9  * \addtogroup ADC ADC (Analog to Digital Converter)
10  *
11  * \brief Interface to the AD-converter of the ATmega32, which allows to
12  * query the potentiometer and the photosensor of the board
13  *
14  * @{
15  * \file adc.h
16  * \version \$Rev: 7715 $
17  */
18 
19 /**
20  * \brief Device ids of available periphery connected to ADC channels
21  */
22 typedef enum {
23  POTI = 0, /**< the potentiometer (rotation towards LEDs yields higher numbers) **/
24  PHOTO = 1 /**< the photosensor (brighter ambience yields higher numbers) **/
25 } __attribute__ ((__packed__)) ADCDEV;
26 
27 CHECK_ENUM_SIZE(ADCDEV, 1)
28 
29 /**
30  * \brief Perform a 10-bit A/D conversion for a specific channel/device
31  *
32  * \param dev id of a device connected to the ADC
33  *
34  * \retval >=0 10-bit result of the conversion
35  * \retval -1 invalid device id
36  */
37 int16_t sb_adc_read(ADCDEV dev);
38 
39 /** @}*/
40 
41 #endif
42 
sb_adc_read
int16_t sb_adc_read(ADCDEV dev)
Perform a 10-bit A/D conversion for a specific channel/device.
ADCDEV
ADCDEV
Device ids of available periphery connected to ADC channels.
Definition: adc.h:22
PHOTO
@ PHOTO
Definition: adc.h:24
POTI
@ POTI
Definition: adc.h:23
CHECK_ENUM_SIZE
#define CHECK_ENUM_SIZE(VAR, LEN)
Definition: check.h:71