hvac.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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.
****************************************************************************/
 
#ifndef HVAC_H
#define HVAC_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_uart.h"
 
#define HVAC_START_PERIODIC_MEASUREMENT                             0x21B1
#define HVAC_START_LOW_POWER_PERIODIC_MEASUREMENT                   0x21AC
#define HVAC_START_ULTRA_LOW_POWER_PERIODIC_MEASUREMENT             0x21A7
#define HVAC_MEASURE_SINGLE_SHOT                                    0x219D
#define HVAC_MEASURE_SINGLE_SHOT_RHT_ONLY                           0x2196
#define HVAC_READ_MEASUREMENT                                       0xEC05
#define HVAC_STOP_PERIODIC_MEASUREMENT                              0x3F86
#define HVAC_GET_SERIAL_NUMBER                                      0x3682
#define HVAC_GET_FEATURE_SET_VERSION                                0x202F
#define HVAC_GET_TEMPERATURE_OFFSET                                 0x2318
#define HVAC_SET_TEMPERATURE_OFFSET                                 0x241D
#define HVAC_PERFORM_FORCED_RECALIBRATION                           0x362F
#define HVAC_GET_AUTOMATIC_SELF_CALIBRATION_ENABLED                 0x2313
#define HVAC_SET_AUTOMATIC_SELF_CALIBRATION_ENABLED                 0x2416
#define HVAC_GET_AUTOMATIC_SELF_CALIBRATION_INITIAL_PERIOD          0x2340
#define HVAC_SET_AUTOMATIC_SELF_CALIBRATION_INITIAL_PERIOD          0x2445
#define HVAC_GET_AUTOMATIC_SELF_CALIBRATION_STANDARD_PERIOD         0x234B
#define HVAC_SET_AUTOMATIC_SELF_CALIBRATION_STANDARD_PERIOD         0x244E
#define HVAC_PERSIST_SETTINGS                                       0x3615
#define HVAC_PERFORM_FACTORY_RESET                                  0x3632
#define HVAC_REINIT                                                 0x3646
 
#define HVAC_SPS30_I2C_START_MEASUREMENT                            0x0010
#define HVAC_SPS30_I2C_STOP_MEASUREMENT                             0x0104
#define HVAC_SPS30_I2C_READ_DATA_RDY_FLAG                           0x0202
#define HVAC_SPS30_I2C_READ_MEASURED_VALUE                          0x0300
#define HVAC_SPS30_I2C_SLEEP                                        0x1001
#define HVAC_SPS30_I2C_WAKEUP                                       0x1103
#define HVAC_SPS30_I2C_START_FAN_CLEANING                           0x5607
#define HVAC_SPS30_I2C_AUTO_CLEANING_INTERVAL                       0x8004
#define HVAC_SPS30_I2C_SET_AUTO_CLEANING_INTERVAL                   0x8005
#define HVAC_SPS30_I2C_STOP_MEASUREMENT_DUMMY                       0x0000
 
#define HVAC_SPS30_I2C_READ_PRODUCT_TYPE                            0xD002
#define HVAC_SPS30_I2C_READ_SERIAL_NUMBER                           0xD033
#define HVAC_SPS30_I2C_READ_VERSION                                 0xD100
#define HVAC_SPS30_I2C_READ_STATUS_REGISTER                         0xD206
#define HVAC_SPS30_I2C_CLEAR_STATUS_REGISTER                        0xD210
#define HVAC_SPS30_I2C_RESET                                        0xD304
 
#define HVAC_SPS30_NEW_DATA_NOT_READY                               0x00
#define HVAC_SPS30_NEW_DATA_IS_READY                                0x01
 
#define HVAC_SPS30_SLAVE_ADDR                                       0x69
#define HVAC_SCD40_SLAVE_ADDR                                       0x62
 
 
 // hvac_set
 
#define HVAC_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // hvac_map
 // hvac
 
typedef struct
{
    uint16_t co2_concent;
    float temperature;
    float r_humidity;
    uint16_t asc_update_count;
    uint16_t asc_last_correction;
} measuremen_data_t;
 
typedef struct
{
    uint8_t product_type;
    uint8_t platform_type;
    uint8_t product_major_version;
    uint8_t product_minor_version;
} feature_data_t;
 
typedef struct
{
    float mass_pm_1_0;
    float mass_pm_2_5;
    float mass_pm_4_0;
    float mass_pm_10;
    float num_pm_0_5;
    float num_pm_1_0;
    float num_pm_2_5;
    float num_pm_4_0;
    float num_pm_10;
    float typ_ptcl_size;
} mass_and_num_cnt_data_t;
 
typedef struct
{
    // Modules
    i2c_master_t i2c;      
    uart_t uart;           
    // I2C slave address
    uint8_t slave_address; 
} hvac_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} hvac_cfg_t;
 
typedef enum
{
    HVAC_OK = 0,
    HVAC_ERROR = -1
 
} hvac_return_value_t;
 
void hvac_cfg_setup ( hvac_cfg_t *cfg );
 
err_t hvac_init ( hvac_t *ctx, hvac_cfg_t *cfg );
 
err_t hvac_generic_write ( hvac_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t hvac_generic_read ( hvac_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
 
err_t hvac_scd40_write_data ( hvac_t *ctx, uint16_t reg, uint16_t tx_data );
 
err_t hvac_scd40_read_data ( hvac_t *ctx, uint16_t reg, uint16_t *rx_data );
void hvac_scd40_send_cmd ( hvac_t *ctx, uint16_t cmd );
 
void hvac_scd40_read_measurement ( hvac_t *ctx, measuremen_data_t *m_data );
 
void hvac_scd40_get_serial_number ( hvac_t *ctx, uint16_t *serial_number );
 
void hvac_scd40_get_feature_set_version ( hvac_t *ctx, feature_data_t *f_data );
 
void hvac_scd40_set_temperature_offset ( hvac_t *ctx, float temp_offset );
 
float hvac_scd40_get_temperature_offset ( hvac_t *ctx );
 
err_t hvac_sps30_i2c_write_data ( hvac_t *ctx, uint16_t reg, uint16_t tx_data );
 
err_t hvac_sps30_i2c_read_data ( hvac_t *ctx, uint16_t reg, uint16_t *rx_data );
 
void hvac_sps30_start_measurement ( hvac_t *ctx );
 
void hvac_sps30_stop_measurement ( hvac_t *ctx );
 
void hvac_sps30_device_reset ( hvac_t *ctx );
 
uint8_t hvac_sps30_get_ready_flag ( hvac_t *ctx );
 
void hvac_sps30_read_measured_data ( hvac_t *ctx, mass_and_num_cnt_data_t *m_n_c_data );
 
#ifdef __cplusplus
}
#endif
#endif // HVAC_H
 
 // hvac
 
// ------------------------------------------------------------------------ END