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

scd4x advance driver modules More...

Collaboration diagram for scd4x advance driver function:

Functions

uint8_t scd4x_measure_single_shot (scd4x_handle_t *handle)
 measure single shot
uint8_t scd4x_measure_single_shot_rht_only (scd4x_handle_t *handle)
 measure single shot rht only
uint8_t scd4x_power_down (scd4x_handle_t *handle)
 power down
uint8_t scd4x_wake_up (scd4x_handle_t *handle)
 wake up
uint8_t scd4x_set_automatic_self_calibration_initial_period (scd4x_handle_t *handle, uint16_t hour)
 set automatic self calibration initial period
uint8_t scd4x_get_automatic_self_calibration_initial_period (scd4x_handle_t *handle, uint16_t *hour)
 get automatic self calibration initial period
uint8_t scd4x_set_automatic_self_calibration_standard_period (scd4x_handle_t *handle, uint16_t hour)
 set automatic self calibration standard period
uint8_t scd4x_get_automatic_self_calibration_standard_period (scd4x_handle_t *handle, uint16_t *hour)
 get automatic self calibration standard period
uint8_t scd4x_set_automatic_self_calibration_target (scd4x_handle_t *handle, uint16_t co2_ppm)
 set automatic self calibration target
uint8_t scd4x_get_automatic_self_calibration_target (scd4x_handle_t *handle, uint16_t *co2_ppm)
 get automatic self calibration target
uint8_t scd4x_get_sensor_variant (scd4x_handle_t *handle, uint16_t *variant)
 get sensor variant

Detailed Description

scd4x advance driver modules

Function Documentation

◆ scd4x_get_automatic_self_calibration_initial_period()

uint8_t scd4x_get_automatic_self_calibration_initial_period ( scd4x_handle_t * handle,
uint16_t * hour )

get automatic self calibration initial period

Parameters
[in]*handlepointer to an scd4x handle structure
[out]*hourpointer to an hour buffer
Returns
status code
  • 0 success
  • 1 get automatic self calibration initial period failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 only scd41 and scd43 has this function
  • 5 crc is error
Note
none

Definition at line 1587 of file driver_scd4x.c.

◆ scd4x_get_automatic_self_calibration_standard_period()

uint8_t scd4x_get_automatic_self_calibration_standard_period ( scd4x_handle_t * handle,
uint16_t * hour )

get automatic self calibration standard period

Parameters
[in]*handlepointer to an scd4x handle structure
[out]*hourpointer to an hour buffer
Returns
status code
  • 0 success
  • 1 get automatic self calibration standard period failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 only scd41 and scd43 has this function
  • 5 crc is error
Note
none

Definition at line 1692 of file driver_scd4x.c.

◆ scd4x_get_automatic_self_calibration_target()

uint8_t scd4x_get_automatic_self_calibration_target ( scd4x_handle_t * handle,
uint16_t * co2_ppm )

get automatic self calibration target

Parameters
[in]*handlepointer to an scd4x handle structure
[out]*co2_ppmpointer to a ppm buffer
Returns
status code
  • 0 success
  • 1 get automatic self calibration target failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 crc is error
Note
none

Definition at line 1782 of file driver_scd4x.c.

◆ scd4x_get_sensor_variant()

uint8_t scd4x_get_sensor_variant ( scd4x_handle_t * handle,
uint16_t * variant )

get sensor variant

Parameters
[in]*handlepointer to an scd4x handle structure
[out]*variantpointer to a variant buffer
Returns
status code
  • 0 success
  • 1 get sensor variant failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 crc is error
Note
bits[15...12] = 0000 scd40 bits[15...12] = 0001 scd41 bits[15...12] = 0101 scd43

Definition at line 1828 of file driver_scd4x.c.

◆ scd4x_measure_single_shot()

uint8_t scd4x_measure_single_shot ( scd4x_handle_t * handle)

measure single shot

Parameters
[in]*handlepointer to an scd4x handle structure
Returns
status code
  • 0 success
  • 1 measure single shot failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 only scd41 and scd43 has this function
Note
none

Definition at line 1371 of file driver_scd4x.c.

◆ scd4x_measure_single_shot_rht_only()

uint8_t scd4x_measure_single_shot_rht_only ( scd4x_handle_t * handle)

measure single shot rht only

Parameters
[in]*handlepointer to an scd4x handle structure
Returns
status code
  • 0 success
  • 1 measure single shot rht only failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 only scd41 and scd43 has this function
Note
none

Definition at line 1413 of file driver_scd4x.c.

◆ scd4x_power_down()

uint8_t scd4x_power_down ( scd4x_handle_t * handle)

power down

Parameters
[in]*handlepointer to an scd4x handle structure
Returns
status code
  • 0 success
  • 1 power down failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 only scd41 and scd43 has this function
Note
none

Definition at line 1455 of file driver_scd4x.c.

◆ scd4x_set_automatic_self_calibration_initial_period()

uint8_t scd4x_set_automatic_self_calibration_initial_period ( scd4x_handle_t * handle,
uint16_t hour )

set automatic self calibration initial period

Parameters
[in]*handlepointer to an scd4x handle structure
[in]hourset hour
Returns
status code
  • 0 success
  • 1 set automatic self calibration initial period failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 only scd41 and scd43 has this function
  • 5 hour is not integer multiples of 4
Note
none

Definition at line 1533 of file driver_scd4x.c.

◆ scd4x_set_automatic_self_calibration_standard_period()

uint8_t scd4x_set_automatic_self_calibration_standard_period ( scd4x_handle_t * handle,
uint16_t hour )

set automatic self calibration standard period

Parameters
[in]*handlepointer to an scd4x handle structure
[in]hourset hour
Returns
status code
  • 0 success
  • 1 set automatic self calibration standard period failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 only scd41 and scd43 has this function
  • 5 hour is not integer multiples of 4
Note
none

Definition at line 1638 of file driver_scd4x.c.

◆ scd4x_set_automatic_self_calibration_target()

uint8_t scd4x_set_automatic_self_calibration_target ( scd4x_handle_t * handle,
uint16_t co2_ppm )

set automatic self calibration target

Parameters
[in]*handlepointer to an scd4x handle structure
[in]co2_ppmco2 in ppm
Returns
status code
  • 0 success
  • 1 set automatic self calibration target failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1741 of file driver_scd4x.c.

◆ scd4x_wake_up()

uint8_t scd4x_wake_up ( scd4x_handle_t * handle)

wake up

Parameters
[in]*handlepointer to an scd4x handle structure
Returns
status code
  • 0 success
  • 1 wake up failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 only scd41 and scd43 has this function
Note
none

Definition at line 1497 of file driver_scd4x.c.