driver sts3x header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>

Include dependency graph for driver_sts3x.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	sts3x_handle_s
	sts3x handle structure definition More...
struct	sts3x_info_s
	sts3x information structure definition More...

Macros
#define	DRIVER_STS3X_LINK_INIT(HANDLE, STRUCTURE)
	initialize sts3x_handle_t structure
#define	DRIVER_STS3X_LINK_IIC_INIT(HANDLE, FUC)
	link iic_init function
#define	DRIVER_STS3X_LINK_IIC_DEINIT(HANDLE, FUC)
	link iic_deinit function
#define	DRIVER_STS3X_LINK_IIC_READ_ADDRESS16(HANDLE, FUC)
	link iic_read_address16 function
#define	DRIVER_STS3X_LINK_IIC_WRITE_ADDRESS16(HANDLE, FUC)
	link iic_write_address16 function
#define	DRIVER_STS3X_LINK_DELAY_MS(HANDLE, FUC)
	link delay_ms function
#define	DRIVER_STS3X_LINK_DEBUG_PRINT(HANDLE, FUC)
	link debug_print function

Typedefs
typedef struct sts3x_handle_s	sts3x_handle_t
	sts3x handle structure definition
typedef struct sts3x_info_s	sts3x_info_t
	sts3x information structure definition

Enumerations
enum	sts3x_address_t { STS3X_ADDRESS_0 = (0x4A << 1) , STS3X_ADDRESS_1 = (0x4B << 1) }
	sts3x address enumeration definition More...
enum	sts3x_bool_t { STS3X_BOOL_FALSE = 0x00 , STS3X_BOOL_TRUE = 0x01 }
	sts3x bool enumeration definition More...
enum	sts3x_rate_t { STS3X_RATE_0P5HZ = 0x20 , STS3X_RATE_1HZ = 0x21 , STS3X_RATE_2HZ = 0x22 , STS3X_RATE_4HZ = 0x23 , STS3X_RATE_10HZ = 0x27 }
	sts3x rate enumeration definition More...
enum	sts3x_repeatability_t { STS3X_REPEATABILITY_HIGH = 0x00 , STS3X_REPEATABILITY_MEDIUM = 0x01 , STS3X_REPEATABILITY_LOW = 0x02 }
	sts3x repeatability enumeration definition More...
enum	sts3x_status_t { STS3X_STATUS_ALERT_PENDING_STATUS = (1 << 15) , STS3X_STATUS_HEATER_ON = (1 << 13) , STS3X_STATUS_TEMPERATURE_ALERT = (1 << 10) , STS3X_STATUS_SYSTEM_RESET = (1 << 4) , STS3X_STATUS_COMMAND_STATUS = (1 << 1) , STS3X_STATUS_CHECKSUM_STATUS = (1 << 0) }
	sts3x status enumeration definition More...

Functions
uint8_t	sts3x_info (sts3x_info_t *info)
	get chip's information
uint8_t	sts3x_set_addr_pin (sts3x_handle_t *handle, sts3x_address_t addr_pin)
	set the iic address pin
uint8_t	sts3x_get_addr_pin (sts3x_handle_t handle, sts3x_address_t addr_pin)
	get the iic address pin
uint8_t	sts3x_init (sts3x_handle_t *handle)
	initialize the chip
uint8_t	sts3x_deinit (sts3x_handle_t *handle)
	close the chip
uint8_t	sts3x_single_read (sts3x_handle_t handle, sts3x_bool_t clock_stretching_enable, uint16_t temperature_raw, float *temperature_s)
	read data once
uint8_t	sts3x_start_continuous_read (sts3x_handle_t *handle, sts3x_rate_t rate)
	start reading
uint8_t	sts3x_stop_continuous_read (sts3x_handle_t *handle)
	stop reading
uint8_t	sts3x_continuous_read (sts3x_handle_t handle, uint16_t temperature_raw, float *temperature_s)
	read data continuously
uint8_t	sts3x_get_status (sts3x_handle_t handle, uint16_t status)
	get the current status
uint8_t	sts3x_clear_status (sts3x_handle_t *handle)
	clear the current status
uint8_t	sts3x_set_repeatability (sts3x_handle_t *handle, sts3x_repeatability_t repeatability)
	set the measurement repeatability
uint8_t	sts3x_get_repeatability (sts3x_handle_t handle, sts3x_repeatability_t repeatability)
	get the measurement repeatability
uint8_t	sts3x_soft_reset (sts3x_handle_t *handle)
	soft reset the chip
uint8_t	sts3x_set_heater (sts3x_handle_t *handle, sts3x_bool_t enable)
	enable or disable the chip heater
uint8_t	sts3x_set_reg (sts3x_handle_t *handle, uint16_t command)
	set the chip register
uint8_t	sts3x_get_reg (sts3x_handle_t handle, uint16_t command, uint8_t buf, uint16_t len)
	get the chip register

Detailed Description

driver sts3x header file

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version: 1.0.0

Author: Shifeng Li

Date: 2024-09-30

history

Date	Version	Author	Description
2024/09/30	1.0	Shifeng Li	first upload

Definition in file driver_sts3x.h.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

history