no2_o3.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (c) 2024 Renesas Electronics Corporation
 * All Rights Reserved.
 * 
 * This code is proprietary to Renesas, and is license pursuant to the terms and
 * conditions that may be accessed at:
 * https://www.renesas.com/eu/en/document/msc/renesas-software-license-terms-gas-sensor-software
 *****************************************************************************/

#ifndef NO2_O3_H_
#define NO2_O3_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <math.h>
#include "zmod4xxx_types.h"

typedef struct {
    uint8_t major;
    uint8_t minor;
    uint8_t patch;
} algorithm_version;

#define NO2_O3_OK            (0) 
#define NO2_O3_STABILIZATION (1) 
#define NO2_O3_DAMAGE        (-102) 
typedef struct {
    uint32_t sample_counter; 
    float rmoxs_smooth[4];
    float logrmoxs_mean[4];
    float logrmoxs_var[4];
    float o3_1min_ppb;
    float o3_1h_ppb;
    float o3_8h_ppb;
    float no2_1min_ppb;
    float no2_1h_ppb;
} no2_o3_handle_t;

typedef struct {
    float rmox[4]; 
    float temperature; 
    float O3_conc_ppb; 
    float NO2_conc_ppb; 
    uint16_t
        FAST_AQI; 
    uint16_t
        EPA_AQI; 
} no2_o3_results_t;

typedef struct {
    uint8_t *adc_result;
    float humidity_pct;
    float temperature_degc;
} no2_o3_inputs_t;

int8_t init_no2_o3(no2_o3_handle_t *handle);

int8_t calc_no2_o3(no2_o3_handle_t *handle, const zmod4xxx_dev_t *dev,
                   const no2_o3_inputs_t *algo_input,
                   no2_o3_results_t *results);

#ifdef __cplusplus
}
#endif

#endif /* NO2_O3_H_ */