LibDriver SCD4X
Loading...
Searching...
No Matches
scd4x example driver function
scd4x driver function

scd4x example driver modules More...

Collaboration diagram for scd4x example driver function:

Functions

uint8_t scd4x_basic_init (scd4x_t type)
 basic example init
uint8_t scd4x_basic_deinit (void)
 basic example deinit
uint8_t scd4x_basic_read (uint16_t *co2_ppm, float *temperature, float *humidity)
 basic example read
uint8_t scd4x_basic_get_serial_number (uint16_t num[3])
 basic example get serial number
uint8_t scd4x_basic_wake_up (void)
 basic wake up
uint8_t scd4x_basic_power_down (void)
 basic power down
uint8_t scd4x_shot_init (scd4x_t type)
 shot example init
uint8_t scd4x_shot_deinit (void)
 shot example deinit
uint8_t scd4x_shot_read (uint16_t *co2_ppm, float *temperature, float *humidity)
 shot example read
uint8_t scd4x_shot_get_serial_number (uint16_t num[3])
 shot example get serial number
uint8_t scd4x_shot_wake_up (void)
 shot wake up
uint8_t scd4x_shot_power_down (void)
 shot power down

Detailed Description

scd4x example driver modules

Function Documentation

◆ scd4x_basic_deinit()

uint8_t scd4x_basic_deinit ( void )

basic example deinit

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

Definition at line 129 of file driver_scd4x_basic.c.

Here is the call graph for this function:

◆ scd4x_basic_get_serial_number()

uint8_t scd4x_basic_get_serial_number ( uint16_t num[3])

basic example get serial number

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

Definition at line 154 of file driver_scd4x_basic.c.

Here is the call graph for this function:

◆ scd4x_basic_init()

uint8_t scd4x_basic_init ( scd4x_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_scd4x_basic.c.

Here is the call graph for this function:

◆ scd4x_basic_power_down()

uint8_t scd4x_basic_power_down ( void )

basic power down

Returns
status code
  • 0 success
  • 1 power down failed
Note
none

Definition at line 190 of file driver_scd4x_basic.c.

Here is the call graph for this function:

◆ scd4x_basic_read()

uint8_t scd4x_basic_read ( uint16_t * co2_ppm,
float * temperature,
float * humidity )

basic example read

Parameters
[out]*co2_ppmpointer to a converted co2 buffer
[out]*temperaturepointer to a converted temperature buffer
[out]*humiditypointer to a converted humidity buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
delay over 5s

Definition at line 103 of file driver_scd4x_basic.c.

Here is the call graph for this function:

◆ scd4x_basic_wake_up()

uint8_t scd4x_basic_wake_up ( void )

basic wake up

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

Definition at line 172 of file driver_scd4x_basic.c.

Here is the call graph for this function:

◆ scd4x_shot_deinit()

uint8_t scd4x_shot_deinit ( void )

shot example deinit

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

Definition at line 158 of file driver_scd4x_shot.c.

Here is the call graph for this function:

◆ scd4x_shot_get_serial_number()

uint8_t scd4x_shot_get_serial_number ( uint16_t num[3])

shot example get serial number

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

Definition at line 177 of file driver_scd4x_shot.c.

Here is the call graph for this function:

◆ scd4x_shot_init()

uint8_t scd4x_shot_init ( scd4x_t type)

shot example init

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

Definition at line 49 of file driver_scd4x_shot.c.

Here is the call graph for this function:

◆ scd4x_shot_power_down()

uint8_t scd4x_shot_power_down ( void )

shot power down

Returns
status code
  • 0 success
  • 1 power down failed
Note
none

Definition at line 213 of file driver_scd4x_shot.c.

Here is the call graph for this function:

◆ scd4x_shot_read()

uint8_t scd4x_shot_read ( uint16_t * co2_ppm,
float * temperature,
float * humidity )

shot example read

Parameters
[out]*co2_ppmpointer to a converted co2 buffer
[out]*temperaturepointer to a converted temperature buffer
[out]*humiditypointer to a converted humidity buffer
Returns
status code
  • 0 success
  • 1 read failed
  • 2 timeout
Note
none

Definition at line 94 of file driver_scd4x_shot.c.

Here is the call graph for this function:

◆ scd4x_shot_wake_up()

uint8_t scd4x_shot_wake_up ( void )

shot wake up

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

Definition at line 195 of file driver_scd4x_shot.c.

Here is the call graph for this function: