driver sts3x source file More...

#include "driver_sts3x.h"

Include dependency graph for driver_sts3x.c:

Macros
#define	CHIP_NAME "Sensirion STS3X"
	chip information definition
#define	MANUFACTURER_NAME "Sensirion"
#define	SUPPLY_VOLTAGE_MIN 2.4f
#define	SUPPLY_VOLTAGE_MAX 5.5f
#define	MAX_CURRENT 1.5f
#define	TEMPERATURE_MIN -40.0f
#define	TEMPERATURE_MAX 125.0f
#define	DRIVER_VERSION 1000
#define	STS3X_COMMAND_FETCH_DATA 0xE000U
	chip command definition
#define	STS3X_COMMAND_BREAK 0x3093U
#define	STS3X_COMMAND_SOFT_RESET 0x30A2U
#define	STS3X_COMMAND_HEATER_ENABLE 0x306DU
#define	STS3X_COMMAND_HEATER_DISABLE 0x3066U
#define	STS3X_COMMAND_READ_STATUS 0xF32DU
#define	STS3X_COMMAND_CLEAR_STATUS 0x3041U

Functions
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_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_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_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_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
uint8_t	sts3x_info (sts3x_info_t *info)
	get chip's information

Detailed Description

driver sts3x source 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.c.

Macro Definition Documentation

◆ CHIP_NAME

#define CHIP_NAME "Sensirion STS3X"

chip information definition

chip name

Definition at line 42 of file driver_sts3x.c.

◆ DRIVER_VERSION

#define DRIVER_VERSION 1000

driver version

Definition at line 49 of file driver_sts3x.c.

◆ MANUFACTURER_NAME

#define MANUFACTURER_NAME "Sensirion"

manufacturer name

Definition at line 43 of file driver_sts3x.c.

◆ MAX_CURRENT

#define MAX_CURRENT 1.5f

chip max current

Definition at line 46 of file driver_sts3x.c.

◆ STS3X_COMMAND_BREAK

#define STS3X_COMMAND_BREAK 0x3093U

break command

Definition at line 55 of file driver_sts3x.c.

◆ STS3X_COMMAND_CLEAR_STATUS

#define STS3X_COMMAND_CLEAR_STATUS 0x3041U

clear status command

Definition at line 60 of file driver_sts3x.c.

◆ STS3X_COMMAND_FETCH_DATA

#define STS3X_COMMAND_FETCH_DATA 0xE000U

chip command definition

fetch data command

Definition at line 54 of file driver_sts3x.c.

◆ STS3X_COMMAND_HEATER_DISABLE

#define STS3X_COMMAND_HEATER_DISABLE 0x3066U

heater disable command

Definition at line 58 of file driver_sts3x.c.

◆ STS3X_COMMAND_HEATER_ENABLE

#define STS3X_COMMAND_HEATER_ENABLE 0x306DU

heater enable command

Definition at line 57 of file driver_sts3x.c.

◆ STS3X_COMMAND_READ_STATUS

#define STS3X_COMMAND_READ_STATUS 0xF32DU

read status command

Definition at line 59 of file driver_sts3x.c.

◆ STS3X_COMMAND_SOFT_RESET

#define STS3X_COMMAND_SOFT_RESET 0x30A2U

soft reset command

Definition at line 56 of file driver_sts3x.c.

◆ SUPPLY_VOLTAGE_MAX

#define SUPPLY_VOLTAGE_MAX 5.5f

chip max supply voltage

Definition at line 45 of file driver_sts3x.c.

◆ SUPPLY_VOLTAGE_MIN

#define SUPPLY_VOLTAGE_MIN 2.4f

chip min supply voltage

Definition at line 44 of file driver_sts3x.c.

◆ TEMPERATURE_MAX

#define TEMPERATURE_MAX 125.0f

chip max operating temperature

Definition at line 48 of file driver_sts3x.c.

◆ TEMPERATURE_MIN

#define TEMPERATURE_MIN -40.0f

chip min operating temperature

Definition at line 47 of file driver_sts3x.c.

Macros

Functions