driver_sgp41.h File Reference

driver sgp41 header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>

Include dependency graph for driver_sgp41.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	sgp41_handle_s
	sgp41 handle structure definition More...
struct	sgp41_info_s
	sgp41 information structure definition More...

Macros
#define	DRIVER_SGP41_LINK_INIT(HANDLE, STRUCTURE)
	initialize sgp41_handle_t structure
#define	DRIVER_SGP41_LINK_IIC_INIT(HANDLE, FUC)
	link iic_init function
#define	DRIVER_SGP41_LINK_IIC_DEINIT(HANDLE, FUC)
	link iic_deinit function
#define	DRIVER_SGP41_LINK_IIC_WRITE_COMMAND(HANDLE, FUC)
	link iic_write_cmd function
#define	DRIVER_SGP41_LINK_IIC_READ_COMMAND(HANDLE, FUC)
	link iic_read_cmd function
#define	DRIVER_SGP41_LINK_DELAY_MS(HANDLE, FUC)
	link delay_ms function
#define	DRIVER_SGP41_LINK_DEBUG_PRINT(HANDLE, FUC)
	link debug_print function

Typedefs
typedef struct sgp41_handle_s	sgp41_handle_t
	sgp41 handle structure definition
typedef struct sgp41_info_s	sgp41_info_t
	sgp41 information structure definition

Functions
uint8_t	sgp41_info (sgp41_info_t *info)
	get chip information
uint8_t	sgp41_init (sgp41_handle_t *handle)
	initialize the chip
uint8_t	sgp41_deinit (sgp41_handle_t *handle)
	close the chip
uint8_t	sgp41_get_execute_conditioning (sgp41_handle_t *handle, uint16_t *sraw_voc)
	get execute conditioning
uint8_t	sgp41_get_measure_raw (sgp41_handle_t *handle, uint16_t raw_humidity, uint16_t raw_temperature, uint16_t *sraw_voc, uint16_t *sraw_nox)
	get the measure raw result
uint8_t	sgp41_get_measure_raw_without_compensation (sgp41_handle_t *handle, uint16_t *sraw_voc, uint16_t *sraw_nox)
	get the measure raw result without compensation
uint8_t	sgp41_humidity_convert_to_register (sgp41_handle_t *handle, float rh, uint16_t *reg)
	convert the humidity to the register data
uint8_t	sgp41_temperature_convert_to_register (sgp41_handle_t *handle, float temp, uint16_t *reg)
	convert the temperature to the register data
uint8_t	sgp41_get_measure_test (sgp41_handle_t *handle, uint16_t *result)
	get the chip measure test
uint8_t	sgp41_soft_reset (sgp41_handle_t *handle)
	soft reset the chip
uint8_t	sgp41_turn_heater_off (sgp41_handle_t *handle)
	turn heater off
uint8_t	sgp41_get_serial_id (sgp41_handle_t *handle, uint16_t id[3])
	get the chip serial id
uint8_t	sgp41_set_reg (sgp41_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len)
	set the chip register
uint8_t	sgp41_get_reg (sgp41_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len)
	get the chip register

Detailed Description

driver sgp41 header file

Copyright (c) 2015 - present LibDriver All rights reserved

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version

1.0.0

Author

Shifeng Li

Date

2023-08-30

history

Date	Version	Author	Description
2023/08/30	1.0	Shifeng Li	first upload

Definition in file driver_sgp41.h.