grideye  2.0.0.0
grideye.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 GRIDEYE_H
36 #define GRIDEYE_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_in.h"
49 #include "drv_i2c_master.h"
50 
51 // -------------------------------------------------------------- PUBLIC MACROS
61 #define GRIDEYE_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
63  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
64  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
65 
71 #define GRIDEYE_RETVAL int8_t
72 
73 #define GRIDEYE_OK 0
74 #define GRIDEYE_INIT_ERROR (-1)
75 
81 #define GRIDEYE_I2C_ADDR 0x68
82 
88 #define GRIDEYE_PCLT 0x00
89 #define GRIDEYE_RST 0x01
90 #define GRIDEYE_FPSC 0x02
91 #define GRIDEYE_INTC 0x03
92 #define GRIDEYE_STAT 0x04
93 #define GRIDEYE_SCLR 0x05
94 #define GRIDEYE_AVE 0x07
95 
96 #define GRIDEYE_INTHL 0x08
97 #define GRIDEYE_INTHH 0x09
98 #define GRIDEYE_INTLL 0x0A
99 #define GRIDEYE_INTLH 0x0B
100 #define GRIDEYE_IHYSL 0x0C
101 #define GRIDEYE_IHYSH 0x0D
102 #define GRIDEYE_TTHL 0x0E
103 #define GRIDEYE_TTHH 0x0F
104 
110 #define GRIDEYE_INT0 0x10
111 #define GRIDEYE_INT1 0x11
112 #define GRIDEYE_INT2 0x12
113 #define GRIDEYE_INT3 0x13
114 #define GRIDEYE_INT4 0x14
115 #define GRIDEYE_INT5 0x15
116 #define GRIDEYE_INT6 0x16
117 #define GRIDEYE_INT7 0x17
118 
124 #define GRIDEYE_PCLT_NORMAL 0x00
125 #define GRIDEYE_PCLT_SLEEP 0x10
126 #define GRIDEYE_PCLT_STANDBY_60 0x20
127 #define GRIDEYE_PCLT_STANDBY_10 0x21
128 
134 #define GRIDEYE_RST_FLAG 0x30
135 #define GRIDEYE_RST_INIT 0x3F
136 
142 #define GRIDEYE_FPSC_1FPS 0x01
143 #define GRIDEYE_FPSC_10FPS 0x00
144 
150 #define GRIDEYE_INTC_INTEN_ACTIVE 0x01
151 #define GRIDEYE_INTC_INTEN_INACTIVE 0x00
152 #define GRIDEYE_INTC_INTMOD_ABSO 0x10
153 #define GRIDEYE_INTC_INTMOD_DIFE 0x00
154 
160 #define GRIDEYE_SCLR_INTCLR 0x02
161 #define GRIDEYE_SCLR_OVS_CLR 0x04
162 #define GRIDEYE_SCLR_OVT_CLR 0x08
163 
169 #define GRIDEYE_AVE_MAMOD_ACTIVE 0x20
170 #define GRIDEYE_AVE_MAMOD_INACTIVE 0x00
171 
177 #define GRIDEYE_PIXELS 0x80
178  // End group macro
181 // --------------------------------------------------------------- PUBLIC TYPES
190 typedef struct
191 {
192  // Input pins
193 
194  digital_in_t int_pin;
195 
196  // Modules
197 
198  i2c_master_t i2c;
199 
200  // ctx variable
201 
202  uint8_t slave_address;
203 
204 } grideye_t;
205 
209 typedef struct
210 {
211  // Communication gpio pins
212 
213  pin_name_t scl;
214  pin_name_t sda;
215 
216  // Additional gpio pins
217 
218  pin_name_t int_pin;
219 
220  // static variable
221 
222  uint32_t i2c_speed;
223  uint8_t i2c_address;
224 
225 } grideye_cfg_t;
226  // End types group
228 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
229 
235 #ifdef __cplusplus
236 extern "C"{
237 #endif
238 
248 
257 
266 
276 void grideye_generic_write ( grideye_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
277 
289 void grideye_generic_read ( grideye_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
290 
302 void grideye_write_data ( grideye_t *ctx, uint8_t wr_addr, uint16_t wr_data );
303 
314 uint16_t grideye_read_data ( grideye_t *ctx, uint8_t rd_addr );
315 
324 void grideye_read_grid ( grideye_t *ctx, int16_t *buffer );
325 
338 
348 void grideye_set_power_control ( grideye_t *ctx, uint8_t pow_cnt );
349 
361 
371 
381 
390 
399 
411 uint8_t grideye_check_fps ( grideye_t *ctx );
412 
422 void grideye_set_int_ctl_reg ( grideye_t *ctx, uint8_t int_cnt );
423 
435 
447 
457 void grideye_set_stat_clr_reg ( grideye_t *ctx, uint8_t int_cnt );
458 
469 void grideye_set_ave_reg ( grideye_t *ctx, uint8_t mamod );
470 
482 
491 void grideye_write_int_lvl_high ( grideye_t *ctx, uint16_t wr_data );
492 
500 void grideye_write_int_lvl_low( grideye_t *ctx, uint16_t wr_data );
501 
512 
523 
532 void grideye_write_int_hyst_lvl ( grideye_t *ctx, uint16_t wr_data );
533 
544 
555 
565 uint8_t grideye_read_int0 ( grideye_t *ctx );
566 
576 uint8_t grideye_read_int1 ( grideye_t *ctx );
586 uint8_t grideye_read_int2 ( grideye_t *ctx );
587 
597 uint8_t grideye_read_int3 ( grideye_t *ctx );
598 
608 uint8_t grideye_read_int4 ( grideye_t *ctx );
609 
619 uint8_t grideye_read_int5 ( grideye_t *ctx );
620 
630 uint8_t grideye_read_int6 ( grideye_t *ctx );
631 
641 uint8_t grideye_read_int7 ( grideye_t *ctx );
642 
643 #ifdef __cplusplus
644 }
645 #endif
646 #endif // GRIDEYE_H
647  // End public_function group // End click Driver group
650 
651 // ------------------------------------------------------------------------ END
grideye_read_int5
uint8_t grideye_read_int5(grideye_t *ctx)
Read Interrupt Table Register 5 function.
grideye_cfg_t::scl
pin_name_t scl
Definition: grideye.h:213
grideye_write_data
void grideye_write_data(grideye_t *ctx, uint8_t wr_addr, uint16_t wr_data)
Write data function.
grideye_read_grid
void grideye_read_grid(grideye_t *ctx, int16_t *buffer)
Read whole grid function.
grideye_write_int_lvl_low
void grideye_write_int_lvl_low(grideye_t *ctx, uint16_t wr_data)
Set interrupt level low function.
grideye_write_int_hyst_lvl
void grideye_write_int_hyst_lvl(grideye_t *ctx, uint16_t wr_data)
Set interrupt hysteresis level function.
grideye_set_stat_clr_reg
void grideye_set_stat_clr_reg(grideye_t *ctx, uint8_t int_cnt)
Set Status Clear Register function.
grideye_read_therm_temp_reg
float grideye_read_therm_temp_reg(grideye_t *ctx)
Read Thermistor Temperature Register function.
grideye_cfg_t::int_pin
pin_name_t int_pin
Definition: grideye.h:218
grideye_generic_write
void grideye_generic_write(grideye_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
grideye_read_ave_reg
uint8_t grideye_read_ave_reg(grideye_t *ctx)
Read Average Register function.
GRIDEYE_RETVAL
#define GRIDEYE_RETVAL
Definition: grideye.h:71
grideye_read_stat_reg
uint8_t grideye_read_stat_reg(grideye_t *ctx)
Read Status Register function.
grideye_set_fps1
void grideye_set_fps1(grideye_t *ctx)
Set FPS 1 function.
grideye_set_fps10
void grideye_set_fps10(grideye_t *ctx)
Set FPS 10 function.
grideye_read_int2
uint8_t grideye_read_int2(grideye_t *ctx)
Read Interrupt Table Register 2 function.
grideye_flag_reset
void grideye_flag_reset(grideye_t *ctx)
Flag reset function.
grideye_initial_reset
void grideye_initial_reset(grideye_t *ctx)
Initial reset function.
grideye_set_ave_reg
void grideye_set_ave_reg(grideye_t *ctx, uint8_t mamod)
Set Average Register function.
grideye_t::slave_address
uint8_t slave_address
Definition: grideye.h:202
grideye_check_interrupt
uint8_t grideye_check_interrupt(grideye_t *ctx)
Get Interrupt state function.
grideye_read_power_control
uint8_t grideye_read_power_control(grideye_t *ctx)
Read Power Control function.
grideye_read_int6
uint8_t grideye_read_int6(grideye_t *ctx)
Read Interrupt Table Register 6 function.
grideye_set_int_ctl_reg
void grideye_set_int_ctl_reg(grideye_t *ctx, uint8_t int_cnt)
Set Interrupt Control Register function.
grideye_cfg_t::sda
pin_name_t sda
Definition: grideye.h:214
grideye_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: grideye.h:222
grideye_default_cfg
void grideye_default_cfg(grideye_t *ctx)
Click Default Configuration function.
grideye_write_int_lvl_high
void grideye_write_int_lvl_high(grideye_t *ctx, uint16_t wr_data)
Set interrupt level high function.
grideye_read_data
uint16_t grideye_read_data(grideye_t *ctx, uint8_t rd_addr)
Data read function.
grideye_read_int_ctl_reg
uint8_t grideye_read_int_ctl_reg(grideye_t *ctx)
Read Interrupt Control Register function.
grideye_read_int7
uint8_t grideye_read_int7(grideye_t *ctx)
Read Interrupt Table Register 7 function.
grideye_cfg_setup
void grideye_cfg_setup(grideye_cfg_t *cfg)
Config Object Initialization function.
grideye_init
GRIDEYE_RETVAL grideye_init(grideye_t *ctx, grideye_cfg_t *cfg)
Initialization function.
grideye_t::int_pin
digital_in_t int_pin
Definition: grideye.h:194
grideye_t
Click ctx object definition.
Definition: grideye.h:191
grideye_set_power_control
void grideye_set_power_control(grideye_t *ctx, uint8_t pow_cnt)
Set Power Control function.
grideye_read_int_hyst_lvl
uint16_t grideye_read_int_hyst_lvl(grideye_t *ctx)
Read interrupt hysteresis level function.
grideye_read_int_lvl_low
uint16_t grideye_read_int_lvl_low(grideye_t *ctx)
Read interrupt level low function.
grideye_read_int0
uint8_t grideye_read_int0(grideye_t *ctx)
Read Interrupt Table Register 0 function.
grideye_check_fps
uint8_t grideye_check_fps(grideye_t *ctx)
Check FPS function.
grideye_read_int3
uint8_t grideye_read_int3(grideye_t *ctx)
Read Interrupt Table Register 3 function.
grideye_read_int_lvl_high
uint16_t grideye_read_int_lvl_high(grideye_t *ctx)
Read interrupt level high function.
grideye_t::i2c
i2c_master_t i2c
Definition: grideye.h:198
grideye_cfg_t::i2c_address
uint8_t i2c_address
Definition: grideye.h:223
grideye_generic_read
void grideye_generic_read(grideye_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
grideye_cfg_t
Click configuration structure definition.
Definition: grideye.h:210
grideye_read_int4
uint8_t grideye_read_int4(grideye_t *ctx)
Read Interrupt Table Register 4 function.
grideye_read_int1
uint8_t grideye_read_int1(grideye_t *ctx)
Read Interrupt Table Register 1 function.