no2  2.0.0.0
no2.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef NO2_H
36 #define NO2_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define NO2_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
56  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
57 
63 #define NO2_RETVAL uint8_t
64 
65 #define NO2_OK 0x00
66 #define NO2_INIT_ERROR 0xFF
67 
73 #define NO2_STATUS_REG 0x00
74 #define NO2_LOCK_REG 0x01
75 #define NO2_TIACN_REG 0x10
76 #define NO2_REFCN_REG 0x11
77 #define NO2_MODECN_REG 0x12
78 
84 #define NO2_WRITE_MODE 0x00
85 #define NO2_READ_ONLY_MODE 0x01
86 
92 #define NO2_EXT_TIA_RES 0x00
93 #define NO2_2750_OHM_TIA_RES 0x04
94 #define NO2_3500_OHM_TIA_RES 0x08
95 #define NO2_7K_OHM_TIA_RES 0x0C
96 #define NO2_14K_OHM_TIA_RES 0x10
97 #define NO2_35K_OHM_TIA_RES 0x14
98 #define NO2_120K_OHM_TIA_RES 0x18
99 #define NO2_350K_OHM_TIA_RES 0x1C
100 #define NO2_10_OHM_LOAD_RES 0x00
101 #define NO2_33_OHM_LOAD_RES 0x01
102 #define NO2_50_OHM_LOAD_RES 0x02
103 #define NO2_100_OHM_LOAD_RES 0x03
104 
110 #define NO2_VREF_INT 0x00
111 #define NO2_VREF_EXT 0x80
112 #define NO2_20_PERCENTS_INT_ZERO 0x00
113 #define NO2_50_PERCENTS_INT_ZERO 0x20
114 #define NO2_67_PERCENTS_INT_ZERO 0x40
115 #define NO2_INT_ZERO_BYPASSED 0x60
116 #define NO2_BIAS_POL_NEGATIVE 0x00
117 #define NO2_BIAS_POL_POSITIVE 0x10
118 #define NO2_0_PERCENTS_BIAS 0x00
119 #define NO2_1_PERCENT_BIAS 0x01
120 #define NO2_2_PERCENTS_BIAS 0x02
121 #define NO2_4_PERCENTS_BIAS 0x03
122 #define NO2_6_PERCENTS_BIAS 0x04
123 #define NO2_8_PERCENTS_BIAS 0x05
124 #define NO2_10_PERCENTS_BIAS 0x06
125 #define NO2_12_PERCENTS_BIAS 0x07
126 #define NO2_14_PERCENTS_BIAS 0x08
127 #define NO2_16_PERCENTS_BIAS 0x09
128 #define NO2_18_PERCENTS_BIAS 0x0A
129 #define NO2_20_PERCENTS_BIAS 0x0B
130 #define NO2_22_PERCENTS_BIAS 0x0C
131 #define NO2_24_PERCENTS_BIAS 0x0D
132 
138 #define NO2_FET_DIS 0x00
139 #define NO2_FET_EN 0x80
140 #define NO2_DEEP_SLEEP_MODE 0x00
141 #define NO2_2_LEAD_MODE 0x01
142 #define NO2_STANDBY_MODE 0x02
143 #define NO2_3_LEAD_MODE 0x03
144 #define NO2_TEMP_MODE_TIA_OFF 0x06
145 #define NO2_TEMP_MODE_TIA_ON 0x07
146 
152 #define NO2_DEVICE_EN 0x00
153 #define NO2_DEVICE_DIS 0x01
154 
160 #define ADC_DEVICE_ADDR 0x4D
161  // End group macro
164 // --------------------------------------------------------------- PUBLIC TYPES
173 typedef struct
174 {
175  // Output pins
176 
177  digital_out_t rst;
178 
179  // Input pins
180 
181  digital_in_t an;
182 
183  // Modules
184 
185  i2c_master_t i2c;
186 
187  // ctx variable
188 
189  uint8_t slave_address;
190 
191 } no2_t;
192 
196 typedef struct
197 {
198  // Communication gpio pins
199 
200  pin_name_t scl;
201  pin_name_t sda;
202 
203  // Additional gpio pins
204 
205  pin_name_t an;
206  pin_name_t rst;
207 
208  // static variable
209 
210  uint32_t i2c_speed;
211  uint8_t i2c_address;
212 
213 } no2_cfg_t;
214  // End types group
216 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
217 
223 #ifdef __cplusplus
224 extern "C"{
225 #endif
226 
235 void no2_cfg_setup ( no2_cfg_t *cfg );
236 
245 NO2_RETVAL no2_init ( no2_t *ctx, no2_cfg_t *cfg );
246 
270 void no2_default_cfg ( no2_t *ctx );
271 
282 void no2_generic_write ( no2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
283 
295 void no2_generic_read ( no2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
296 
304 void no2_write_byte ( no2_t *ctx, uint8_t reg, uint8_t dev_data );
305 
314 uint8_t no2_read_byte ( no2_t *ctx, uint8_t reg );
315 
323 void no2_enable ( no2_t *ctx, uint8_t state );
324 
332 uint16_t no2_read_adc ( no2_t *ctx );
333 
341 float no2_get_no_2_ppm ( no2_t *ctx );
342 
348 void no2_wait_ready ( no2_t *ctx );
349 
350 #ifdef __cplusplus
351 }
352 #endif
353 #endif // _NO2_H_
354  // End public_function group
357 
358 // ------------------------------------------------------------------------- END
no2_read_byte
uint8_t no2_read_byte(no2_t *ctx, uint8_t reg)
Function reads one byte from the register.
no2_cfg_t::scl
pin_name_t scl
Definition: no2.h:200
no2_enable
void no2_enable(no2_t *ctx, uint8_t state)
Device Enable function.
no2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: no2.h:210
no2_generic_read
void no2_generic_read(no2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
no2_default_cfg
void no2_default_cfg(no2_t *ctx)
Click Default Configuration function.
no2_cfg_t::rst
pin_name_t rst
Definition: no2.h:206
no2_read_adc
uint16_t no2_read_adc(no2_t *ctx)
Function for read ADC sensor data.
no2_t::rst
digital_out_t rst
Definition: no2.h:177
no2_cfg_t::sda
pin_name_t sda
Definition: no2.h:201
no2_init
NO2_RETVAL no2_init(no2_t *ctx, no2_cfg_t *cfg)
Initialization function.
no2_cfg_t
Click configuration structure definition.
Definition: no2.h:196
no2_cfg_setup
void no2_cfg_setup(no2_cfg_t *cfg)
Config Object Initialization function.
no2_t::i2c
i2c_master_t i2c
Definition: no2.h:185
no2_wait_ready
void no2_wait_ready(no2_t *ctx)
Function waits until I2C is ready for the next command.
no2_cfg_t::i2c_address
uint8_t i2c_address
Definition: no2.h:211
NO2_RETVAL
#define NO2_RETVAL
Definition: no2.h:63
no2_write_byte
void no2_write_byte(no2_t *ctx, uint8_t reg, uint8_t dev_data)
Function writes one byte to the register.
no2_t::slave_address
uint8_t slave_address
Definition: no2.h:189
no2_get_no_2_ppm
float no2_get_no_2_ppm(no2_t *ctx)
Get NO2 Data function.
no2_t
Click ctx object definition.
Definition: no2.h:173
no2_t::an
digital_in_t an
Definition: no2.h:181
no2_cfg_t::an
pin_name_t an
Definition: no2.h:205
no2_generic_write
void no2_generic_write(no2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.