mq3_8h_source.html

/*

 * 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.

 */


#ifndef MQ3_H

#define MQ3_H


#include "periph/adc.h"


#ifdef __cplusplus

extern "C" {

#endif


#define MQ3_MAX_RAW_VALUE           (1023U)


typedef struct {

    adc_t adc_line;

} mq3_t;


int mq3_init(mq3_t *dev, adc_t adc_line);


int16_t mq3_read_raw(const mq3_t *dev);


int16_t mq3_read(const mq3_t *dev);


#ifdef __cplusplus

}

#endif


#endif /* MQ3_H */

adc.h
Low-level ADC peripheral driver interface definitions.

mq3_read
int16_t mq3_read(const mq3_t *dev)
Read the scaled sensor value of PPM of alcohol.

mq3_read_raw
int16_t mq3_read_raw(const mq3_t *dev)
Read the RAW sensor value, can be between 0 and MQ3_MAX_RAW_VALUE.

mq3_init
int mq3_init(mq3_t *dev, adc_t adc_line)
Initialize a MQ-3 alcohol sensor.

adc_t
uint_fast8_t adc_t
Define default ADC type identifier.
Definition adc.h:72

mq3_t
device descriptor for a MQ-3 sensor
Definition mq3.h:38

mq3_t::adc_line
adc_t adc_line
the used ADC line
Definition mq3.h:39