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
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38
59#define CO2_REG_DISABLE_CRC 0x3768
60#define CO2_REG_SET_BINARY_GAS 0x3615
61#define CO2_REG_SET_RELATIVE_HUMIDITY 0x3624
62#define CO2_REG_SET_TEMPERATURE 0x361E
63#define CO2_REG_SET_PRESSURE 0x362F
64#define CO2_REG_MEASURE_GAS_CONCENTRATION 0x3639
65#define CO2_REG_FORCED_RECALIBRATION 0x3661
66#define CO2_REG_ENABLE_AUTO_SELF_CALIB 0x3FEF
67#define CO2_REG_DISABLE_AUTO_SELF_CALIB 0x3F6E
68#define CO2_REG_PREPARE_READ_STATE 0x3752
69#define CO2_REG_READ_STATE 0xE133
70#define CO2_REG_WRITE_STATE 0xE133
71#define CO2_REG_APPLY_STATE 0x3650
72#define CO2_REG_SELF_TEST 0x365B
73#define CO2_REG_RESET 0x0006
74#define CO2_REG_ENTER_SLEEP_MODE 0x3677
75 // co2_reg
77
92#define CO2_SET_BINARY_GAS_IN_N2_100PCT 0x0000
93#define CO2_SET_BINARY_GAS_IN_AIR_100PCT 0x0001
94#define CO2_SET_BINARY_GAS_IN_N2_25PCT 0x0002
95#define CO2_SET_BINARY_GAS_IN_AIR_25PCT 0x0003
96
97#define CO2_DEVICE_ID 0x08010301
98
104#define CO2_SET_DEV_ADDR_GND 0x29
105#define CO2_SET_DEV_ADDR_1KOHMS 0x2C
106#define CO2_SET_DEV_ADDR_3p3KOHMS 0x2B
107#define CO2_SET_DEV_ADDR_10KOHMS 0x2A
108 // co2_set
110
125#define CO2_MAP_MIKROBUS( cfg, mikrobus ) \
126 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
127 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
128 // co2_map // co2
131
136typedef struct
137{
138 // Modules
139 i2c_master_t i2c;
141 // I2C slave address
144 // Device & serial IDs
145 uint32_t device_id;
146 uint32_t serial_id[ 2 ];
147 uint8_t crc_enabled;
148
149} co2_t;
150
155typedef struct
156{
157 pin_name_t scl;
158 pin_name_t sda;
160 uint32_t i2c_speed;
161 uint8_t i2c_address;
163} co2_cfg_t;
164
169typedef enum
170{
174 CO2_ERROR_CRC = -3
175
177
194
209err_t co2_init ( co2_t *ctx, co2_cfg_t *cfg );
210
225err_t co2_default_cfg ( co2_t *ctx );
226
242err_t co2_generic_write ( co2_t *ctx, uint16_t reg, uint16_t *tx_buf, uint8_t tx_len );
243
260err_t co2_generic_read ( co2_t *ctx, uint16_t reg, uint16_t *rx_buf, uint8_t rx_len );
261
270err_t co2_reset ( co2_t *ctx );
271
283err_t co2_get_id ( co2_t *ctx );
284
298err_t co2_set_reference ( co2_t *ctx, uint16_t humidity, uint16_t pressure );
299
312err_t co2_read_gas ( co2_t *ctx, float *gas_concentration, float *temperature );
313
326err_t co2_disable_crc ( co2_t *ctx );
327
328#ifdef __cplusplus
329}
330#endif
331#endif // CO2_H
332 // co2
334
335// ------------------------------------------------------------------------ END
co2_return_value_t
CO2 Click return value data.
Definition: co2.h:170
@ CO2_ERROR_CRC
Definition: co2.h:174
@ CO2_ERROR_SELF_TEST
Definition: co2.h:173
@ CO2_ERROR
Definition: co2.h:172
@ CO2_OK
Definition: co2.h:171
err_t co2_reset(co2_t *ctx)
Reset device.
err_t co2_disable_crc(co2_t *ctx)
Disable use of CRC.
err_t co2_generic_write(co2_t *ctx, uint16_t reg, uint16_t *tx_buf, uint8_t tx_len)
CO2 I2C writing function.
err_t co2_set_reference(co2_t *ctx, uint16_t humidity, uint16_t pressure)
Set device refrence values for gas calculation.
err_t co2_read_gas(co2_t *ctx, float *gas_concentration, float *temperature)
Read CO2 concentration and temperature value.
err_t co2_get_id(co2_t *ctx)
Read device and serial ID's.
void co2_cfg_setup(co2_cfg_t *cfg)
CO2 configuration object setup function.
err_t co2_generic_read(co2_t *ctx, uint16_t reg, uint16_t *rx_buf, uint8_t rx_len)
CO2 I2C reading function.
err_t co2_default_cfg(co2_t *ctx)
CO2 default configuration function.
err_t co2_init(co2_t *ctx, co2_cfg_t *cfg)
CO2 initialization function.
CO2 Click configuration object.
Definition: co2.h:156
uint32_t i2c_speed
Definition: co2.h:160
pin_name_t scl
Definition: co2.h:157
pin_name_t sda
Definition: co2.h:158
uint8_t i2c_address
Definition: co2.h:161
CO2 Click context object.
Definition: co2.h:137
uint32_t device_id
Definition: co2.h:145
i2c_master_t i2c
Definition: co2.h:139
uint8_t slave_address
Definition: co2.h:142
uint8_t crc_enabled
Definition: co2.h:147