ZMOD4510 Ultra-Low Power Ozone Firmware Documentation |

Data Structures | Macros | Functions
ulp_o3.h File Reference

This file contains the data structure definitions and the function definitions for the ULP O3 algorithm. More...

Go to the source code of this file.

## Data Structures
struct | algorithm_version
| Variables that describe the library version. More...
struct | ulp_o3_handle_t
| Variables that describe the sensor or the algorithm state. More...
struct | ulp_o3_results_t
| Variables that receive the algorithm outputs. More...
struct | ulp_o3_inputs_t
| Variables that are needed for algorithm. More...

## Macros
#define | ULP_O3_OK (0)
#define | ULP_O3_STABILIZATION (1)
#define | ULP_O3_DAMAGE (-102)

## Functions
int8_t | init_ulp_o3 (ulp_o3_handle_t *handle)
| Initializes the ULP O3 algorithm. More...
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)
| calculates results from present sample. More...

## Function Documentation

## ◆ calc_ulp_o3()

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
| ) |  |

calculates results from present sample.

Parameters

  [in] | handle | Pointer to algorithm state variable.
  [in] | dev | Pointer to the device.
  [in] | algo_input | Structure containing inputs required for algo calculation.
  [out] | results | Pointer for storing the algorithm results.

Returns
  error code.

## ◆ init_ulp_o3()

int8_t init_ulp_o3 | ( | ulp_o3_handle_t * | handle | ) |

Initializes the ULP O3 algorithm.

Parameters

  [out] | handle | Pointer to algorithm state variable.

Returns
  error code.