a752c7ab
 elopes
add first test an...
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
/*
* Copyright (C) 2014 Freie Universitรคt Berlin
*
* This file is subject to the terms and conditions of the GNU Lesser General
* Public License v2.1. See the file LICENSE in the top level directory for more
* details.
*/
/**
* @defgroup drivers_mq3 MQ-3 Alcohol Tester
* @ingroup drivers_sensors
* @brief Device driver for the MQ-3 alcohol sensor
* @{
*
* @file
* @brief Device driver interface for the MQ-3 alcohol sensor
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/
#ifndef MQ3_H
#define MQ3_H
#include "periph/adc.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief maximum unprocessed value fetched form the sensor
*/
#define MQ3_MAX_RAW_VALUE (1023U)
/**
* @brief device descriptor for a MQ-3 sensor
*/
typedef struct {
adc_t adc_line; /**< the used ADC line */
} mq3_t;
/**
* @brief Initialize a MQ-3 alcohol sensor
*
* The MQ-3 sensor is interfaced by a single ADC pin, specified by `adc` and `channel`.
*
* @note The sensor needs about a minute to heat up before meaningful measurements
* can be made.
*
* @param[out] dev device descriptor of an MQ-3 sensor
* @param[in] adc_line the ADC device the sensor is connected to
*
* @return 0 on success
* @return -1 on error
*/
int mq3_init(mq3_t *dev, adc_t adc_line);
/**
* @brief Read the RAW sensor value, can be between 0 and MQ3_MAX_RAW_VALUE
*
* @param[in] dev device descriptor of the MQ-3 sensor to read from
*
* @return the raw sensor value, between 0 and MQ3_MAX_RAW_VALUE
*/
int mq3_read_raw(const mq3_t *dev);
/**
* @brief Read the scaled sensor value of PPM of alcohol
*
* @param[in] dev device descriptor of the MQ-3 sensor to read from
*
* @return the scaled sensor value in PPM of alcohol
*/
int mq3_read(const mq3_t *dev);
#ifdef __cplusplus
}
#endif
#endif /* MQ3_H */
/** @} */
|