LibDriver SPS30
Loading...
Searching...
No Matches
sps30 example driver function
sps30 driver function

sps30 example driver modules More...

Collaboration diagram for sps30 example driver function:

Macros

#define SPS30_BASIC_DEFAULT_FORMAT   SPS30_FORMAT_IEEE754
 sps30 basic example default definition
#define SPS30_BASIC_DEFAULT_AUTO_CLEANING_INTERVAL   3600 * 24

Functions

uint8_t sps30_basic_init (sps30_interface_t interface)
 basic example init
uint8_t sps30_basic_deinit (void)
 basic example deinit
uint8_t sps30_basic_read (sps30_pm_t *pm)
 basic example read
uint8_t sps30_basic_start_fan_cleaning (void)
 basic example start fan cleaning
uint8_t sps30_basic_sleep (void)
 basic example sleep
uint8_t sps30_basic_wake_up (void)
 basic example wake up
uint8_t sps30_basic_reset (void)
 basic example reset
uint8_t sps30_basic_get_product_type (char type[9])
 basic example get the product type
uint8_t sps30_basic_get_serial_number (char sn[17])
 basic example get the serial number
uint8_t sps30_basic_get_version (uint8_t *major, uint8_t *minor)
 basic example get the version
uint8_t sps30_basic_get_status (uint32_t *status)
 basic example get the status

Detailed Description

sps30 example driver modules

Macro Definition Documentation

◆ SPS30_BASIC_DEFAULT_AUTO_CLEANING_INTERVAL

#define SPS30_BASIC_DEFAULT_AUTO_CLEANING_INTERVAL   3600 * 24

1 day

Definition at line 57 of file driver_sps30_basic.h.

◆ SPS30_BASIC_DEFAULT_FORMAT

#define SPS30_BASIC_DEFAULT_FORMAT   SPS30_FORMAT_IEEE754

sps30 basic example default definition

ieee754

Definition at line 56 of file driver_sps30_basic.h.

Function Documentation

◆ sps30_basic_deinit()

uint8_t sps30_basic_deinit ( void )

basic example deinit

Returns
status code
  • 0 success
  • 1 deinit failed
Note
none

Definition at line 115 of file driver_sps30_basic.c.

Here is the call graph for this function:

◆ sps30_basic_get_product_type()

uint8_t sps30_basic_get_product_type ( char type[9])

basic example get the product type

Parameters
[out]*typepointer to a type buffer
Returns
status code
  • 0 success
  • 1 get product type failed
Note
none

Definition at line 244 of file driver_sps30_basic.c.

Here is the call graph for this function:

◆ sps30_basic_get_serial_number()

uint8_t sps30_basic_get_serial_number ( char sn[17])

basic example get the serial number

Parameters
[out]*snpointer to a sn buffer
Returns
status code
  • 0 success
  • 1 get serial number failed
Note
none

Definition at line 264 of file driver_sps30_basic.c.

Here is the call graph for this function:

◆ sps30_basic_get_status()

uint8_t sps30_basic_get_status ( uint32_t * status)

basic example get the status

Parameters
[out]*statuspointer to a status buffer
Returns
status code
  • 0 success
  • 1 get status failed
Note
none

Definition at line 305 of file driver_sps30_basic.c.

Here is the call graph for this function:

◆ sps30_basic_get_version()

uint8_t sps30_basic_get_version ( uint8_t * major,
uint8_t * minor )

basic example get the version

Parameters
[out]*majorpointer to a major buffer
[out]*minorpointer to a minor buffer
Returns
status code
  • 0 success
  • 1 get version failed
Note
none

Definition at line 285 of file driver_sps30_basic.c.

Here is the call graph for this function:

◆ sps30_basic_init()

uint8_t sps30_basic_init ( sps30_interface_t interface)

basic example init

Parameters
[in]interfacechip interface
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 49 of file driver_sps30_basic.c.

Here is the call graph for this function:

◆ sps30_basic_read()

uint8_t sps30_basic_read ( sps30_pm_t * pm)

basic example read

Parameters
[out]*pmpointer to a sps30_pm_t structure
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 144 of file driver_sps30_basic.c.

Here is the call graph for this function:

◆ sps30_basic_reset()

uint8_t sps30_basic_reset ( void )

basic example reset

Returns
status code
  • 0 success
  • 1 reset failed
Note
none

Definition at line 186 of file driver_sps30_basic.c.

Here is the call graph for this function:

◆ sps30_basic_sleep()

uint8_t sps30_basic_sleep ( void )

basic example sleep

Returns
status code
  • 0 success
  • 1 sleep failed
Note
none

Definition at line 205 of file driver_sps30_basic.c.

Here is the call graph for this function:

◆ sps30_basic_start_fan_cleaning()

uint8_t sps30_basic_start_fan_cleaning ( void )

basic example start fan cleaning

Returns
status code
  • 0 success
  • 1 start fan cleaning failed
Note
none

Definition at line 167 of file driver_sps30_basic.c.

Here is the call graph for this function:

◆ sps30_basic_wake_up()

uint8_t sps30_basic_wake_up ( void )

basic example wake up

Returns
status code
  • 0 success
  • 1 wake up failed
Note
none

Definition at line 224 of file driver_sps30_basic.c.

Here is the call graph for this function: