driver scd4x header file More...

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

Include dependency graph for driver_scd4x.h:

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

Data Structures
struct	scd4x_handle_s
	scd4x handle structure definition More...
struct	scd4x_info_s
	scd4x information structure definition More...

Macros
#define	DRIVER_SCD4X_LINK_INIT(HANDLE, STRUCTURE)
	initialize scd4x_handle_t structure
#define	DRIVER_SCD4X_LINK_IIC_INIT(HANDLE, FUC)
	link iic_init function
#define	DRIVER_SCD4X_LINK_IIC_DEINIT(HANDLE, FUC)
	link iic_deinit function
#define	DRIVER_SCD4X_LINK_IIC_READ_COMMAND(HANDLE, FUC)
	link iic_read_cmd function
#define	DRIVER_SCD4X_LINK_IIC_WRITE_COMMAND(HANDLE, FUC)
	link iic_write_cmd function
#define	DRIVER_SCD4X_LINK_DELAY_MS(HANDLE, FUC)
	link delay_ms function
#define	DRIVER_SCD4X_LINK_DEBUG_PRINT(HANDLE, FUC)
	link debug_print function

Typedefs
typedef struct scd4x_handle_s	scd4x_handle_t
	scd4x handle structure definition
typedef struct scd4x_info_s	scd4x_info_t
	scd4x information structure definition

Enumerations
enum	scd4x_t { SCD40 = 0x00 , SCD41 = 0x01 , SCD43 = 0x02 }
	scd4x type enumeration definition More...
enum	scd4x_bool_t { SCD4X_BOOL_FALSE = 0x00 , SCD4X_BOOL_TRUE = 0x01 }
	scd4x bool enumeration definition More...

Functions
uint8_t	scd4x_info (scd4x_info_t *info)
	get chip information
uint8_t	scd4x_set_type (scd4x_handle_t *handle, scd4x_t type)
	set type
uint8_t	scd4x_get_type (scd4x_handle_t handle, scd4x_t type)
	get type
uint8_t	scd4x_init (scd4x_handle_t *handle)
	initialize the chip
uint8_t	scd4x_deinit (scd4x_handle_t *handle)
	close the chip
uint8_t	scd4x_start_periodic_measurement (scd4x_handle_t *handle)
	start periodic measurement
uint8_t	scd4x_read (scd4x_handle_t handle, uint16_t co2_raw, uint16_t co2_ppm, uint16_t temperature_raw, float temperature_s, uint16_t humidity_raw, float *humidity_s)
	read data
uint8_t	scd4x_stop_periodic_measurement (scd4x_handle_t *handle)
	stop periodic measurement
uint8_t	scd4x_set_temperature_offset (scd4x_handle_t *handle, uint16_t offset)
	set temperature offset
uint8_t	scd4x_get_temperature_offset (scd4x_handle_t handle, uint16_t offset)
	get temperature offset
uint8_t	scd4x_temperature_offset_convert_to_register (scd4x_handle_t handle, float degrees, uint16_t reg)
	convert the temperature offset to the register raw data
uint8_t	scd4x_temperature_offset_convert_to_data (scd4x_handle_t handle, uint16_t reg, float degrees)
	convert the register raw data to the temperature offset
uint8_t	scd4x_set_sensor_altitude (scd4x_handle_t *handle, uint16_t altitude)
	set sensor altitude
uint8_t	scd4x_get_sensor_altitude (scd4x_handle_t handle, uint16_t altitude)
	get sensor altitude
uint8_t	scd4x_sensor_altitude_convert_to_register (scd4x_handle_t handle, float m, uint16_t reg)
	convert the sensor altitude to the register raw data
uint8_t	scd4x_sensor_altitude_convert_to_data (scd4x_handle_t handle, uint16_t reg, float m)
	convert the register raw data to the sensor altitude
uint8_t	scd4x_set_ambient_pressure (scd4x_handle_t *handle, uint16_t pressure)
	set ambient pressure
uint8_t	scd4x_get_ambient_pressure (scd4x_handle_t handle, uint16_t pressure)
	get ambient pressure
uint8_t	scd4x_ambient_pressure_convert_to_register (scd4x_handle_t handle, float pa, uint16_t reg)
	convert the ambient pressure to the register raw data
uint8_t	scd4x_ambient_pressure_convert_to_data (scd4x_handle_t handle, uint16_t reg, float pa)
	convert the register raw data to the ambient pressure
uint8_t	scd4x_perform_forced_recalibration (scd4x_handle_t handle, uint16_t co2_raw, uint16_t frc)
	perform forced recalibration
uint8_t	scd4x_co2_convert_to_register (scd4x_handle_t handle, float ppm, uint16_t reg)
	convert the co2 to the register raw data
uint8_t	scd4x_co2_convert_to_data (scd4x_handle_t handle, uint16_t reg, float ppm)
	convert the register raw data to the co2
uint8_t	scd4x_set_automatic_self_calibration (scd4x_handle_t *handle, scd4x_bool_t enable)
	enable or disable automatic self calibration
uint8_t	scd4x_get_automatic_self_calibration (scd4x_handle_t handle, scd4x_bool_t enable)
	get automatic self calibration status
uint8_t	scd4x_start_low_power_periodic_measurement (scd4x_handle_t *handle)
	start low power periodic measurement
uint8_t	scd4x_get_data_ready_status (scd4x_handle_t handle, scd4x_bool_t enable)
	get data ready status
uint8_t	scd4x_persist_settings (scd4x_handle_t *handle)
	persist settings
uint8_t	scd4x_get_serial_number (scd4x_handle_t *handle, uint16_t number[3])
	get serial number
uint8_t	scd4x_perform_self_test (scd4x_handle_t handle, scd4x_bool_t malfunction_detected)
	perform self test
uint8_t	scd4x_perform_factory_reset (scd4x_handle_t *handle)
	perform factory reset
uint8_t	scd4x_reinit (scd4x_handle_t *handle)
	reinit
uint8_t	scd4x_measure_single_shot (scd4x_handle_t *handle)
	measure single shot
uint8_t	scd4x_measure_single_shot_rht_only (scd4x_handle_t *handle)
	measure single shot rht only
uint8_t	scd4x_power_down (scd4x_handle_t *handle)
	power down
uint8_t	scd4x_wake_up (scd4x_handle_t *handle)
	wake up
uint8_t	scd4x_set_automatic_self_calibration_initial_period (scd4x_handle_t *handle, uint16_t hour)
	set automatic self calibration initial period
uint8_t	scd4x_get_automatic_self_calibration_initial_period (scd4x_handle_t handle, uint16_t hour)
	get automatic self calibration initial period
uint8_t	scd4x_set_automatic_self_calibration_standard_period (scd4x_handle_t *handle, uint16_t hour)
	set automatic self calibration standard period
uint8_t	scd4x_get_automatic_self_calibration_standard_period (scd4x_handle_t handle, uint16_t hour)
	get automatic self calibration standard period
uint8_t	scd4x_set_reg (scd4x_handle_t handle, uint16_t reg, uint8_t buf, uint16_t len)
	set the chip register
uint8_t	scd4x_get_reg (scd4x_handle_t handle, uint16_t reg, uint8_t buf, uint16_t len, uint16_t delay_ms)
	get the chip register

Detailed Description

driver scd4x 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: 2023-09-25

history

Date	Version	Author	Description
2023/09/25	1.0	Shifeng Li	first upload

Definition in file driver_scd4x.h.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

history