LibDriver SHT30
Loading...
Searching...
No Matches
sht30 example driver function
sht30 driver function

sht30 example driver modules More...

Collaboration diagram for sht30 example driver function:

Macros

#define SHT30_ALERT_DEFAULT_RATE   SHT30_RATE_10HZ
 sht30 alert example default definition
#define SHT30_ALERT_DEFAULT_REPEATABILITY   SHT30_REPEATABILITY_HIGH
#define SHT30_ALERT_DEFAULT_HEATER   SHT30_BOOL_FALSE
#define SHT30_BASIC_DEFAULT_RATE   SHT30_RATE_10HZ
 sht30 basic example default definition
#define SHT30_BASIC_DEFAULT_REPEATABILITY   SHT30_REPEATABILITY_HIGH
#define SHT30_BASIC_DEFAULT_HEATER   SHT30_BOOL_FALSE
#define SHT30_SHOT_DEFAULT_CLOCK_STRETCHING   SHT30_BOOL_TRUE
 sht30 shot example default definition
#define SHT30_SHOT_DEFAULT_REPEATABILITY   SHT30_REPEATABILITY_HIGH
#define SHT30_SHOT_DEFAULT_HEATER   SHT30_BOOL_FALSE

Functions

uint8_t sht30_alert_irq_handler (void)
 alert irq
uint8_t sht30_alert_init (sht30_address_t addr_pin, void(*callback)(uint16_t type), float high_limit_temperature_set, float high_limit_humidity_set, float high_limit_temperature_clear, float high_limit_humidity_clear, float low_limit_temperature_set, float low_limit_humidity_set, float low_limit_temperature_clear, float low_limit_humidity_clear)
 alert example init
uint8_t sht30_alert_read (float *temperature, float *humidity)
 alert example read
uint8_t sht30_alert_deinit (void)
 alert example deinit
uint8_t sht30_alert_get_serial_number (uint8_t sn[4])
 alert example get serial number
uint8_t sht30_basic_init (sht30_address_t addr_pin)
 basic example init
uint8_t sht30_basic_read (float *temperature, float *humidity)
 basic example read
uint8_t sht30_basic_deinit (void)
 basic example deinit
uint8_t sht30_basic_get_serial_number (uint8_t sn[4])
 basic example get serial number
uint8_t sht30_shot_init (sht30_address_t addr_pin)
 shot example init
uint8_t sht30_shot_read (float *temperature, float *humidity)
 shot example read
uint8_t sht30_shot_deinit (void)
 shot example deinit
uint8_t sht30_shot_get_serial_number (uint8_t sn[4])
 shot example get serial number

Detailed Description

sht30 example driver modules

Macro Definition Documentation

◆ SHT30_ALERT_DEFAULT_HEATER

#define SHT30_ALERT_DEFAULT_HEATER   SHT30_BOOL_FALSE

disable heater

Definition at line 57 of file driver_sht30_alert.h.

◆ SHT30_ALERT_DEFAULT_RATE

#define SHT30_ALERT_DEFAULT_RATE   SHT30_RATE_10HZ

sht30 alert example default definition

rate 100Hz

Definition at line 55 of file driver_sht30_alert.h.

◆ SHT30_ALERT_DEFAULT_REPEATABILITY

#define SHT30_ALERT_DEFAULT_REPEATABILITY   SHT30_REPEATABILITY_HIGH

set high

Definition at line 56 of file driver_sht30_alert.h.

◆ SHT30_BASIC_DEFAULT_HEATER

#define SHT30_BASIC_DEFAULT_HEATER   SHT30_BOOL_FALSE

disable heater

Definition at line 59 of file driver_sht30_basic.h.

◆ SHT30_BASIC_DEFAULT_RATE

#define SHT30_BASIC_DEFAULT_RATE   SHT30_RATE_10HZ

sht30 basic example default definition

rate 100Hz

Definition at line 57 of file driver_sht30_basic.h.

◆ SHT30_BASIC_DEFAULT_REPEATABILITY

#define SHT30_BASIC_DEFAULT_REPEATABILITY   SHT30_REPEATABILITY_HIGH

set high

Definition at line 58 of file driver_sht30_basic.h.

◆ SHT30_SHOT_DEFAULT_CLOCK_STRETCHING

#define SHT30_SHOT_DEFAULT_CLOCK_STRETCHING   SHT30_BOOL_TRUE

sht30 shot example default definition

enable clock stretching

Definition at line 55 of file driver_sht30_shot.h.

◆ SHT30_SHOT_DEFAULT_HEATER

#define SHT30_SHOT_DEFAULT_HEATER   SHT30_BOOL_FALSE

disable heater

Definition at line 57 of file driver_sht30_shot.h.

◆ SHT30_SHOT_DEFAULT_REPEATABILITY

#define SHT30_SHOT_DEFAULT_REPEATABILITY   SHT30_REPEATABILITY_HIGH

set high

Definition at line 56 of file driver_sht30_shot.h.

Function Documentation

◆ sht30_alert_deinit()

uint8_t sht30_alert_deinit ( void )

alert example deinit

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

Definition at line 266 of file driver_sht30_alert.c.

Here is the call graph for this function:

◆ sht30_alert_get_serial_number()

uint8_t sht30_alert_get_serial_number ( uint8_t sn[4])

alert example get serial number

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

Definition at line 297 of file driver_sht30_alert.c.

Here is the call graph for this function:

◆ sht30_alert_init()

uint8_t sht30_alert_init ( sht30_address_t addr_pin,
void(* callback )(uint16_t type),
float high_limit_temperature_set,
float high_limit_humidity_set,
float high_limit_temperature_clear,
float high_limit_humidity_clear,
float low_limit_temperature_set,
float low_limit_humidity_set,
float low_limit_temperature_clear,
float low_limit_humidity_clear )

alert example init

Parameters
[in]addr_piniic device address
[in]*callbackpointer to a callback address
[in]high_limit_temperature_sethigh limit temperature set
[in]high_limit_humidity_sethigh limit humidity set
[in]high_limit_temperature_clearhigh limit temperature clear
[in]high_limit_humidity_clearhigh limit humidity clear
[in]low_limit_temperature_setlow limit temperature set
[in]low_limit_humidity_setlow limit humidity set
[in]low_limit_temperature_clearlow limit temperature clear
[in]low_limit_humidity_clearlow limit humidity clear
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 76 of file driver_sht30_alert.c.

Here is the call graph for this function:

◆ sht30_alert_irq_handler()

uint8_t sht30_alert_irq_handler ( void )

alert irq

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

Definition at line 49 of file driver_sht30_alert.c.

Here is the call graph for this function:

◆ sht30_alert_read()

uint8_t sht30_alert_read ( float * temperature,
float * humidity )

alert example read

Parameters
[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 245 of file driver_sht30_alert.c.

Here is the call graph for this function:

◆ sht30_basic_deinit()

uint8_t sht30_basic_deinit ( void )

basic example deinit

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

Definition at line 164 of file driver_sht30_basic.c.

Here is the call graph for this function:

◆ sht30_basic_get_serial_number()

uint8_t sht30_basic_get_serial_number ( uint8_t sn[4])

basic example get serial number

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

Definition at line 195 of file driver_sht30_basic.c.

Here is the call graph for this function:

◆ sht30_basic_init()

uint8_t sht30_basic_init ( sht30_address_t addr_pin)

basic example init

Parameters
[in]addr_piniic device address
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 50 of file driver_sht30_basic.c.

Here is the call graph for this function:

◆ sht30_basic_read()

uint8_t sht30_basic_read ( float * temperature,
float * humidity )

basic example read

Parameters
[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 143 of file driver_sht30_basic.c.

Here is the call graph for this function:

◆ sht30_shot_deinit()

uint8_t sht30_shot_deinit ( void )

shot example deinit

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

Definition at line 152 of file driver_sht30_shot.c.

Here is the call graph for this function:

◆ sht30_shot_get_serial_number()

uint8_t sht30_shot_get_serial_number ( uint8_t sn[4])

shot example get serial number

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

Definition at line 171 of file driver_sht30_shot.c.

Here is the call graph for this function:

◆ sht30_shot_init()

uint8_t sht30_shot_init ( sht30_address_t addr_pin)

shot example init

Parameters
[in]addr_piniic device address
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 50 of file driver_sht30_shot.c.

Here is the call graph for this function:

◆ sht30_shot_read()

uint8_t sht30_shot_read ( float * temperature,
float * humidity )

shot example read

Parameters
[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 130 of file driver_sht30_shot.c.

Here is the call graph for this function: