irsense3  2.0.0.0
irsense3.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 IRSENSE3_H
36 #define IRSENSE3_H
37 
38 #include "drv_digital_in.h"
39 #include "drv_i2c_master.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define IRSENSE3_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
53  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
54  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
55 
61 #define IRSENSE3_RETVAL uint8_t
62 
63 #define IRSENSE3_OK 0x00
64 #define IRSENSE3_INIT_ERROR 0xFF
65 
71 #define IRSENSE3_REG_COMPANY_CODE 0x00
72 #define IRSENSE3_REG_DEVICE_ID 0x01
73 #define IRSENSE3_REG_INFO_1 0x02
74 #define IRSENSE3_REG_INFO_2 0x03
75 #define IRSENSE3_REG_STATUS_1 0x04
76 #define IRSENSE3_REG_IR_LSB 0x05
77 #define IRSENSE3_REG_IR_MSB 0x06
78 #define IRSENSE3_REG_TEMP_LSB 0x07
79 #define IRSENSE3_REG_TEMP_MSB 0x08
80 #define IRSENSE3_REG_STATUS_2 0x09
81 #define IRSENSE3_REG_STATUS_3 0x0A
82 #define IRSENSE3_REG_STATUS_4 0x1F
83 #define IRSENSE3_REG_CTRL_1 0x20
84 #define IRSENSE3_REG_CTRL_2 0x21
85 #define IRSENSE3_REG_CTRL_3 0x22
86 #define IRSENSE3_REG_CTRL_4 0x23
87 #define IRSENSE3_REG_CTRL_5 0x24
88 #define IRSENSE3_REG_CTRL_6 0x25
89 #define IRSENSE3_REG_CTRL_7 0x26
90 #define IRSENSE3_REG_CTRL_8 0x27
91 #define IRSENSE3_REG_CTRL_9 0x28
92 #define IRSENSE3_REG_CTRL_10 0x29
93 #define IRSENSE3_REG_CTRL_11 0x2A
94 #define IRSENSE3_REG_CTRL_12 0x2B
95 
101 #define IRSENSE3_DEVICE_ID 0x15
102 #define IRSENSE3_COMPANY_CODE 0x48
103 
109 #define IRSENSE3_CTRL1_NORMAL_STATE 0xFE
110 #define IRSENSE3_CTRL1_SOFTWARE_RESET 0xFF
111 
117 #define IRSENSE3_CTRL2_NO_SYNC 0xFC
118 #define IRSENSE3_CTRL2_MASTER_SYNC 0xFD
119 #define IRSENSE3_CTRL2_SLAVE_SYNC 0xFE
120 
126 #define IRSENSE3_CTRL3_LOW_NOISE_DISABLE 0x80
127 #define IRSENSE3_CTRL3_LOW_NOISE_ENABLE 0xC0
128 #define IRSENSE3_CTRL3_ODR_1Hz 0x80
129 #define IRSENSE3_CTRL3_ODR_2Hz 0x90
130 #define IRSENSE3_CTRL3_ODR_10Hz 0xA0
131 #define IRSENSE3_CTRL3_ODR_50Hz 0xB0
132 #define IRSENSE3_CTRL3_NO_TEMP_FILTER 0x80
133 #define IRSENSE3_CTRL3_TEMP_FILTER_0p9Hz 0x84
134 #define IRSENSE3_CTRL3_TEMP_FILTER_0p445Hz 0x88
135 #define IRSENSE3_CTRL3_NO_IR_FILTER 0x80
136 #define IRSENSE3_CTRL3_IR_FILTER_0p9Hz 0x81
137 #define IRSENSE3_CTRL3_IR_FILTER_0p445Hz 0x82
138 
144 #define IRSENSE3_CTRL4_TOPT_THR_DISABLE 0xF8
145 #define IRSENSE3_CTRL4_TOPT_THR_ENABLE 0xFC
146 #define IRSENSE3_CTRL4_TOPT_NOISE_DISABLE 0xF8
147 #define IRSENSE3_CTRL4_TOPT_NOISE_ENABLE 0xFB
148 
154 #define IRSENSE3_CTRL7_HUMAN_DETECT_NORMAL 0xF0
155 #define IRSENSE3_CTRL7_HUMAN_DETECT_INVERT 0xF8
156 #define IRSENSE3_CTRL7_HUMAN_DETECT_TIME_0sec 0xF0
157 #define IRSENSE3_CTRL7_HUMAN_DETECT_TIME_5sec 0xF1
158 #define IRSENSE3_CTRL7_HUMAN_DETECT_TIME_10sec 0xF2
159 #define IRSENSE3_CTRL7_HUMAN_DETECT_TIME_30sec 0xF3
160 #define IRSENSE3_CTRL7_HUMAN_DETECT_TIME_300sec 0xF4
161 
167 #define IRSENSE3_CTRL11_HBDEN_OFF 0xE0
168 #define IRSENSE3_CTRL11_HBDEN_ON 0xF0
169 #define IRSENSE3_CTRL11_DO_NOT_STOP_UPDATING_SB 0xE0
170 #define IRSENSE3_CTRL11_STOP_UPDATING_SB 0xE8
171 #define IRSENSE3_CTRL11_STREAMING_BUFFER_OFF 0xE0
172 #define IRSENSE3_CTRL11_STREAMING_BUFFER_ON 0xE4
173 #define IRSENSE3_CTRL11_INT_HUMAN_DISABLE 0xE0
174 #define IRSENSE3_CTRL11_INT_HUMAN_ENABLE 0xE2
175 #define IRSENSE3_CTRL11_INT_DRDY_DISABLE 0xE0
176 #define IRSENSE3_CTRL11_INT_DRDY_ENABLE 0xE1
177 
183 #define IRSENSE3_CTRL12_STANDBY_MODE 0xFE
184 #define IRSENSE3_CTRL12_CONTINUOUS_MODE 0xFF
185 
191 #define IRSENSE3_PRESENCE_IS_DETECTED 0x01
192 #define IRSENSE3_PRESENCE_IS_NOT_DETECTED 0x00
193  // End group macro
196 // --------------------------------------------------------------- PUBLIC TYPES
205 typedef struct
206 {
207  // Input pins
208 
209  digital_in_t int_pin;
210 
211  // Modules
212 
213  i2c_master_t i2c;
214 
215  // ctx variable
216 
217  uint8_t slave_address;
218 
219 } irsense3_t;
220 
224 typedef struct
225 {
226  // Communication gpio pins
227 
228  pin_name_t scl;
229  pin_name_t sda;
230 
231  // Additional gpio pins
232 
233  pin_name_t int_pin;
234 
235  // static variable
236 
237  uint32_t i2c_speed;
238  uint8_t i2c_address;
239 
241  // End types group
243 
244 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
245 
251 #ifdef __cplusplus
252 extern "C"{
253 #endif
254 
263 void irsense3_cfg_setup ( irsense3_cfg_t *cfg );
264 
273 
274 
282 void irsense3_default_cfg ( irsense3_t *ctx );
283 
294 void irsense3_generic_write ( irsense3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
295 
307 void irsense3_generic_read ( irsense3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
308 
317 
326 
335 
344 
351 
362 void irsense3_generic_write ( irsense3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
363 
375 void irsense3_generic_read ( irsense3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
376 
377 #ifdef __cplusplus
378 }
379 #endif
380 #endif // _IRSENSE3_H_
381  // End public_function group
384 
385 // ------------------------------------------------------------------------- END
irsense3_default_cfg
void irsense3_default_cfg(irsense3_t *ctx)
Click Default Configuration function.
irsense3_t::i2c
i2c_master_t i2c
Definition: irsense3.h:213
irsense3_cfg_t::int_pin
pin_name_t int_pin
Definition: irsense3.h:233
irsense3_get_interrupt_state
uint8_t irsense3_get_interrupt_state(irsense3_t *ctx)
Get Interrupt state.
irsense3_generic_read
void irsense3_generic_read(irsense3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
irsense3_t
Click ctx object definition.
Definition: irsense3.h:205
irsense3_cfg_setup
void irsense3_cfg_setup(irsense3_cfg_t *cfg)
Config Object Initialization function.
irsense3_t::int_pin
digital_in_t int_pin
Definition: irsense3.h:209
irsense3_cfg_t::scl
pin_name_t scl
Definition: irsense3.h:228
irsense3_generic_write
void irsense3_generic_write(irsense3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
irsense3_init
IRSENSE3_RETVAL irsense3_init(irsense3_t *ctx, irsense3_cfg_t *cfg)
Initialization function.
irsense3_human_approach_detect
uint8_t irsense3_human_approach_detect(irsense3_t *ctx)
Human approach detection.
irsense3_software_reset
void irsense3_software_reset(irsense3_t *ctx)
Software reset.
irsense3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: irsense3.h:237
irsense3_get_temperature_data
float irsense3_get_temperature_data(irsense3_t *ctx)
Temperature data.
irsense3_t::slave_address
uint8_t slave_address
Definition: irsense3.h:217
irsense3_cfg_t::sda
pin_name_t sda
Definition: irsense3.h:229
irsense3_get_ir_sensor_data
float irsense3_get_ir_sensor_data(irsense3_t *ctx)
Output current of IR sensor.
irsense3_cfg_t
Click configuration structure definition.
Definition: irsense3.h:224
IRSENSE3_RETVAL
#define IRSENSE3_RETVAL
Definition: irsense3.h:61
irsense3_cfg_t::i2c_address
uint8_t i2c_address
Definition: irsense3.h:238