hvac 2.0.0.0
hvac.h
Go to the documentation of this file.
1/****************************************************************************
2** Copyright (C) 2020 MikroElektronika d.o.o.
3** Contact: https://www.mikroe.com/contact
4**
5** Permission is hereby granted, free of charge, to any person obtaining a copy
6** of this software and associated documentation files (the "Software"), to deal
7** in the Software without restriction, including without limitation the rights
8** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9** copies of the Software, and to permit persons to whom the Software is
10** furnished to do so, subject to the following conditions:
11** The above copyright notice and this permission notice shall be
12** included in all copies or substantial portions of the Software.
13**
14** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20** USE OR OTHER DEALINGS IN THE SOFTWARE.
21****************************************************************************/
22
28#ifndef HVAC_H
29#define HVAC_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38#include "drv_uart.h"
39
65#define HVAC_START_PERIODIC_MEASUREMENT 0x21B1
66#define HVAC_START_LOW_POWER_PERIODIC_MEASUREMENT 0x21AC
67#define HVAC_START_ULTRA_LOW_POWER_PERIODIC_MEASUREMENT 0x21A7
68#define HVAC_MEASURE_SINGLE_SHOT 0x219D
69#define HVAC_MEASURE_SINGLE_SHOT_RHT_ONLY 0x2196
70#define HVAC_READ_MEASUREMENT 0xEC05
71#define HVAC_STOP_PERIODIC_MEASUREMENT 0x3F86
72#define HVAC_GET_SERIAL_NUMBER 0x3682
73#define HVAC_GET_FEATURE_SET_VERSION 0x202F
74#define HVAC_GET_TEMPERATURE_OFFSET 0x2318
75#define HVAC_SET_TEMPERATURE_OFFSET 0x241D
76#define HVAC_PERFORM_FORCED_RECALIBRATION 0x362F
77#define HVAC_GET_AUTOMATIC_SELF_CALIBRATION_ENABLED 0x2313
78#define HVAC_SET_AUTOMATIC_SELF_CALIBRATION_ENABLED 0x2416
79#define HVAC_GET_AUTOMATIC_SELF_CALIBRATION_INITIAL_PERIOD 0x2340
80#define HVAC_SET_AUTOMATIC_SELF_CALIBRATION_INITIAL_PERIOD 0x2445
81#define HVAC_GET_AUTOMATIC_SELF_CALIBRATION_STANDARD_PERIOD 0x234B
82#define HVAC_SET_AUTOMATIC_SELF_CALIBRATION_STANDARD_PERIOD 0x244E
83#define HVAC_PERSIST_SETTINGS 0x3615
84#define HVAC_PERFORM_FACTORY_RESET 0x3632
85#define HVAC_REINIT 0x3646
86
91#define HVAC_SPS30_I2C_START_MEASUREMENT 0x0010
92#define HVAC_SPS30_I2C_STOP_MEASUREMENT 0x0104
93#define HVAC_SPS30_I2C_READ_DATA_RDY_FLAG 0x0202
94#define HVAC_SPS30_I2C_READ_MEASURED_VALUE 0x0300
95#define HVAC_SPS30_I2C_SLEEP 0x1001
96#define HVAC_SPS30_I2C_WAKEUP 0x1103
97#define HVAC_SPS30_I2C_START_FAN_CLEANING 0x5607
98#define HVAC_SPS30_I2C_AUTO_CLEANING_INTERVAL 0x8004
99#define HVAC_SPS30_I2C_SET_AUTO_CLEANING_INTERVAL 0x8005
100#define HVAC_SPS30_I2C_STOP_MEASUREMENT_DUMMY 0x0000
101
102#define HVAC_SPS30_I2C_READ_PRODUCT_TYPE 0xD002
103#define HVAC_SPS30_I2C_READ_SERIAL_NUMBER 0xD033
104#define HVAC_SPS30_I2C_READ_VERSION 0xD100
105#define HVAC_SPS30_I2C_READ_STATUS_REGISTER 0xD206
106#define HVAC_SPS30_I2C_CLEAR_STATUS_REGISTER 0xD210
107#define HVAC_SPS30_I2C_RESET 0xD304
108
113#define HVAC_SPS30_NEW_DATA_NOT_READY 0x00
114#define HVAC_SPS30_NEW_DATA_IS_READY 0x01
115
121#define HVAC_SPS30_SLAVE_ADDR 0x69
122#define HVAC_SCD40_SLAVE_ADDR 0x62
123
124 // hvac_set
126
141#define HVAC_MAP_MIKROBUS( cfg, mikrobus ) \
142 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
143 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
144 // hvac_map // hvac
147
152typedef struct
153{
154 uint16_t co2_concent;
160
165typedef struct
166{
172
177typedef struct
178{
190
195typedef struct
196{
197 // Modules
198 i2c_master_t i2c;
199 uart_t uart;
201 // I2C slave address
204} hvac_t;
205
210typedef struct
211{
212 pin_name_t scl;
213 pin_name_t sda;
215 uint32_t i2c_speed;
216 uint8_t i2c_address;
218} hvac_cfg_t;
219
224typedef enum
225{
227 HVAC_ERROR = -1
228
230
247
262err_t hvac_init ( hvac_t *ctx, hvac_cfg_t *cfg );
263
279err_t hvac_generic_write ( hvac_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
280
296err_t hvac_generic_read ( hvac_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
297
298
313err_t hvac_scd40_write_data ( hvac_t *ctx, uint16_t reg, uint16_t tx_data );
314
329err_t hvac_scd40_read_data ( hvac_t *ctx, uint16_t reg, uint16_t *rx_data );
339void hvac_scd40_send_cmd ( hvac_t *ctx, uint16_t cmd );
340
352
363void hvac_scd40_get_serial_number ( hvac_t *ctx, uint16_t *serial_number );
364
376
387void hvac_scd40_set_temperature_offset ( hvac_t *ctx, float temp_offset );
388
399
415err_t hvac_sps30_i2c_write_data ( hvac_t *ctx, uint16_t reg, uint16_t tx_data );
416
432err_t hvac_sps30_i2c_read_data ( hvac_t *ctx, uint16_t reg, uint16_t *rx_data );
433
444
455
466
480
492
493#ifdef __cplusplus
494}
495#endif
496#endif // HVAC_H
497 // hvac
499
500// ------------------------------------------------------------------------ END
err_t hvac_sps30_i2c_read_data(hvac_t *ctx, uint16_t reg, uint16_t *rx_data)
SPS30 generic read data function.
err_t hvac_generic_write(hvac_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
HVAC I2C writing function.
void hvac_sps30_read_measured_data(hvac_t *ctx, mass_and_num_cnt_data_t *m_n_c_data)
SPS30 read measured data function.
uint8_t hvac_sps30_get_ready_flag(hvac_t *ctx)
SPS30 get ready flag function.
void hvac_sps30_device_reset(hvac_t *ctx)
SPS30 set device reset function.
err_t hvac_init(hvac_t *ctx, hvac_cfg_t *cfg)
HVAC initialization function.
void hvac_scd40_get_feature_set_version(hvac_t *ctx, feature_data_t *f_data)
SCD40 get feature set version function.
void hvac_scd40_read_measurement(hvac_t *ctx, measuremen_data_t *m_data)
SCD40 read measurement function.
float hvac_scd40_get_temperature_offset(hvac_t *ctx)
SCD40 get temperature offset function.
void hvac_scd40_get_serial_number(hvac_t *ctx, uint16_t *serial_number)
SCD40 get serial number function.
err_t hvac_scd40_write_data(hvac_t *ctx, uint16_t reg, uint16_t tx_data)
SCD40 generic write data function.
void hvac_scd40_send_cmd(hvac_t *ctx, uint16_t cmd)
SCD40 send command function.
err_t hvac_generic_read(hvac_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
HVAC I2C reading function.
err_t hvac_scd40_read_data(hvac_t *ctx, uint16_t reg, uint16_t *rx_data)
SCD40 generic read data function.
err_t hvac_sps30_i2c_write_data(hvac_t *ctx, uint16_t reg, uint16_t tx_data)
SPS30 generic write data function.
void hvac_sps30_start_measurement(hvac_t *ctx)
SPS30 start measurement command function.
void hvac_sps30_stop_measurement(hvac_t *ctx)
SPS30 stop measurement command function.
void hvac_cfg_setup(hvac_cfg_t *cfg)
HVAC configuration object setup function.
void hvac_scd40_set_temperature_offset(hvac_t *ctx, float temp_offset)
SCD40 set temperature offset function.
hvac_return_value_t
HVAC Click return value data.
Definition: hvac.h:225
@ HVAC_ERROR
Definition: hvac.h:227
@ HVAC_OK
Definition: hvac.h:226
HVAC Click feature data object.
Definition: hvac.h:166
uint8_t product_minor_version
Definition: hvac.h:170
uint8_t product_major_version
Definition: hvac.h:169
uint8_t product_type
Definition: hvac.h:167
uint8_t platform_type
Definition: hvac.h:168
HVAC Click configuration object.
Definition: hvac.h:211
uint32_t i2c_speed
Definition: hvac.h:215
pin_name_t scl
Definition: hvac.h:212
pin_name_t sda
Definition: hvac.h:213
uint8_t i2c_address
Definition: hvac.h:216
HVAC Click context object.
Definition: hvac.h:196
uart_t uart
Definition: hvac.h:199
i2c_master_t i2c
Definition: hvac.h:198
uint8_t slave_address
Definition: hvac.h:202
HVAC Click mass and number of particles object.
Definition: hvac.h:178
float num_pm_10
Definition: hvac.h:187
float num_pm_1_0
Definition: hvac.h:184
float mass_pm_10
Definition: hvac.h:182
float num_pm_4_0
Definition: hvac.h:186
float mass_pm_4_0
Definition: hvac.h:181
float mass_pm_2_5
Definition: hvac.h:180
float num_pm_2_5
Definition: hvac.h:185
float mass_pm_1_0
Definition: hvac.h:179
float typ_ptcl_size
Definition: hvac.h:188
float num_pm_0_5
Definition: hvac.h:183
HVAC Click measurements object.
Definition: hvac.h:153
uint16_t co2_concent
Definition: hvac.h:154
uint16_t asc_last_correction
Definition: hvac.h:158
uint16_t asc_update_count
Definition: hvac.h:157
float r_humidity
Definition: hvac.h:156
float temperature
Definition: hvac.h:155