scd30_sensor.h

Go to the documentation of this file.

 
#ifndef __SCD3O_SENSOR_H__
#define __SCD3O_SENSOR_H__
 
#include <stddef.h>
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "rom/ets_sys.h"
#include "esp_err.h"
#include "i2c_bus.h"
#include "pal_log.h"

 
#define SCD30_I2C_ADDR (0x61) 
 
#ifdef __cplusplus
extern "C" {
#endif

typedef uint16_t p_mbar_t;

typedef uint16_t i_sec_t;

typedef uint16_t uco2_ppm_t;

typedef uint16_t tx100_celsius_t;

typedef uint16_t alt_m_t;

typedef float t_celsius_t;

typedef float rh_percent_t;

typedef float co2_ppm_t;

typedef uint8_t i2c_addr_t;

typedef struct {
    i2c_bus_device_handle_t i2c_dev; 
    i2c_addr_t dev_addr;             
} scd30_dev_t;

typedef void* scd30_handle_t;

scd30_handle_t scd30_i2c_create(i2c_bus_handle_t bus, i2c_addr_t dev_addr);

scd30_handle_t scd30_i2c_init(i2c_bus_handle_t bus, i2c_addr_t dev_addr);

void scd30_i2c_delete(scd30_handle_t sensor);

esp_err_t scd30_i2c_trigger_continuous_measurement(
    scd30_handle_t sensor,
    p_mbar_t p_comp
);

esp_err_t scd30_i2c_stop_continuous_measurement(scd30_handle_t sensor);

esp_err_t scd30_i2c_read_measurement_interval(
    scd30_handle_t sensor,
    i_sec_t *interval
);

esp_err_t scd30_i2c_write_measurement_interval(
    scd30_handle_t sensor,
    i_sec_t interval
);

esp_err_t scd30_i2c_read_data_ready_status(
    scd30_handle_t sensor,
    bool *data_ready
);

esp_err_t scd30_i2c_read_measurement(
    scd30_handle_t sensor,
    co2_ppm_t *co2,
    t_celsius_t *temperature,
    rh_percent_t *humidity
);

esp_err_t scd30_i2c_read_automatic_self_calibration(
    scd30_handle_t sensor,
    bool *enabled
);

esp_err_t scd30_i2c_write_automatic_self_calibration(
    scd30_handle_t sensor,
    bool enabled
);

esp_err_t scd30_i2c_read_forced_recalibration_value(
    scd30_handle_t sensor,
    uco2_ppm_t *frc
);

esp_err_t scd30_i2c_write_forced_recalibration_value(
    scd30_handle_t sensor,
    uco2_ppm_t target
);

esp_err_t scd30_i2c_read_temperature_offset_ticks(
    scd30_handle_t sensor,
    tx100_celsius_t *offset
);

esp_err_t scd30_i2c_read_temperature_offset(
    scd30_handle_t sensor,
    t_celsius_t *offset
);

esp_err_t scd30_i2c_write_temperature_offset_ticks(
    scd30_handle_t sensor,
    tx100_celsius_t offset
);

esp_err_t scd30_i2c_write_temperature_offset(
    scd30_handle_t sensor,
    t_celsius_t offset
);

esp_err_t scd30_i2c_read_sensor_altitude(
    scd30_handle_t sensor,
    alt_m_t *altitude
);

esp_err_t scd30_i2c_write_sensor_altitude(
    scd30_handle_t sensor,
    alt_m_t altitude
);

esp_err_t scd30_i2c_read_firmware_version(
    scd30_handle_t sensor,
    uint16_t *firmware_version
);

esp_err_t scd30_i2c_soft_reset(scd30_handle_t sensor);
 
#ifdef __cplusplus
}
#endif
 // end of scd30 group
 
#endif // __SCD3O_SENSOR_H__