aht21 base driver function

aht21 base driver modules More...

Collaboration diagram for aht21 base driver function:

Data Structures
struct	aht21_handle_s
	aht21 handle structure definition More...
struct	aht21_info_s
	aht21 information structure definition More...

Typedefs
typedef struct aht21_handle_s	aht21_handle_t
	aht21 handle structure definition
typedef struct aht21_info_s	aht21_info_t
	aht21 information structure definition

Functions
uint8_t	aht21_info (aht21_info_t *info)
	get chip's information
uint8_t	aht21_init (aht21_handle_t *handle)
	initialize the chip
uint8_t	aht21_deinit (aht21_handle_t *handle)
	close the chip
uint8_t	aht21_read_temperature_humidity (aht21_handle_t *handle, uint32_t *temperature_raw, float *temperature_s, uint32_t *humidity_raw, uint8_t *humidity_s)
	read the temperature and humidity data
uint8_t	aht21_read_temperature (aht21_handle_t *handle, uint32_t *temperature_raw, float *temperature_s)
	read the temperature
uint8_t	aht21_read_humidity (aht21_handle_t *handle, uint32_t *humidity_raw, uint8_t *humidity_s)
	read the humidity data

Detailed Description

aht21 base driver modules

Typedef Documentation

aht21_handle_t

typedef struct aht21_handle_s aht21_handle_t

aht21 handle structure definition

aht21_info_t

typedef struct aht21_info_s aht21_info_t

aht21 information structure definition

Function Documentation

aht21_deinit()

uint8_t aht21_deinit

(

aht21_handle_t *

handle

)

close the chip

Parameters

[in]

*handle

pointer to an aht21 handle structure

Returns

status code

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

Note

none

Definition at line 275 of file driver_aht21.c.

aht21_info()

uint8_t aht21_info

(

aht21_info_t *

info

)

get chip's information

Parameters

[out]

*info

pointer to an aht21 info structure

Returns

status code

• 0 success
• 2 handle is NULL

Note

none

Definition at line 610 of file driver_aht21.c.

aht21_init()

uint8_t aht21_init

(

aht21_handle_t *

handle

)

initialize the chip

Parameters

[in]

*handle

pointer to an aht21 handle structure

Returns

status code

• 0 success
• 1 iic failed
• 2 handle is NULL
• 3 linked functions is NULL
• 4 read status failed
• 5 reset reg failed

Note

none

Definition at line 178 of file driver_aht21.c.

aht21_read_humidity()

uint8_t aht21_read_humidity	(	aht21_handle_t *	handle,
		uint32_t *	humidity_raw,
		uint8_t *	humidity_s )

read the humidity data

Parameters

[in]	*handle	pointer to an aht21 handle structure
[out]	*humidity_raw	pointer to a raw humidity buffer
[out]	*humidity_s	pointer to a converted humidity buffer

Returns

status code

• 0 success
• 1 read humidity failed
• 2 handle is NULL
• 3 handle is not initialized
• 4 data is not ready
• 5 crc is error

Note

none

Definition at line 474 of file driver_aht21.c.

aht21_read_temperature()

uint8_t aht21_read_temperature	(	aht21_handle_t *	handle,
		uint32_t *	temperature_raw,
		float *	temperature_s )

read the temperature

Parameters

[in]	*handle	pointer to an aht21 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 temperature failed
• 2 handle is NULL
• 3 handle is not initialized
• 4 data is not ready
• 5 crc is error

Note

none

Definition at line 397 of file driver_aht21.c.

aht21_read_temperature_humidity()

uint8_t aht21_read_temperature_humidity	(	aht21_handle_t *	handle,
		uint32_t *	temperature_raw,
		float *	temperature_s,
		uint32_t *	humidity_raw,
		uint8_t *	humidity_s )

read the temperature and humidity data

Parameters

[in]	*handle	pointer to an aht21 handle structure
[out]	*temperature_raw	pointer to a raw temperature buffer
[out]	*temperature_s	pointer to a converted temperature buffer
[out]	*humidity_raw	pointer to a raw humidity buffer
[out]	*humidity_s	pointer to a converted humidity buffer

Returns

status code

• 0 success
• 1 read temperature humidity failed
• 2 handle is NULL
• 3 handle is not initialized
• 4 data is not ready
• 5 crc is error

Note

none

Definition at line 313 of file driver_aht21.c.