ulp_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 ULP_O3_H_
#define ULP_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 ULP_O3_OK            (0) 
#define ULP_O3_STABILIZATION (1) 
#define ULP_O3_DAMAGE        (-102) 
typedef struct {
    uint32_t sample_cnt; 
    float smooth_rmox;
    float gcda;          
    float o3_conc_ppb;
    float o3_1h_ppb;
    float o3_8h_ppb;
} ulp_o3_handle_t;

typedef struct {
    float     rmox[8];     
    float     temperature; 
    float     O3_conc_ppb; 
    uint16_t  FAST_AQI;    
    uint16_t  EPA_AQI;     
} ulp_o3_results_t;

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

int8_t init_ulp_o3(ulp_o3_handle_t *handle);

int8_t calc_ulp_o3(ulp_o3_handle_t *handle, zmod4xxx_dev_t *dev,
                   const ulp_o3_inputs_t *algo_input,
                   ulp_o3_results_t *results);

#ifdef __cplusplus
}
#endif

#endif /* ULP_O3_H_ */