driver pmsx003 header file More...

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

Include dependency graph for driver_pmsx003.h:

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

Data Structures
struct	pmsx003_data_s
	pmsx003 data structure definition More...
struct	pmsx003_handle_s
	pmsx003 handle structure definition More...
struct	pmsx003_info_s
	pmsx003 information structure definition More...

Macros
#define	DRIVER_PMSX003_LINK_INIT(HANDLE, STRUCTURE)
	initialize pmsx003_handle_t structure
#define	DRIVER_PMSX003_LINK_UART_INIT(HANDLE, FUC)
	link uart_init function
#define	DRIVER_PMSX003_LINK_UART_DEINIT(HANDLE, FUC)
	link uart_deinit function
#define	DRIVER_PMSX003_LINK_UART_READ(HANDLE, FUC)
	link uart_read function
#define	DRIVER_PMSX003_LINK_UART_WRITE(HANDLE, FUC)
	link uart_write function
#define	DRIVER_PMSX003_LINK_UART_FLUSH(HANDLE, FUC)
	link uart_flush function
#define	DRIVER_PMSX003_LINK_RESET_GPIO_INIT(HANDLE, FUC)
	link reset_gpio_init function
#define	DRIVER_PMSX003_LINK_RESET_GPIO_DEINIT(HANDLE, FUC)
	link reset_gpio_deinit function
#define	DRIVER_PMSX003_LINK_RESET_GPIO_WRITE(HANDLE, FUC)
	link reset_gpio_write function
#define	DRIVER_PMSX003_LINK_SET_GPIO_INIT(HANDLE, FUC)
	link set_gpio_init function
#define	DRIVER_PMSX003_LINK_SET_GPIO_DEINIT(HANDLE, FUC)
	link set_gpio_deinit function
#define	DRIVER_PMSX003_LINK_SET_GPIO_WRITE(HANDLE, FUC)
	link set_gpio_write function
#define	DRIVER_PMSX003_LINK_DELAY_MS(HANDLE, FUC)
	link delay_ms function
#define	DRIVER_PMSX003_LINK_DEBUG_PRINT(HANDLE, FUC)
	link debug_print function

Typedefs
typedef struct pmsx003_data_s	pmsx003_data_t
	pmsx003 data structure definition
typedef struct pmsx003_handle_s	pmsx003_handle_t
	pmsx003 handle structure definition
typedef struct pmsx003_info_s	pmsx003_info_t
	pmsx003 information structure definition

Enumerations
enum	pmsx003_hard_mode_t { PMSX003_HARD_MODE_SLEEP = 0x00 , PMSX003_HARD_MODE_NORMAL = 0x01 }
	pmsx003 hard mode enumeration definition More...
enum	pmsx003_mode_t { PMSX003_MODE_PASSIVE = 0x00 , PMSX003_MODE_ACTIVE = 0x01 }
	pmsx003 mode enumeration definition More...

Functions
uint8_t	pmsx003_info (pmsx003_info_t *info)
	get chip's information
uint8_t	pmsx003_init (pmsx003_handle_t *handle)
	initialize the chip
uint8_t	pmsx003_deinit (pmsx003_handle_t *handle)
	close the chip
uint8_t	pmsx003_read (pmsx003_handle_t handle, pmsx003_data_t data)
	read the data
uint8_t	pmsx003_reset (pmsx003_handle_t *handle)
	reset
uint8_t	pmsx003_set_hard_mode (pmsx003_handle_t *handle, pmsx003_hard_mode_t mode)
	set hard mode
uint8_t	pmsx003_set_mode (pmsx003_handle_t *handle, pmsx003_mode_t mode)
	set mode
uint8_t	pmsx003_sleep (pmsx003_handle_t *handle)
	sleep
uint8_t	pmsx003_wake_up (pmsx003_handle_t *handle)
	wake up
uint8_t	pmsx003_set_buffer (pmsx003_handle_t handle, uint8_t buf, uint16_t len)
	set buffer
uint8_t	pmsx003_get_buffer (pmsx003_handle_t handle, uint8_t buf, uint16_t len)
	get buffer

Detailed Description

driver pmsx003 header file

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: 2025-05-15

history

Date	Version	Author	Description
2025/05/15	1.0	Shifeng Li	first upload

Definition in file driver_pmsx003.h.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

history