pir  2.0.0.0
pir.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 PIR_H
36 #define PIR_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define PIR_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
56  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
57 
64 #define PIR_RETVAL uint8_t
65 
66 #define PIR_OK 0x00
67 #define PIR_INIT_ERROR 0xFF
68  // End group macro
71 // --------------------------------------------------------------- PUBLIC TYPES
80 typedef struct
81 {
82  // Input pins
83 
84  digital_in_t an;
85 
86  // Modules
87 
88  i2c_master_t i2c;
89 
90  // ctx variable
91 
92  uint8_t slave_address;
93 
94 } pir_t;
95 
99 typedef struct
100 {
101  // Communication gpio pins
102 
103  pin_name_t scl;
104  pin_name_t sda;
105 
106  // Additional gpio pins
107 
108  pin_name_t an;
109 
110  // static variable
111 
112  uint32_t i2c_speed;
113  uint8_t i2c_address;
114 
115 } pir_cfg_t;
116  // End types group
118 
119 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
120 
126 #ifdef __cplusplus
127 extern "C"{
128 #endif
129 
138 void pir_cfg_setup ( pir_cfg_t *cfg );
139 
149 
160 void pir_generic_write ( pir_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
161 
173 void pir_generic_read ( pir_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
174 
182 uint16_t pir_get_adc ( pir_t *ctx );
183 
191 uint16_t pir_reg_read ( pir_t *ctx );
192 
201 float pir_get_mili_volt ( pir_t *ctx, uint16_t ref_voltage );
202 
213 float pir_scale_results ( pir_t *ctx, uint16_t in_val, uint16_t out_min, uint16_t out_max );
214 
215 #ifdef __cplusplus
216 }
217 #endif
218 #endif // _PIR_H_
219  // End public_function group
222 
223 // ------------------------------------------------------------------------- END
pir_t::an
digital_in_t an
Definition: pir.h:84
pir_t
Click ctx object definition.
Definition: pir.h:81
pir_cfg_t::scl
pin_name_t scl
Definition: pir.h:103
PIR_RETVAL
#define PIR_RETVAL
Definition: pir.h:64
pir_cfg_t
Click configuration structure definition.
Definition: pir.h:100
pir_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: pir.h:112
pir_generic_read
void pir_generic_read(pir_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
pir_cfg_setup
void pir_cfg_setup(pir_cfg_t *cfg)
Config Object Initialization function.
pir_generic_write
void pir_generic_write(pir_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
pir_cfg_t::sda
pin_name_t sda
Definition: pir.h:104
pir_reg_read
uint16_t pir_reg_read(pir_t *ctx)
Reading register.
pir_t::i2c
i2c_master_t i2c
Definition: pir.h:88
pir_get_mili_volt
float pir_get_mili_volt(pir_t *ctx, uint16_t ref_voltage)
Reading ADC data in mili Volts.
pir_cfg_t::i2c_address
uint8_t i2c_address
Definition: pir.h:113
pir_get_adc
uint16_t pir_get_adc(pir_t *ctx)
Reading 12bit ADC value.
pir_scale_results
float pir_scale_results(pir_t *ctx, uint16_t in_val, uint16_t out_min, uint16_t out_max)
Scaling ADC results.
pir_init
PIR_RETVAL pir_init(pir_t *ctx, pir_cfg_t *cfg)
Initialization function.
pir_cfg_t::an
pin_name_t an
Definition: pir.h:108
pir_t::slave_address
uint8_t slave_address
Definition: pir.h:92