pir2  2.1.0.0
pir2.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 PIR2_H
29 #define PIR2_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_analog_in.h"
52 #include "drv_i2c_master.h"
53 
74 #define PIR2_ADC_RESOLUTION 0x0FFF
75 #define PIR2_VREF_3V3 3.3
76 #define PIR2_VREF_5V 5.0
77 
83 #define PIR2_SET_DEV_ADDR 0x4D
84  // pir2_set
86 
101 #define PIR2_MAP_MIKROBUS( cfg, mikrobus ) \
102  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
103  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
104  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
105  // pir2_map // pir2
108 
113 typedef enum
114 {
119 
124 typedef struct
125 {
126  analog_in_t adc;
127  i2c_master_t i2c;
129  uint8_t slave_address;
130  float vref;
133 } pir2_t;
134 
139 typedef struct
140 {
141  pin_name_t an;
142  pin_name_t scl;
143  pin_name_t sda;
145  analog_in_resolution_t resolution;
146  float vref;
148  uint32_t i2c_speed;
149  uint8_t i2c_address;
153 } pir2_cfg_t;
154 
159 typedef enum
160 {
161  PIR2_OK = 0,
162  PIR2_ERROR = -1
163 
165 
182 
198 
212 err_t pir2_init ( pir2_t *ctx, pir2_cfg_t *cfg );
213 
225 err_t pir2_read_raw_adc ( pir2_t *ctx, uint16_t *raw_adc );
226 
238 err_t pir2_read_voltage ( pir2_t *ctx, float *voltage );
239 
251 err_t pir2_set_vref ( pir2_t *ctx, float vref );
252 
253 #ifdef __cplusplus
254 }
255 #endif
256 #endif // PIR2_H
257  // pir2
259 
260 // ------------------------------------------------------------------------ END
pir2_t::drv_sel
pir2_drv_t drv_sel
Definition: pir2.h:131
PIR2_ERROR
@ PIR2_ERROR
Definition: pir2.h:162
pir2_cfg_t
PIR 2 Click configuration object.
Definition: pir2.h:140
pir2_set_vref
err_t pir2_set_vref(pir2_t *ctx, float vref)
PIR 2 set vref function.
pir2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: pir2.h:148
pir2_t::adc
analog_in_t adc
Definition: pir2.h:126
pir2_cfg_t::resolution
analog_in_resolution_t resolution
Definition: pir2.h:145
pir2_drv_t
pir2_drv_t
PIR 2 Click driver selector.
Definition: pir2.h:114
pir2_t::i2c
i2c_master_t i2c
Definition: pir2.h:127
pir2_cfg_t::an
pin_name_t an
Definition: pir2.h:141
pir2_cfg_t::drv_sel
pir2_drv_t drv_sel
Definition: pir2.h:151
PIR2_DRV_SEL_I2C
@ PIR2_DRV_SEL_I2C
Definition: pir2.h:116
pir2_init
err_t pir2_init(pir2_t *ctx, pir2_cfg_t *cfg)
PIR 2 initialization function.
PIR2_DRV_SEL_ADC
@ PIR2_DRV_SEL_ADC
Definition: pir2.h:115
pir2_return_value_t
pir2_return_value_t
PIR 2 Click return value data.
Definition: pir2.h:160
pir2_t::vref
float vref
Definition: pir2.h:130
pir2_cfg_t::sda
pin_name_t sda
Definition: pir2.h:143
pir2_t::slave_address
uint8_t slave_address
Definition: pir2.h:129
pir2_cfg_setup
void pir2_cfg_setup(pir2_cfg_t *cfg)
PIR 2 configuration object setup function.
pir2_cfg_t::i2c_address
uint8_t i2c_address
Definition: pir2.h:149
pir2_drv_interface_sel
void pir2_drv_interface_sel(pir2_cfg_t *cfg, pir2_drv_t drv_sel)
PIR 2 driver interface setup function.
pir2_read_voltage
err_t pir2_read_voltage(pir2_t *ctx, float *voltage)
PIR 2 read voltage level function.
pir2_cfg_t::scl
pin_name_t scl
Definition: pir2.h:142
pir2_t
PIR 2 Click context object.
Definition: pir2.h:125
pir2_cfg_t::vref
float vref
Definition: pir2.h:146
PIR2_OK
@ PIR2_OK
Definition: pir2.h:161
pir2_read_raw_adc
err_t pir2_read_raw_adc(pir2_t *ctx, uint16_t *raw_adc)
PIR 2 read raw ADC value function.