LibDriver STCC4
Loading...
Searching...
No Matches
stcc4 example driver function
stcc4 driver function

stcc4 example driver modules More...

Collaboration diagram for stcc4 example driver function:

Functions

uint8_t stcc4_basic_init (stcc4_address_t address)
 basic example init
uint8_t stcc4_basic_deinit (void)
 basic example deinit
uint8_t stcc4_basic_read (int16_t *co2_ppm, float *temperature, float *humidity)
 basic example read
uint8_t stcc4_basic_get_product_id (uint32_t *product_id, uint8_t unique_serial_number[8])
 basic example get product id
uint8_t stcc4_basic_wake_up (void)
 basic wake up
uint8_t stcc4_basic_power_down (void)
 basic power down
uint8_t stcc4_shot_init (stcc4_address_t address)
 shot example init
uint8_t stcc4_shot_deinit (void)
 shot example deinit
uint8_t stcc4_shot_read (int16_t *co2_ppm, float *temperature, float *humidity)
 shot example read
uint8_t stcc4_shot_get_product_id (uint32_t *product_id, uint8_t unique_serial_number[8])
 shot example get product id
uint8_t stcc4_shot_wake_up (void)
 shot wake up
uint8_t stcc4_shot_power_down (void)
 shot power down

Detailed Description

stcc4 example driver modules

Function Documentation

◆ stcc4_basic_deinit()

uint8_t stcc4_basic_deinit ( void )

basic example deinit

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

Definition at line 130 of file driver_stcc4_basic.c.

Here is the call graph for this function:

◆ stcc4_basic_get_product_id()

uint8_t stcc4_basic_get_product_id ( uint32_t * product_id,
uint8_t unique_serial_number[8] )

basic example get product id

Parameters
[out]*product_idpointer to a product id buffer
[out]*unique_serial_numberpointer to a unique serial number buffer
Returns
status code
  • 0 success
  • 1 get product id failed
Note
none

Definition at line 156 of file driver_stcc4_basic.c.

Here is the call graph for this function:

◆ stcc4_basic_init()

uint8_t stcc4_basic_init ( stcc4_address_t address)

basic example init

Parameters
[in]addressaddress pin
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 49 of file driver_stcc4_basic.c.

Here is the call graph for this function:

◆ stcc4_basic_power_down()

uint8_t stcc4_basic_power_down ( void )

basic power down

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

Definition at line 192 of file driver_stcc4_basic.c.

Here is the call graph for this function:

◆ stcc4_basic_read()

uint8_t stcc4_basic_read ( int16_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
none

Definition at line 103 of file driver_stcc4_basic.c.

Here is the call graph for this function:

◆ stcc4_basic_wake_up()

uint8_t stcc4_basic_wake_up ( void )

basic wake up

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

Definition at line 174 of file driver_stcc4_basic.c.

Here is the call graph for this function:

◆ stcc4_shot_deinit()

uint8_t stcc4_shot_deinit ( void )

shot example deinit

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

Definition at line 128 of file driver_stcc4_shot.c.

Here is the call graph for this function:

◆ stcc4_shot_get_product_id()

uint8_t stcc4_shot_get_product_id ( uint32_t * product_id,
uint8_t unique_serial_number[8] )

shot example get product id

Parameters
[out]*product_idpointer to a product id buffer
[out]*unique_serial_numberpointer to a unique serial number buffer
Returns
status code
  • 0 success
  • 1 get product id failed
Note
none

Definition at line 148 of file driver_stcc4_shot.c.

Here is the call graph for this function:

◆ stcc4_shot_init()

uint8_t stcc4_shot_init ( stcc4_address_t address)

shot example init

Parameters
[in]addressaddress pin
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 49 of file driver_stcc4_shot.c.

Here is the call graph for this function:

◆ stcc4_shot_power_down()

uint8_t stcc4_shot_power_down ( void )

shot power down

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

Definition at line 184 of file driver_stcc4_shot.c.

Here is the call graph for this function:

◆ stcc4_shot_read()

uint8_t stcc4_shot_read ( int16_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_stcc4_shot.c.

Here is the call graph for this function:

◆ stcc4_shot_wake_up()

uint8_t stcc4_shot_wake_up ( void )

shot wake up

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

Definition at line 166 of file driver_stcc4_shot.c.

Here is the call graph for this function: