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 "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define NO2_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
66  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
67 
73 #define NO2_RETVAL uint8_t
74 
75 #define NO2_OK 0x00
76 #define NO2_INIT_ERROR 0xFF
77 
83 #define NO2_STATUS_REG 0x00
84 #define NO2_LOCK_REG 0x01
85 #define NO2_TIACN_REG 0x10
86 #define NO2_REFCN_REG 0x11
87 #define NO2_MODECN_REG 0x12
88 
94 #define NO2_WRITE_MODE 0x00
95 #define NO2_READ_ONLY_MODE 0x01
96 
102 #define NO2_EXT_TIA_RES 0x00
103 #define NO2_2750_OHM_TIA_RES 0x04
104 #define NO2_3500_OHM_TIA_RES 0x08
105 #define NO2_7K_OHM_TIA_RES 0x0C
106 #define NO2_14K_OHM_TIA_RES 0x10
107 #define NO2_35K_OHM_TIA_RES 0x14
108 #define NO2_120K_OHM_TIA_RES 0x18
109 #define NO2_350K_OHM_TIA_RES 0x1C
110 #define NO2_10_OHM_LOAD_RES 0x00
111 #define NO2_33_OHM_LOAD_RES 0x01
112 #define NO2_50_OHM_LOAD_RES 0x02
113 #define NO2_100_OHM_LOAD_RES 0x03
114 
120 #define NO2_VREF_INT 0x00
121 #define NO2_VREF_EXT 0x80
122 #define NO2_20_PERCENTS_INT_ZERO 0x00
123 #define NO2_50_PERCENTS_INT_ZERO 0x20
124 #define NO2_67_PERCENTS_INT_ZERO 0x40
125 #define NO2_INT_ZERO_BYPASSED 0x60
126 #define NO2_BIAS_POL_NEGATIVE 0x00
127 #define NO2_BIAS_POL_POSITIVE 0x10
128 #define NO2_0_PERCENTS_BIAS 0x00
129 #define NO2_1_PERCENT_BIAS 0x01
130 #define NO2_2_PERCENTS_BIAS 0x02
131 #define NO2_4_PERCENTS_BIAS 0x03
132 #define NO2_6_PERCENTS_BIAS 0x04
133 #define NO2_8_PERCENTS_BIAS 0x05
134 #define NO2_10_PERCENTS_BIAS 0x06
135 #define NO2_12_PERCENTS_BIAS 0x07
136 #define NO2_14_PERCENTS_BIAS 0x08
137 #define NO2_16_PERCENTS_BIAS 0x09
138 #define NO2_18_PERCENTS_BIAS 0x0A
139 #define NO2_20_PERCENTS_BIAS 0x0B
140 #define NO2_22_PERCENTS_BIAS 0x0C
141 #define NO2_24_PERCENTS_BIAS 0x0D
142 
148 #define NO2_FET_DIS 0x00
149 #define NO2_FET_EN 0x80
150 #define NO2_DEEP_SLEEP_MODE 0x00
151 #define NO2_2_LEAD_MODE 0x01
152 #define NO2_STANDBY_MODE 0x02
153 #define NO2_3_LEAD_MODE 0x03
154 #define NO2_TEMP_MODE_TIA_OFF 0x06
155 #define NO2_TEMP_MODE_TIA_ON 0x07
156 
162 #define NO2_DEVICE_EN 0x00
163 #define NO2_DEVICE_DIS 0x01
164 
170 #define ADC_DEVICE_ADDR 0x4D
171  // End group macro
174 // --------------------------------------------------------------- PUBLIC TYPES
183 typedef struct
184 {
185  // Output pins
186 
187  digital_out_t rst;
188 
189  // Input pins
190 
191  digital_in_t an;
192 
193  // Modules
194 
195  i2c_master_t i2c;
196 
197  // ctx variable
198 
199  uint8_t slave_address;
200 
201 } no2_t;
202 
206 typedef struct
207 {
208  // Communication gpio pins
209 
210  pin_name_t scl;
211  pin_name_t sda;
212 
213  // Additional gpio pins
214 
215  pin_name_t an;
216  pin_name_t rst;
217 
218  // static variable
219 
220  uint32_t i2c_speed;
221  uint8_t i2c_address;
222 
223 } no2_cfg_t;
224  // End types group
226 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
227 
233 #ifdef __cplusplus
234 extern "C"{
235 #endif
236 
245 void no2_cfg_setup ( no2_cfg_t *cfg );
246 
256 
280 void no2_default_cfg ( no2_t *ctx );
281 
292 void no2_generic_write ( no2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
293 
305 void no2_generic_read ( no2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
306 
314 void no2_write_byte ( no2_t *ctx, uint8_t reg, uint8_t dev_data );
315 
324 uint8_t no2_read_byte ( no2_t *ctx, uint8_t reg );
325 
333 void no2_enable ( no2_t *ctx, uint8_t state );
334 
342 uint16_t no2_read_adc ( no2_t *ctx );
343 
351 float no2_get_no_2_ppm ( no2_t *ctx );
352 
358 void no2_wait_ready ( no2_t *ctx );
359 
360 #ifdef __cplusplus
361 }
362 #endif
363 #endif // _NO2_H_
364  // End public_function group
367 
368 // ------------------------------------------------------------------------- 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:210
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:220
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:216
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:187
no2_cfg_t::sda
pin_name_t sda
Definition: no2.h:211
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:207
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:195
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:221
NO2_RETVAL
#define NO2_RETVAL
Definition: no2.h:73
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:199
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:184
no2_t::an
digital_in_t an
Definition: no2.h:191
no2_cfg_t::an
pin_name_t an
Definition: no2.h:215
no2_generic_write
void no2_generic_write(no2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.