irsense2  2.0.0.0
irsense2.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 IRSENSE2_H
36 #define IRSENSE2_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 
53 // -------------------------------------------------------------- PUBLIC MACROS
63 #define IRSENSE2_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
65  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
66  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
67 
73 #define IRSENSE2_RETVAL uint8_t
74 
75 #define IRSENSE2_OK 0x00
76 #define IRSENSE2_INIT_ERROR 0xFF
77 
83 #define IRS
84 #define COMPANY_CODE_WIA1 0x00
85 #define DEVICE_ID_WIA2 0x01
86 #define INFO_1 0x02
87 #define INFO_2 0x03
88 #define STATUS_1_ST1 0x04
89 #define STATUS_2_ST2 0x0A
90 #define INTCAUSE 0x05
91 #define IR_SENSOR_LSB 0x06
92 #define IR_SENSOR_MSB 0x07
93 #define TMP_SENSOR_LSB 0x08
94 #define TMP_SENSOR_MSB 0x09
95 #define THIRH_IR_THRESHOLD_LVL_LSB 0x0B
96 #define THIRH_IR_THRESHOLD_LVL_MSB 0x0C
97 #define THIRL_IR_THRESHOLD_LVL_LSB 0x0D
98 #define THIRL_IR_THRESHOLD_LVL_MSB 0x0E
99 #define THTMPH_TEMP_SENS_THRESHOLD_LV_LSB 0x0F
100 #define THTMPH_TEMP_SENS_THRESHOLD_LV_MSB 0x10
101 #define THTMPL_TEMP_SENS_THRESHOLD_LV_LSB 0x11
102 #define THTMPL_TEMP_SENS_THRESHOLD_LV_MSB 0x12
103 #define INTEN_INTERRUPT_FACTOR_SETTING 0x13
104 #define CNTL1_CUT_OFF_FREQ_SETTING 0x14
105 #define CNTL2_OPERATING_MODE_SETTING 0x15
106 #define CNTL3_SOFT_RESET 0x16
107 
113 #define ST1_RST 0xFE
114 #define INTCAUSE_RST 0xE0
115 #define IR_RST 0x00
116 #define TMP_RST 0x00
117 #define ST2_RST 0xFE
118 #define THIRH_THIRL_THTMPH_THTMPL_RST 0x00
119 #define INTEN_RST 0xE0
120 #define CNTL1_RST 0xE0
121 #define CNTL2_RST 0xFC
122 #define CNTL3_RST 0xFE
123 
129 #define INTEN_MODE_MASK_DATARDY_INT_VALID 0xE1
130 #define CNTL1_IR__MODE_MASK_NO_FILTER 0xE0
131 #define CNTL1_IR__MODE_MASK_FC_2_5HZ 0xE8
132 #define CNTL1_IR_MODE_MASK_FC_0_9HZ 0xF0
133 #define CNTL1_IR_MODE_MASK_FC_0_45HZ 0xF8
134 #define CNTL1_TMP_MODE_MASK_NO_FILTER 0xE0
135 #define CNTL1_TMP_MODE_MASK_FC_2_5HZ 0xE1
136 #define CNTL1_TMP_MODE_MASK_FC_0_9HZ 0xE2
137 #define CNTL1_TMP_MODE_MASK_FC_0_45HZ 0xE3
138 #define CNTL1_TMP_MODE_MASK_FC_0_22HZ 0xE4
139 #define CNTL2_STANDBY_MODE 0xFC
140 #define CNTL2_CONTINUOUS_MODE 0xFD
141 #define CNTL2_SINGLE_SHOT_MODE 0xFE
142 #define CNTL3_RESET_MODE 0xFF
143  // End group macro
146 // --------------------------------------------------------------- PUBLIC TYPES
155 typedef struct
156 {
157  // Input pins
158 
159  digital_in_t int_pin;
160 
161  // Modules
162 
163  i2c_master_t i2c;
164 
165  // ctx variable
166 
167  uint8_t slave_address;
168 
169  uint8_t data_flag;
172 
173 } irsense2_t;
174 
178 typedef struct
179 {
180  // Communication gpio pins
181 
182  pin_name_t scl;
183  pin_name_t sda;
184 
185  // Additional gpio pins
186 
187  pin_name_t int_pin;
188 
189  // static variable
190 
191  uint32_t i2c_speed;
192  uint8_t i2c_address;
193  uint8_t data_flag_cfg;
196 
198  // End types group
200 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
201 
207 #ifdef __cplusplus
208 extern "C"{
209 #endif
210 
220 
229 
238 
249 void irsense2_generic_write ( irsense2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
250 
262 void irsense2_generic_read ( irsense2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
263 
274 void irsense2_data_read ( irsense2_t *ctx, float *ir_data, float *temp_data );
275 
287 
299 
309 
320 uint8_t irsense_human_detected ( irsense2_t *ctx, float ir_data );
321 
331 
332 #ifdef __cplusplus
333 }
334 #endif
335 #endif // _IRSENSE2_H_
336  // End public_function group
339 
340 // ------------------------------------------------------------------------- END
irsense2_get_ir_data
int16_t irsense2_get_ir_data(irsense2_t *ctx)
IR Data read function.
irsense2_cfg_t
Click configuration structure definition.
Definition: irsense2.h:179
irsense2_t::int_pin
digital_in_t int_pin
Definition: irsense2.h:159
irsense2_t::i2c
i2c_master_t i2c
Definition: irsense2.h:163
irsense2_t::prev_ir_data
float prev_ir_data
Definition: irsense2.h:170
irsense2_cfg_t::prev_ir_data_cfg
int8_t prev_ir_data_cfg
Definition: irsense2.h:194
irsense2_t::data_flag
uint8_t data_flag
Definition: irsense2.h:169
IRSENSE2_RETVAL
#define IRSENSE2_RETVAL
Definition: irsense2.h:73
irsense2_cfg_t::i2c_address
uint8_t i2c_address
Definition: irsense2.h:192
irsense2_get_temperature_data
int16_t irsense2_get_temperature_data(irsense2_t *ctx)
Temperatire Data read function.
irsense2_init
IRSENSE2_RETVAL irsense2_init(irsense2_t *ctx, irsense2_cfg_t *cfg)
Initialization function.
irsense2_t::prev_ir_data2
float prev_ir_data2
Definition: irsense2.h:171
irsense2_data_read
void irsense2_data_read(irsense2_t *ctx, float *ir_data, float *temp_data)
Data function.
irsense2_t
Click ctx object definition.
Definition: irsense2.h:156
irsense2_generic_write
void irsense2_generic_write(irsense2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
irsense2_generic_read
void irsense2_generic_read(irsense2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
irsense2_cfg_t::prev_ir_data_cfg2
int8_t prev_ir_data_cfg2
Definition: irsense2.h:195
irsense2_cfg_t::data_flag_cfg
uint8_t data_flag_cfg
Definition: irsense2.h:193
irsense2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: irsense2.h:191
irsense2_cfg_t::int_pin
pin_name_t int_pin
Definition: irsense2.h:187
irsense2_cfg_t::scl
pin_name_t scl
Definition: irsense2.h:182
irsense2_get_int_pin
void irsense2_get_int_pin(irsense2_t *ctx)
Int_pin state function.
irsense2_t::slave_address
uint8_t slave_address
Definition: irsense2.h:167
irsense2_get_int
void irsense2_get_int(irsense2_t *ctx)
Interrupt factor function.
irsense2_cfg_t::sda
pin_name_t sda
Definition: irsense2.h:183
irsense_human_detected
uint8_t irsense_human_detected(irsense2_t *ctx, float ir_data)
Human detection function.
irsense2_cfg_setup
void irsense2_cfg_setup(irsense2_cfg_t *cfg)
Config Object Initialization function.
irsense2_default_cfg
void irsense2_default_cfg(irsense2_t *ctx)
Click Default Configuration function.