LibDriver PMS3003
Loading...
Searching...
No Matches
pms3003 basic driver function
pms3003 driver function

pms3003 basic driver modules More...

Collaboration diagram for pms3003 basic driver function:

Data Structures

struct  pms3003_data_s
 pms3003 data structure definition More...
struct  pms3003_handle_s
 pms3003 handle structure definition More...
struct  pms3003_info_s
 pms3003 information structure definition More...

Typedefs

typedef struct pms3003_data_s pms3003_data_t
 pms3003 data structure definition
typedef struct pms3003_handle_s pms3003_handle_t
 pms3003 handle structure definition
typedef struct pms3003_info_s pms3003_info_t
 pms3003 information structure definition

Enumerations

enum  pms3003_hard_mode_t { PMS3003_HARD_MODE_SLEEP = 0x00 , PMS3003_HARD_MODE_NORMAL = 0x01 }
 pms3003 hard mode enumeration definition More...
enum  pms3003_mode_t { PMS3003_MODE_PASSIVE = 0x00 , PMS3003_MODE_ACTIVE = 0x01 }
 pms3003 mode enumeration definition More...

Functions

uint8_t pms3003_info (pms3003_info_t *info)
 get chip's information
uint8_t pms3003_init (pms3003_handle_t *handle)
 initialize the chip
uint8_t pms3003_deinit (pms3003_handle_t *handle)
 close the chip
uint8_t pms3003_read (pms3003_handle_t *handle, pms3003_data_t *data)
 read the data
uint8_t pms3003_reset (pms3003_handle_t *handle)
 reset
uint8_t pms3003_set_hard_mode (pms3003_handle_t *handle, pms3003_hard_mode_t mode)
 set hard mode
uint8_t pms3003_set_mode (pms3003_handle_t *handle, pms3003_mode_t mode)
 set mode
uint8_t pms3003_sleep (pms3003_handle_t *handle)
 sleep
uint8_t pms3003_wake_up (pms3003_handle_t *handle)
 wake up

Detailed Description

pms3003 basic driver modules

Typedef Documentation

◆ pms3003_data_t

typedef struct pms3003_data_s pms3003_data_t

pms3003 data structure definition

◆ pms3003_handle_t

typedef struct pms3003_handle_s pms3003_handle_t

pms3003 handle structure definition

◆ pms3003_info_t

typedef struct pms3003_info_s pms3003_info_t

pms3003 information structure definition

Enumeration Type Documentation

◆ pms3003_hard_mode_t

enum pms3003_hard_mode_t

pms3003 hard mode enumeration definition

Enumerator
PMS3003_HARD_MODE_SLEEP 

sleep mode

PMS3003_HARD_MODE_NORMAL 

normal mode

Definition at line 62 of file driver_pms3003.h.

◆ pms3003_mode_t

enum pms3003_mode_t

pms3003 mode enumeration definition

Enumerator
PMS3003_MODE_PASSIVE 

passive mode

PMS3003_MODE_ACTIVE 

active mode

Definition at line 71 of file driver_pms3003.h.

Function Documentation

◆ pms3003_deinit()

uint8_t pms3003_deinit ( pms3003_handle_t * handle)

close the chip

Parameters
[in]*handlepointer to a pms3003 handle structure
Returns
status code
  • 0 success
  • 1 uart or gpio deinit failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 367 of file driver_pms3003.c.

◆ pms3003_info()

uint8_t pms3003_info ( pms3003_info_t * info)

get chip's information

Parameters
[out]*infopointer to a pms3003 info structure
Returns
status code
  • 0 success
  • 2 handle is NULL
Note
none

Definition at line 877 of file driver_pms3003.c.

◆ pms3003_init()

uint8_t pms3003_init ( pms3003_handle_t * handle)

initialize the chip

Parameters
[in]*handlepointer to a pms3003 handle structure
Returns
status code
  • 0 success
  • 1 uart or gpio initialization failed
  • 2 handle is NULL
  • 3 linked functions is NULL
Note
none

Definition at line 205 of file driver_pms3003.c.

◆ pms3003_read()

uint8_t pms3003_read ( pms3003_handle_t * handle,
pms3003_data_t * data )

read the data

Parameters
[in]*handlepointer to a pms3003 handle structure
[out]*datapointer to a data structure
Returns
status code
  • 0 success
  • 1 read failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 frame error
Note
none

Definition at line 680 of file driver_pms3003.c.

◆ pms3003_reset()

uint8_t pms3003_reset ( pms3003_handle_t * handle)

reset

Parameters
[in]*handlepointer to a pms3003 handle structure
Returns
status code
  • 0 success
  • 1 reset failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 411 of file driver_pms3003.c.

◆ pms3003_set_hard_mode()

uint8_t pms3003_set_hard_mode ( pms3003_handle_t * handle,
pms3003_hard_mode_t mode )

set hard mode

Parameters
[in]*handlepointer to a pms3003 handle structure
[in]modehard mode
Returns
status code
  • 0 success
  • 1 set hard mode failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 451 of file driver_pms3003.c.

◆ pms3003_set_mode()

uint8_t pms3003_set_mode ( pms3003_handle_t * handle,
pms3003_mode_t mode )

set mode

Parameters
[in]*handlepointer to a pms3003 handle structure
[in]modechip mode
Returns
status code
  • 0 success
  • 1 set mode failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 frame error
Note
none

Definition at line 497 of file driver_pms3003.c.

◆ pms3003_sleep()

uint8_t pms3003_sleep ( pms3003_handle_t * handle)

sleep

Parameters
[in]*handlepointer to a pms3003 handle structure
Returns
status code
  • 0 success
  • 1 sleep failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 frame error
Note
none

Definition at line 566 of file driver_pms3003.c.

◆ pms3003_wake_up()

uint8_t pms3003_wake_up ( pms3003_handle_t * handle)

wake up

Parameters
[in]*handlepointer to a pms3003 handle structure
Returns
status code
  • 0 success
  • 1 wake up failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 frame error
Note
none

Definition at line 634 of file driver_pms3003.c.