LibDriver SGP41
Loading...
Searching...
No Matches
driver_sgp41_algorithm.h File Reference

driver sgp41 algorithm header file More...

#include <math.h>
#include <stdio.h>
#include <stdint.h>
#include <string.h>
Include dependency graph for driver_sgp41_algorithm.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  sgp41_gas_index_algorithm_s
 sgp41 gas index algorithm structure definition More...

Macros

#define SGP41_ALGORITHM_TYPE_VOC   (0)
 sgp41 algorithm type definition
#define SGP41_ALGORITHM_TYPE_NOX   (1)

Typedefs

typedef struct sgp41_gas_index_algorithm_s sgp41_gas_index_algorithm_t
 sgp41 gas index algorithm structure definition

Functions

void sgp41_algorithm_reset (sgp41_gas_index_algorithm_t *params)
 algorithm reset
void sgp41_algorithm_init_with_sampling_interval (sgp41_gas_index_algorithm_t *params, int32_t algorithm_type, float sampling_interval)
 algorithm init with sampling interval
void sgp41_algorithm_init (sgp41_gas_index_algorithm_t *params, int32_t algorithm_type)
 algorithm init
void sgp41_algorithm_get_sampling_interval (const sgp41_gas_index_algorithm_t *params, float *sampling_interval)
 algorithm get sampling interval
void sgp41_algorithm_set_states (sgp41_gas_index_algorithm_t *params, float state0, float state1)
 algorithm set states
void sgp41_algorithm_get_states (const sgp41_gas_index_algorithm_t *params, float *state0, float *state1)
 algorithm get states
void sgp41_algorithm_set_tuning_parameters (sgp41_gas_index_algorithm_t *params, int32_t index_offset, int32_t learning_time_offset_hours, int32_t learning_time_gain_hours, int32_t gating_max_duration_minutes, int32_t std_initial, int32_t gain_factor)
 algorithm set tuning parameters
void sgp41_algorithm_get_tuning_parameters (const sgp41_gas_index_algorithm_t *params, int32_t *index_offset, int32_t *learning_time_offset_hours, int32_t *learning_time_gain_hours, int32_t *gating_max_duration_minutes, int32_t *std_initial, int32_t *gain_factor)
 algorithm get tuning parameters
void sgp41_algorithm_process (sgp41_gas_index_algorithm_t *params, int32_t sraw, int32_t *gas_index)
 algorithm process

Detailed Description

driver sgp41 algorithm header file

Copyright (c) 2022 - present Sensirion AG All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of Sensirion AG nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Version
1.0.0
Author
Sensirion
Date
2023-08-30

history

Date Version Author Description
2023/08/30 1.0 Sensirion first upload

Definition in file driver_sgp41_algorithm.h.