mhz19.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2018 Koen Zandberg <koen@bergzand.net>
 * SPDX-FileCopyrightText: 2018 Beduino Master Projekt - University of Bremen
 * SPDX-FileCopyrightText: 2020 Bas Stottelaar <basstottelaar@gmail.com>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdbool.h>
 
#include "saul.h"
 
#ifdef MODULE_MHZ19_UART
#include "periph/uart.h"
#include "mhz19_internals.h"
#include "mutex.h"
#endif /* MODULE_MHZ19_UART */
 
#ifdef MODULE_MHZ19_PWM
#include "periph/gpio.h"
#endif /* MODULE_MHZ19_PWM */
 
#ifdef __cplusplus
extern "C" {
#endif

enum {
    MHZ19_OK            =  0,       
    MHZ19_ERR_INIT      = -1,       
    MHZ19_ERR_TIMEOUT   = -2,       
    MHZ19_ERR_CHECKSUM  = -3,       
};
 
#ifdef MODULE_MHZ19_UART
typedef struct {
    uart_t uart;                
    bool auto_calibration;      
} mhz19_params_t;

typedef struct {
    const mhz19_params_t *params;   
    mutex_t mutex;                  
    mutex_t sync;                   
    uint8_t idx;                    
    uint8_t rxmem[MHZ19_BUF_SIZE];  
} mhz19_t;
#endif /* MODULE_MHZ19_UART */
 
#ifdef MODULE_MHZ19_PWM
typedef struct {
    gpio_t pin;     
} mhz19_params_t;

typedef struct {
    gpio_t pin;     
} mhz19_t;
#endif /* MODULE_MHZ19_PWM */

extern const saul_driver_t mhz19_ppm_saul_driver;

int mhz19_init(mhz19_t *dev, const mhz19_params_t *params);

int mhz19_get_ppm(mhz19_t *dev, int16_t *ppm);
 
#ifdef MODULE_MHZ19_UART
void mhz19_set_auto_calibration(mhz19_t *dev, bool enable);

void mhz19_calibrate_zero_point(mhz19_t *dev);
#endif
 
#ifdef __cplusplus
}
#endif