sts21 base driver modules More...

Collaboration diagram for sts21 base driver function:

Data Structures
struct	sts21_handle_s
	sts21 handle structure definition More...
struct	sts21_info_s
	sts21 information structure definition More...

Typedefs
typedef struct sts21_handle_s	sts21_handle_t
	sts21 handle structure definition
typedef struct sts21_info_s	sts21_info_t
	sts21 information structure definition

Enumerations
enum	sts21_bool_t { STS21_BOOL_FALSE = 0x00 , STS21_BOOL_TRUE = 0x01 }
	sts21 bool enumeration definition More...
enum	sts21_status_t { SHT35_STATUS_VDD_OVER_2P25V = 0 , SHT35_STATUS_VDD_LESS_2P25V = 1 }
	sts21 status enumeration definition More...
enum	sts21_mode_t { STS21_MODE_HOLD_MASTER = 0x00 , STS21_MODE_NO_HOLD_MASTER = 0x01 }
	sts21 mode enumeration definition More...
enum	sts21_resolution_t { STS21_RESOLUTION_T_14BIT = 0x00 , STS21_RESOLUTION_T_12BIT = 0x01 , STS21_RESOLUTION_T_13BIT = 0x02 , STS21_RESOLUTION_T_11BIT = 0x03 }
	sts21 resolution enumeration definition More...

Functions
uint8_t	sts21_info (sts21_info_t *info)
	get chip's information
uint8_t	sts21_init (sts21_handle_t *handle)
	initialize the chip
uint8_t	sts21_deinit (sts21_handle_t *handle)
	close the chip
uint8_t	sts21_read (sts21_handle_t handle, uint16_t temperature_raw, float *temperature_s)
	read data
uint8_t	sts21_set_mode (sts21_handle_t *handle, sts21_mode_t mode)
	set chip mode
uint8_t	sts21_get_mode (sts21_handle_t handle, sts21_mode_t mode)
	get chip mode
uint8_t	sts21_soft_reset (sts21_handle_t *handle)
	soft reset the chip
uint8_t	sts21_set_resolution (sts21_handle_t *handle, sts21_resolution_t resolution)
	set resolution
uint8_t	sts21_get_resolution (sts21_handle_t handle, sts21_resolution_t resolution)
	get resolution
uint8_t	sts21_set_heater (sts21_handle_t *handle, sts21_bool_t enable)
	enable or disable heater
uint8_t	sts21_get_heater (sts21_handle_t handle, sts21_bool_t enable)
	get heater status
uint8_t	sts21_set_disable_otp_reload (sts21_handle_t *handle, sts21_bool_t enable)
	enable or disable disable otp reload
uint8_t	sts21_get_disable_otp_reload (sts21_handle_t handle, sts21_bool_t enable)
	get disable otp reload status
uint8_t	sts21_get_status (sts21_handle_t handle, sts21_status_t status)
	get status
uint8_t	sts21_get_serial_number (sts21_handle_t *handle, uint8_t sn[8])
	get serial number

Detailed Description

sts21 base driver modules

Typedef Documentation

◆ sts21_handle_t

typedef struct sts21_handle_s sts21_handle_t

sts21 handle structure definition

◆ sts21_info_t

typedef struct sts21_info_s sts21_info_t

sts21 information structure definition

Enumeration Type Documentation

◆ sts21_bool_t

enum sts21_bool_t

sts21 bool enumeration definition

Enumerator
STS21_BOOL_FALSE	disable
STS21_BOOL_TRUE	enable

Definition at line 62 of file driver_sts21.h.

◆ sts21_mode_t

enum sts21_mode_t

sts21 mode enumeration definition

Enumerator
STS21_MODE_HOLD_MASTER	hold master mode
STS21_MODE_NO_HOLD_MASTER	no hold master mode

Definition at line 80 of file driver_sts21.h.

◆ sts21_resolution_t

enum sts21_resolution_t

sts21 resolution enumeration definition

Enumerator
STS21_RESOLUTION_T_14BIT	resolution t 14bit
STS21_RESOLUTION_T_12BIT	resolution t 12bit
STS21_RESOLUTION_T_13BIT	resolution t 13bit
STS21_RESOLUTION_T_11BIT	resolution t 11bit

Definition at line 89 of file driver_sts21.h.

◆ sts21_status_t

enum sts21_status_t

sts21 status enumeration definition

Enumerator
SHT35_STATUS_VDD_OVER_2P25V	vdd > 2.25v
SHT35_STATUS_VDD_LESS_2P25V	vdd < 2.25v

Definition at line 71 of file driver_sts21.h.

Function Documentation

◆ sts21_deinit()

uint8_t sts21_deinit ( sts21_handle_t * handle )

close the chip

Parameters

[in] *handle pointer to a sts21 handle structure

Returns

status code

0 success
1 iic deinit failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 334 of file driver_sts21.c.

◆ sts21_get_disable_otp_reload()

uint8_t sts21_get_disable_otp_reload	(	sts21_handle_t *	handle,
		sts21_bool_t *	enable )

get disable otp reload status

Parameters

[in]	*handle	pointer to a sts21 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

0 success
1 get disable otp reload failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 643 of file driver_sts21.c.

◆ sts21_get_heater()

uint8_t sts21_get_heater	(	sts21_handle_t *	handle,
		sts21_bool_t *	enable )

get heater status

Parameters

[in]	*handle	pointer to a sts21 handle structure
[out]	*enable	pointer to bool value buffer

Returns

status code

0 success
1 get heater failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 556 of file driver_sts21.c.

◆ sts21_get_mode()

uint8_t sts21_get_mode	(	sts21_handle_t *	handle,
		sts21_mode_t *	mode )

get chip mode

Parameters

[in]	*handle	pointer to a sts21 handle structure
[out]	*mode	pointer to a chip mode buffer

Returns

status code

0 success
1 get mode failed
2 handle is NULL

Note: none

Definition at line 746 of file driver_sts21.c.

◆ sts21_get_resolution()

uint8_t sts21_get_resolution	(	sts21_handle_t *	handle,
		sts21_resolution_t *	resolution )

get resolution

Parameters

[in]	*handle	pointer to a sts21 handle structure
[out]	*resolution	pointer to a resolution buffer

Returns

status code

0 success
1 get resolution failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 467 of file driver_sts21.c.

◆ sts21_get_serial_number()

uint8_t sts21_get_serial_number	(	sts21_handle_t *	handle,
		uint8_t	sn[8] )

get serial number

Parameters

[in]	*handle	pointer to a sts21 handle structure
[out]	*sn	pointer to a serial number buffer

Returns

status code

0 success
1 get serial number failed
2 handle is NULL
3 handle is not initialized
4 crc check failed

Note: none

Definition at line 869 of file driver_sts21.c.

◆ sts21_get_status()

uint8_t sts21_get_status	(	sts21_handle_t *	handle,
		sts21_status_t *	status )

get status

Parameters

[in]	*handle	pointer to a sts21 handle structure
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 get status failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 682 of file driver_sts21.c.

◆ sts21_info()

uint8_t sts21_info ( sts21_info_t * info )

get chip's information

Parameters

[out] *info pointer to a sts21 info structure

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 1090 of file driver_sts21.c.

◆ sts21_init()

uint8_t sts21_init ( sts21_handle_t * handle )

initialize the chip

Parameters

[in] *handle pointer to a sts21 handle structure

Returns

status code

0 success
1 iic initialization failed
2 handle is NULL
3 linked functions is NULL

Note: none

Definition at line 234 of file driver_sts21.c.

◆ sts21_read()

uint8_t sts21_read	(	sts21_handle_t *	handle,
		uint16_t *	temperature_raw,
		float *	temperature_s )

read data

Parameters

[in]	*handle	pointer to a sts21 handle structure
[out]	*temperature_raw	pointer to a raw temperature buffer
[out]	*temperature_s	pointer to a converted temperature buffer

Returns

status code

0 success
1 read failed
2 handle is NULL
3 handle is not initialized
4 crc check failed

Note: none

Definition at line 775 of file driver_sts21.c.

◆ sts21_set_disable_otp_reload()

uint8_t sts21_set_disable_otp_reload	(	sts21_handle_t *	handle,
		sts21_bool_t	enable )

enable or disable disable otp reload

Parameters

[in]	*handle	pointer to a sts21 handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set disable otp reload failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 595 of file driver_sts21.c.

◆ sts21_set_heater()

uint8_t sts21_set_heater	(	sts21_handle_t *	handle,
		sts21_bool_t	enable )

enable or disable heater

Parameters

[in]	*handle	pointer to a sts21 handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set heater failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 508 of file driver_sts21.c.

◆ sts21_set_mode()

uint8_t sts21_set_mode	(	sts21_handle_t *	handle,
		sts21_mode_t	mode )

set chip mode

Parameters

[in]	*handle	pointer to a sts21 handle structure
[in]	mode	chip mode

Returns

status code

0 success
1 set mode failed
2 handle is NULL

Note: none

Definition at line 720 of file driver_sts21.c.

◆ sts21_set_resolution()

uint8_t sts21_set_resolution	(	sts21_handle_t *	handle,
		sts21_resolution_t	resolution )

set resolution

Parameters

[in]	*handle	pointer to a sts21 handle structure
[in]	resolution	chip resolution

Returns

status code

0 success
1 set resolution failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 416 of file driver_sts21.c.

◆ sts21_soft_reset()

uint8_t sts21_soft_reset ( sts21_handle_t * handle )

soft reset the chip

Parameters

[in] *handle pointer to a sts21 handle structure

Returns

status code

0 success
1 soft reset failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 378 of file driver_sts21.c.

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ sts21_handle_t

◆ sts21_info_t

Enumeration Type Documentation

◆ sts21_bool_t

◆ sts21_mode_t

◆ sts21_resolution_t

◆ sts21_status_t

Function Documentation

◆ sts21_deinit()

◆ sts21_get_disable_otp_reload()

◆ sts21_get_heater()

◆ sts21_get_mode()

◆ sts21_get_resolution()

◆ sts21_get_serial_number()

◆ sts21_get_status()

◆ sts21_info()

◆ sts21_init()

◆ sts21_read()

◆ sts21_set_disable_otp_reload()

◆ sts21_set_heater()

◆ sts21_set_mode()

◆ sts21_set_resolution()

◆ sts21_soft_reset()