sts3x example driver function

sts3x example driver modules More...

Collaboration diagram for sts3x example driver function:

Macros
#define	STS3X_BASIC_DEFAULT_RATE   STS3X_RATE_10HZ
	sts3x basic example default definition
#define	STS3X_BASIC_DEFAULT_REPEATABILITY   STS3X_REPEATABILITY_HIGH
#define	STS3X_BASIC_DEFAULT_HEATER   STS3X_BOOL_FALSE
#define	STS3X_SHOT_DEFAULT_CLOCK_STRETCHING   STS3X_BOOL_TRUE
	sts3x shot example default definition
#define	STS3X_SHOT_DEFAULT_REPEATABILITY   STS3X_REPEATABILITY_HIGH
#define	STS3X_SHOT_DEFAULT_HEATER   STS3X_BOOL_FALSE

Functions
uint8_t	sts3x_basic_init (sts3x_address_t addr_pin)
	basic example init
uint8_t	sts3x_basic_read (float *temperature)
	basic example read
uint8_t	sts3x_basic_deinit (void)
	basic example deinit
uint8_t	sts3x_shot_init (sts3x_address_t addr_pin)
	shot example init
uint8_t	sts3x_shot_read (float *temperature)
	shot example read
uint8_t	sts3x_shot_deinit (void)
	shot example deinit

Detailed Description

sts3x example driver modules

Macro Definition Documentation

STS3X_BASIC_DEFAULT_HEATER

#define STS3X_BASIC_DEFAULT_HEATER   STS3X_BOOL_FALSE

disable heater

Definition at line 58 of file driver_sts3x_basic.h.

STS3X_BASIC_DEFAULT_RATE

#define STS3X_BASIC_DEFAULT_RATE   STS3X_RATE_10HZ

sts3x basic example default definition

rate 100Hz

Definition at line 56 of file driver_sts3x_basic.h.

STS3X_BASIC_DEFAULT_REPEATABILITY

#define STS3X_BASIC_DEFAULT_REPEATABILITY   STS3X_REPEATABILITY_HIGH

set high

Definition at line 57 of file driver_sts3x_basic.h.

STS3X_SHOT_DEFAULT_CLOCK_STRETCHING

#define STS3X_SHOT_DEFAULT_CLOCK_STRETCHING   STS3X_BOOL_TRUE

sts3x shot example default definition

enable clock stretching

Definition at line 54 of file driver_sts3x_shot.h.

STS3X_SHOT_DEFAULT_HEATER

#define STS3X_SHOT_DEFAULT_HEATER   STS3X_BOOL_FALSE

disable heater

Definition at line 56 of file driver_sts3x_shot.h.

STS3X_SHOT_DEFAULT_REPEATABILITY

#define STS3X_SHOT_DEFAULT_REPEATABILITY   STS3X_REPEATABILITY_HIGH

set high

Definition at line 55 of file driver_sts3x_shot.h.

Function Documentation

sts3x_basic_deinit()

uint8_t sts3x_basic_deinit

(

void

)

basic example deinit

Returns

status code

• 0 success
• 1 deinit failed

Note

none

Definition at line 147 of file driver_sts3x_basic.c.

Here is the call graph for this function:

sts3x_basic_init()

uint8_t sts3x_basic_init

(

sts3x_address_t

addr_pin

)

basic example init

Parameters

[in]

addr_pin

iic device address

Returns

status code

• 0 success
• 1 init failed

Note

none

Definition at line 49 of file driver_sts3x_basic.c.

Here is the call graph for this function:

sts3x_basic_read()

uint8_t sts3x_basic_read

(

float *

temperature

)

basic example read

Parameters

[out]

*temperature

pointer to a converted temperature buffer

Returns

status code

• 0 success
• 1 read failed

Note

none

Definition at line 127 of file driver_sts3x_basic.c.

Here is the call graph for this function:

sts3x_shot_deinit()

uint8_t sts3x_shot_deinit

(

void

)

shot example deinit

Returns

status code

• 0 success
• 1 deinit failed

Note

none

Definition at line 134 of file driver_sts3x_shot.c.

Here is the call graph for this function:

sts3x_shot_init()

uint8_t sts3x_shot_init

(

sts3x_address_t

addr_pin

)

shot example init

Parameters

[in]

addr_pin

iic device address

Returns

status code

• 0 success
• 1 init failed

Note

none

Definition at line 49 of file driver_sts3x_shot.c.

Here is the call graph for this function:

sts3x_shot_read()

uint8_t sts3x_shot_read

(

float *

temperature

)

shot example read

Parameters

[out]

*temperature

pointer to a converted temperature buffer

Returns

status code

• 0 success
• 1 read failed

Note

none

Definition at line 114 of file driver_sts3x_shot.c.

Here is the call graph for this function: