LibDriver SEN5X
Loading...
Searching...
No Matches
sen5x example driver function
sen5x driver function

sen5x example driver modules More...

Collaboration diagram for sen5x example driver function:

Macros

#define SEN5X_BASIC_DEFAULT_AUTO_CLEANING_INTERVAL   3600 * 24
 sen5x basic example default definition

Functions

uint8_t sen5x_basic_init (sen5x_type_t type)
 basic example init
uint8_t sen5x_basic_deinit (void)
 basic example deinit
uint8_t sen55_basic_read (sen55_data_t *output)
 basic example read
uint8_t sen54_basic_read (sen54_data_t *output)
 basic example read
uint8_t sen50_basic_read (sen50_data_t *output)
 basic example read
uint8_t sen55_basic_read_pm_value (sen5x_pm_t *pm)
 basic example read pm value
uint8_t sen55_basic_read_raw_value (sen5x_raw_t *raw)
 basic example read raw value
uint8_t sen5x_basic_start_fan_cleaning (void)
 basic example start fan cleaning
uint8_t sen5x_basic_reset (void)
 basic example reset
uint8_t sen5x_basic_get_product_name (char name[32])
 basic example get the product name
uint8_t sen5x_basic_get_serial_number (char sn[32])
 basic example get the serial number
uint8_t sen5x_basic_get_version (uint8_t *version)
 basic example get the version
uint8_t sen5x_basic_get_status (uint32_t *status)
 basic example get the status

Detailed Description

sen5x example driver modules

Macro Definition Documentation

◆ SEN5X_BASIC_DEFAULT_AUTO_CLEANING_INTERVAL

#define SEN5X_BASIC_DEFAULT_AUTO_CLEANING_INTERVAL   3600 * 24

sen5x basic example default definition

1 day

Definition at line 56 of file driver_sen5x_basic.h.

Function Documentation

◆ sen50_basic_read()

uint8_t sen50_basic_read ( sen50_data_t * output)

basic example read

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

Definition at line 227 of file driver_sen5x_basic.c.

Here is the call graph for this function:

◆ sen54_basic_read()

uint8_t sen54_basic_read ( sen54_data_t * output)

basic example read

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

Definition at line 205 of file driver_sen5x_basic.c.

Here is the call graph for this function:

◆ sen55_basic_read()

uint8_t sen55_basic_read ( sen55_data_t * output)

basic example read

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

Definition at line 183 of file driver_sen5x_basic.c.

Here is the call graph for this function:

◆ sen55_basic_read_pm_value()

uint8_t sen55_basic_read_pm_value ( sen5x_pm_t * pm)

basic example read pm value

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

Definition at line 161 of file driver_sen5x_basic.c.

Here is the call graph for this function:

◆ sen55_basic_read_raw_value()

uint8_t sen55_basic_read_raw_value ( sen5x_raw_t * raw)

basic example read raw value

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

Definition at line 139 of file driver_sen5x_basic.c.

Here is the call graph for this function:

◆ sen5x_basic_deinit()

uint8_t sen5x_basic_deinit ( void )

basic example deinit

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

Definition at line 110 of file driver_sen5x_basic.c.

Here is the call graph for this function:

◆ sen5x_basic_get_product_name()

uint8_t sen5x_basic_get_product_name ( char name[32])

basic example get the product name

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

Definition at line 283 of file driver_sen5x_basic.c.

Here is the call graph for this function:

◆ sen5x_basic_get_serial_number()

uint8_t sen5x_basic_get_serial_number ( char sn[32])

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 301 of file driver_sen5x_basic.c.

Here is the call graph for this function:

◆ sen5x_basic_get_status()

uint8_t sen5x_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 337 of file driver_sen5x_basic.c.

Here is the call graph for this function:

◆ sen5x_basic_get_version()

uint8_t sen5x_basic_get_version ( uint8_t * version)

basic example get the version

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

Definition at line 319 of file driver_sen5x_basic.c.

Here is the call graph for this function:

◆ sen5x_basic_init()

uint8_t sen5x_basic_init ( sen5x_type_t type)

basic example init

Parameters
[in]typechip type
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 49 of file driver_sen5x_basic.c.

Here is the call graph for this function:

◆ sen5x_basic_reset()

uint8_t sen5x_basic_reset ( void )

basic example reset

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

Definition at line 265 of file driver_sen5x_basic.c.

Here is the call graph for this function:

◆ sen5x_basic_start_fan_cleaning()

uint8_t sen5x_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 248 of file driver_sen5x_basic.c.

Here is the call graph for this function: