sdp3x.h

Go to the documentation of this file.

/*
 * Copyright (C) 2019 Dirk Ehmen
 *               2020 Nishchay Agrawal
 *
 * 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 SDP3X_H
#define SDP3X_H
 
#include "saul.h"
#include "xtimer.h"
#include "mutex.h"
#include "periph/i2c.h"
#include "periph/gpio.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SDP3X_FLAG_MASS_FLOW  0x02      
#define SDP3X_FLAG_DIFF_PRESS 0x00      
#define SDP3X_FLAG_AVERAGE    0x01      
#define SDP3X_FLAG_NO_AVERAGE 0x00      
typedef struct {
    i2c_t i2c_dev;                  
    uint8_t i2c_addr;               
    gpio_t irq_pin;                 
} sdp3x_params_t;
 
typedef struct {
    bool continuous_measurement;    
    sdp3x_params_t params;          
    mutex_t mutex;                  
} sdp3x_t;
 
typedef struct {
    int32_t differential_pressure;  
    int32_t temperature;            
} sdp3x_measurement_t;
 
enum {
    SDP3x_OK = 0,             
    SDP3x_CRCERROR = -1,      
    SDP3x_NODATA = -2,        
    SDP3x_IOERROR = -3,       
    SDP3x_WRONGSIZE = -4      
};
 
int sdp3x_init(sdp3x_t *dev, const sdp3x_params_t *params);
 
int8_t sdp3x_start_continuous(sdp3x_t *dev, uint8_t flags);
 
int8_t sdp3x_read_continuous(sdp3x_measurement_t *result, sdp3x_t *dev);
 
int32_t sdp3x_read_single_temperature(sdp3x_t *dev, uint8_t flags);
 
int32_t sdp3x_read_single_differential_pressure(sdp3x_t *dev,
                                                uint8_t flags);
 
int8_t sdp3x_read_single_measurement(sdp3x_t *dev, uint8_t flags,
                                     sdp3x_measurement_t *result);
 
int8_t sdp3x_stop_continuous(sdp3x_t *dev, xtimer_t *continuous_timer);
 
int8_t sdp3x_soft_reset(const sdp3x_t *dev);
 
int8_t sdp3x_enter_sleep(const sdp3x_t *dev);
 
int8_t sdp3x_exit_sleep(const sdp3x_t *dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SDP3X_H */