driver_ags10.h File Reference

driver ags10 header file More...

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

Include dependency graph for driver_ags10.h:

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

Go to the source code of this file.

Data Structures
struct	ags10_handle_s
	ags10 handle structure definition More...
struct	ags10_info_s
	ags10 information structure definition More...

Macros
#define	DRIVER_AGS10_LINK_INIT(HANDLE, STRUCTURE)
	initialize ags10_handle_t structure
#define	DRIVER_AGS10_LINK_IIC_INIT(HANDLE, FUC)
	link iic_init function
#define	DRIVER_AGS10_LINK_IIC_DEINIT(HANDLE, FUC)
	link iic_deinit function
#define	DRIVER_AGS10_LINK_IIC_READ_CMD(HANDLE, FUC)
	link iic_read_cmd function
#define	DRIVER_AGS10_LINK_IIC_WRITE_CMD(HANDLE, FUC)
	link iic_write_cmd function
#define	DRIVER_AGS10_LINK_IIC_WRITE(HANDLE, FUC)
	link iic_write function
#define	DRIVER_AGS10_LINK_DELAY_MS(HANDLE, FUC)
	link delay_ms function
#define	DRIVER_AGS10_LINK_DEBUG_PRINT(HANDLE, FUC)
	link debug_print function

Typedefs
typedef struct ags10_handle_s	ags10_handle_t
	ags10 handle structure definition
typedef struct ags10_info_s	ags10_info_t
	ags10 information structure definition

Functions
uint8_t	ags10_info (ags10_info_t *info)
	get chip's information
uint8_t	ags10_init (ags10_handle_t *handle)
	initialize the chip
uint8_t	ags10_deinit (ags10_handle_t *handle)
	close the chip
uint8_t	ags10_read_tvoc (ags10_handle_t *handle, uint32_t *raw, uint32_t *ppb)
	read tvoc
uint8_t	ags10_zero_point_calibration (ags10_handle_t *handle, uint16_t raw)
	zero point calibration
uint8_t	ags10_reset_zero_point_calibration (ags10_handle_t *handle)
	reset zero point calibration
uint8_t	ags10_current_resistance_zero_point_calibration (ags10_handle_t *handle)
	zero point calibration using current resistance
uint8_t	ags10_get_resistance (ags10_handle_t *handle, uint32_t *raw, double *ohm)
	get resistance
uint8_t	ags10_get_version (ags10_handle_t *handle, uint8_t *version)
	get version
uint8_t	ags10_modify_slave_address (ags10_handle_t *handle, uint8_t addr_7bit)
	modify slave address
uint8_t	ags10_set_slave_address (ags10_handle_t *handle, uint8_t addr)
	set slave address
uint8_t	ags10_get_slave_address (ags10_handle_t *handle, uint8_t *addr)
	get slave address
uint8_t	ags10_set_reg (ags10_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len)
	set the chip register
uint8_t	ags10_get_reg (ags10_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len)
	get the chip register

Detailed Description

driver ags10 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

2024-10-31

history

Date	Version	Author	Description
2024/10/31	1.0	Shifeng Li	first upload

Definition in file driver_ags10.h.