co2  2.0.0.0
co2.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 CO2_H
29 #define CO2_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
73 #define CO2_REG_DISABLE_CRC 0x3768
74 #define CO2_REG_SET_BINARY_GAS 0x3615
75 #define CO2_REG_SET_RELATIVE_HUMIDITY 0x3624
76 #define CO2_REG_SET_TEMPERATURE 0x361E
77 #define CO2_REG_SET_PRESSURE 0x362F
78 #define CO2_REG_MEASURE_GAS_CONCENTRATION 0x3639
79 #define CO2_REG_FORCED_RECALIBRATION 0x3661
80 #define CO2_REG_ENABLE_AUTO_SELF_CALIB 0x3FEF
81 #define CO2_REG_DISABLE_AUTO_SELF_CALIB 0x3F6E
82 #define CO2_REG_PREPARE_READ_STATE 0x3752
83 #define CO2_REG_READ_STATE 0xE133
84 #define CO2_REG_WRITE_STATE 0xE133
85 #define CO2_REG_APPLY_STATE 0x3650
86 #define CO2_REG_SELF_TEST 0x365B
87 #define CO2_REG_RESET 0x0006
88 #define CO2_REG_ENTER_SLEEP_MODE 0x3677
89  // co2_reg
91 
106 #define CO2_SET_BINARY_GAS_IN_N2_100PCT 0x0000
107 #define CO2_SET_BINARY_GAS_IN_AIR_100PCT 0x0001
108 #define CO2_SET_BINARY_GAS_IN_N2_25PCT 0x0002
109 #define CO2_SET_BINARY_GAS_IN_AIR_25PCT 0x0003
110 
111 #define CO2_DEVICE_ID 0x08010301
112 
118 #define CO2_SET_DEV_ADDR_GND 0x29
119 #define CO2_SET_DEV_ADDR_1KOHMS 0x2C
120 #define CO2_SET_DEV_ADDR_3p3KOHMS 0x2B
121 #define CO2_SET_DEV_ADDR_10KOHMS 0x2A
122  // co2_set
124 
139 #define CO2_MAP_MIKROBUS( cfg, mikrobus ) \
140  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
141  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
142  // co2_map // co2
145 
150 typedef struct
151 {
152  // Modules
153  i2c_master_t i2c;
155  // I2C slave address
156  uint8_t slave_address;
158  // Device & serial IDs
159  uint32_t device_id;
160  uint32_t serial_id[ 2 ];
161  uint8_t crc_enabled;
162 
163 } co2_t;
164 
169 typedef struct
170 {
171  pin_name_t scl;
172  pin_name_t sda;
174  uint32_t i2c_speed;
175  uint8_t i2c_address;
177 } co2_cfg_t;
178 
183 typedef enum
184 {
185  CO2_OK = 0,
186  CO2_ERROR = -1,
188  CO2_ERROR_CRC = -3
189 
191 
207 void co2_cfg_setup ( co2_cfg_t *cfg );
208 
223 err_t co2_init ( co2_t *ctx, co2_cfg_t *cfg );
224 
239 err_t co2_default_cfg ( co2_t *ctx );
240 
256 err_t co2_generic_write ( co2_t *ctx, uint16_t reg, uint16_t *tx_buf, uint8_t tx_len );
257 
274 err_t co2_generic_read ( co2_t *ctx, uint16_t reg, uint16_t *rx_buf, uint8_t rx_len );
275 
284 err_t co2_reset ( co2_t *ctx );
285 
297 err_t co2_get_id ( co2_t *ctx );
298 
312 err_t co2_set_reference ( co2_t *ctx, uint16_t humidity, uint16_t pressure );
313 
326 err_t co2_read_gas ( co2_t *ctx, float *gas_concentration, float *temperature );
327 
340 err_t co2_disable_crc ( co2_t *ctx );
341 
342 #ifdef __cplusplus
343 }
344 #endif
345 #endif // CO2_H
346  // co2
348 
349 // ------------------------------------------------------------------------ END
co2_generic_write
err_t co2_generic_write(co2_t *ctx, uint16_t reg, uint16_t *tx_buf, uint8_t tx_len)
CO2 I2C writing function.
co2_reset
err_t co2_reset(co2_t *ctx)
Reset device.
co2_cfg_t::scl
pin_name_t scl
Definition: co2.h:171
co2_get_id
err_t co2_get_id(co2_t *ctx)
Read device and serial ID's.
co2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: co2.h:174
co2_t::crc_enabled
uint8_t crc_enabled
Definition: co2.h:161
CO2_ERROR
@ CO2_ERROR
Definition: co2.h:186
co2_return_value_t
co2_return_value_t
CO2 Click return value data.
Definition: co2.h:184
co2_cfg_t::sda
pin_name_t sda
Definition: co2.h:172
CO2_ERROR_CRC
@ CO2_ERROR_CRC
Definition: co2.h:188
CO2_OK
@ CO2_OK
Definition: co2.h:185
co2_default_cfg
err_t co2_default_cfg(co2_t *ctx)
CO2 default configuration function.
co2_cfg_t::i2c_address
uint8_t i2c_address
Definition: co2.h:175
CO2_ERROR_SELF_TEST
@ CO2_ERROR_SELF_TEST
Definition: co2.h:187
co2_set_reference
err_t co2_set_reference(co2_t *ctx, uint16_t humidity, uint16_t pressure)
Set device refrence values for gas calculation.
co2_t::slave_address
uint8_t slave_address
Definition: co2.h:156
co2_t
CO2 Click context object.
Definition: co2.h:151
co2_t::device_id
uint32_t device_id
Definition: co2.h:159
co2_cfg_setup
void co2_cfg_setup(co2_cfg_t *cfg)
CO2 configuration object setup function.
co2_t::i2c
i2c_master_t i2c
Definition: co2.h:153
co2_disable_crc
err_t co2_disable_crc(co2_t *ctx)
Disable use of CRC.
co2_init
err_t co2_init(co2_t *ctx, co2_cfg_t *cfg)
CO2 initialization function.
co2_generic_read
err_t co2_generic_read(co2_t *ctx, uint16_t reg, uint16_t *rx_buf, uint8_t rx_len)
CO2 I2C reading function.
co2_read_gas
err_t co2_read_gas(co2_t *ctx, float *gas_concentration, float *temperature)
Read CO2 concentration and temperature value.
co2_cfg_t
CO2 Click configuration object.
Definition: co2.h:170