driver_gp2y1051au0f.h File Reference

driver gp2y1051au0f header file More...

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

Go to the source code of this file.

Data Structures
struct	gp2y1051au0f_handle_s
	gp2y1051au0f handle structure definition More...
struct	gp2y1051au0f_info_s
	gp2y1051au0f information structure definition More...

Macros
#define	DRIVER_GP2Y1051AU0F_LINK_INIT(HANDLE, STRUCTURE)   memset(HANDLE, 0, sizeof(STRUCTURE))
	initialize gp2y1051au0f_handle_t structure More...
#define	DRIVER_GP2Y1051AU0F_LINK_UART_INIT(HANDLE, FUC)   (HANDLE)->uart_init = FUC
	link uart_init function More...
#define	DRIVER_GP2Y1051AU0F_LINK_UART_DEINIT(HANDLE, FUC)   (HANDLE)->uart_deinit = FUC
	link uart_deinit function More...
#define	DRIVER_GP2Y1051AU0F_LINK_UART_READ(HANDLE, FUC)   (HANDLE)->uart_read = FUC
	link uart_read function More...
#define	DRIVER_GP2Y1051AU0F_LINK_UART_FLUSH(HANDLE, FUC)   (HANDLE)->uart_flush = FUC
	link uart_flush function More...
#define	DRIVER_GP2Y1051AU0F_LINK_DELAY_MS(HANDLE, FUC)   (HANDLE)->delay_ms = FUC
	link delay_ms function More...
#define	DRIVER_GP2Y1051AU0F_LINK_DEBUG_PRINT(HANDLE, FUC)   (HANDLE)->debug_print = FUC
	link debug_print function More...

Typedefs
typedef struct gp2y1051au0f_handle_s	gp2y1051au0f_handle_t
	gp2y1051au0f handle structure definition More...
typedef struct gp2y1051au0f_info_s	gp2y1051au0f_info_t
	gp2y1051au0f information structure definition More...

Functions
uint8_t	gp2y1051au0f_info (gp2y1051au0f_info_t *info)
	get chip's information More...
uint8_t	gp2y1051au0f_init (gp2y1051au0f_handle_t *handle)
	initialize the chip More...
uint8_t	gp2y1051au0f_deinit (gp2y1051au0f_handle_t *handle)
	close the chip More...
uint8_t	gp2y1051au0f_read (gp2y1051au0f_handle_t *handle, uint16_t *raw, float *mg_m3)
	read the data More...
uint8_t	gp2y1051au0f_get_buf (gp2y1051au0f_handle_t *handle, char *buf, uint16_t len, uint32_t ms)
	get buffer More...

Detailed Description

driver gp2y1051au0f 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-04-15

history

Date	Version	Author	Description
2024/04/15	1.0	Shifeng Li	first upload

Definition in file driver_gp2y1051au0f.h.