presence  2.0.0.0
presence.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef PRESENCE_H
36 #define PRESENCE_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 PRESENCE_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
56  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
57 
63 #define PRESENCE_RETVAL uint8_t
64 
65 #define PRESENCE_OK 0x00
66 #define PRESENCE_INIT_ERROR 0xFF
67 
73 #define PRESENCE_REG_TP_OBJECT_MSB 0x01
74 #define PRESENCE_REG_TP_OBJECT_MID 0x02
75 #define PRESENCE_REG_TP_OBJECT_LSB 0x03
76 #define PRESENCE_REG_TP_AMBIENT_MSB 0x03
77 #define PRESENCE_REG_TP_AMBIENT_LSB 0x04
78 #define PRESENCE_REG_TP_OBJECT_LP1_MSB 0x05
79 #define PRESENCE_REG_TP_OBJECT_LP1_MID 0x06
80 #define PRESENCE_REG_TP_OBJECT_LP1_LSB 0x07
81 #define PRESENCE_REG_TP_OBJECT_LP2_MSB 0x07
82 #define PRESENCE_REG_TP_OBJECT_LP2_MID 0x08
83 #define PRESENCE_REG_TP_OBJECT_LP2_LSB 0x09
84 #define PRESENCE_REG_TP_AMBIENT_LP3_MSB 0x0A
85 #define PRESENCE_REG_TP_AMBIENT_LP3_LSB 0x0B
86 #define PRESENCE_REG_TP_OBJECT_LP2F_MSB 0x0C
87 #define PRESENCE_REG_TP_OBJECT_LP2F_MID 0x0D
88 #define PRESENCE_REG_TP_OBJECT_LP2F_LSB 0x0E
89 #define PRESENCE_REG_TP_PRESENCE 0x0F
90 #define PRESENCE_REG_TP_MOTION 0x10
91 #define PRESENCE_REG_TP_AMBIENT_SHOCK 0x11
92 #define PRESENCE_REG_INTERRUPT_STATUS 0x12
93 #define PRESENCE_REG_CHIP_STATUS 0x13
94 #define PRESENCE_REG_LOW_PASS_TIME_1 0x14
95 #define PRESENCE_REG_LOW_PASS_TIME_2 0x15
96 #define PRESENCE_REG_TP_PRESENCE_THR 0x16
97 #define PRESENCE_REG_TP_MOTION_THR 0x17
98 #define PRESENCE_REG_TP_AMB_SHOCK_THR 0x18
99 #define PRESENCE_REG_INTERRUPT_MASK_1 0x19
100 #define PRESENCE_REG_INTERRUPT_MASK_2 0x1A
101 #define PRESENCE_REG_TIMER_INTERRUPT 0x1B
102 #define PRESENCE_REG_TP_OT_THR_1 0x1C
103 #define PRESENCE_REG_TP_OT_THR_2 0x1D
104 #define PRESENCE_REG_EEPROM_CTRL 0x1F
105 
111 #define PRESENCE_EEPROM_PROTOCOL 0x20
112 #define PRESENCE_EEPROM_CHECKSUM_1 0x21
113 #define PRESENCE_EEPROM_CHECKSUM_2 0x22
114 #define PRESENCE_EEPROM_LOOKUP 0x29
115 #define PRESENCE_EEPROM_PTAT25_1 0x2A
116 #define PRESENCE_EEPROM_PTAT25_2 0x2B
117 #define PRESENCE_EEPROM_M_1 0x2C
118 #define PRESENCE_EEPROM_M_2 0x2D
119 #define PRESENCE_EEPROM_U0_1 0x2E
120 #define PRESENCE_EEPROM_U0_2 0x2F
121 #define PRESENCE_EEPROM_UOUT_1 0x30
122 #define PRESENCE_EEPROM_UOUT_2 0x31
123 #define PRESENCE_EEPROM_TOBJ 0x32
124 #define PRESENCE_EEPROM_SLAVE_ADDR 0x3F
125 
131 #define PRESENCE_DEVICE_SLAVE_ADDRESS 0x0C
132 
138 #define PRESENCE_LOW_PASS_TIME_512s 0x00
139 #define PRESENCE_LOW_PASS_TIME_256s 0x01
140 #define PRESENCE_LOW_PASS_TIME_128s 0x02
141 #define PRESENCE_LOW_PASS_TIME_64s 0x03
142 #define PRESENCE_LOW_PASS_TIME_32s 0x04
143 #define PRESENCE_LOW_PASS_TIME_16s 0x05
144 #define PRESENCE_LOW_PASS_TIME_8s 0x08
145 #define PRESENCE_LOW_PASS_TIME_4s 0x09
146 #define PRESENCE_LOW_PASS_TIME_2s 0x0A
147 #define PRESENCE_LOW_PASS_TIME_1s 0x0B
148 #define PRESENCE_LOW_PASS_TIME_0p50s 0x0C
149 #define PRESENCE_LOW_PASS_TIME_0p25s 0x0D
150 
156 #define PRESENCE_INT_MASK1_TP_OT 0x10
157 #define PRESENCE_INT_MASK1_MOTION 0x04
158 #define PRESENCE_INT_MASK1_PRESENCE 0x08
159 #define PRESENCE_INT_MASK1_AMB_SHOCK 0x02
160 #define PRESENCE_INT_MASK1_TIMER 0x01
161 
167 #define PRESENCE_INT_MASK2_TPOT_DIR 0x10
168 #define PRESENCE_INT_MASK2_SRC_TPobj_LP2 0x00 << 2
169 #define PRESENCE_INT_MASK2_SRC_LP1_LP2 0x01 << 2
170 #define PRESENCE_INT_MASK2_SRC_TPobj_LP2Frozen 0x02 << 2
171 #define PRESENCE_INT_MASK2_SRC_LP1_LP2Frozen 0x03 << 2
172 #define PRESENCE_INT_MASK2_CYCLE_TIME_30ms 0x00
173 #define PRESENCE_INT_MASK2_CYCLE_TIME_60ms 0x01
174 #define PRESENCE_INT_MASK2_CYCLE_TIME_120ms 0x02
175 #define PRESENCE_INT_MASK2_CYCLE_TIME_140ms 0x04
176 
182 #define NULL 0x00
183  // End group macro
186 // --------------------------------------------------------------- PUBLIC TYPES
192 typedef struct
193 {
194  uint8_t *eeprom;
195  uint16_t ptat25_data;
196  uint16_t m_data;
197  uint16_t u0_data;
198  uint8_t tobj_data;
199  uint32_t uout_data;
200  uint16_t checksum_data;
201 
202 } eeprom_data_t;
203 
204 
208 typedef struct
209 {
210  // Input pins
211 
212  digital_in_t int_pin;
213 
214  // Modules
215 
216  i2c_master_t i2c;
217 
218  // ctx variable
219 
220  hal_i2c_address_t slave_address;
221 
223 
224 } presence_t;
225 
229 typedef struct
230 {
231  // Communication gpio pins
232 
233  pin_name_t scl;
234  pin_name_t sda;
235 
236  // Additional gpio pins
237 
238  pin_name_t int_pin;
239 
240  // static variable
241 
242  hal_i2c_speed_t i2c_speed;
243  hal_i2c_address_t i2c_address;
244 
245 
246 
248 
249  // End types group
251 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
252 
258 #ifdef __cplusplus
259 extern "C"{
260 #endif
261 
270 void presence_cfg_setup ( presence_cfg_t *cfg );
271 
280 
291 void presence_generic_write ( presence_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
292 
304 void presence_generic_read ( presence_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
305 
307 
316 
330 uint8_t presence_eeprom_process ( presence_t *ctx );
331 
340 
351 
362 
363 #ifdef __cplusplus
364 }
365 #endif
366 #endif // _PRESENCE_H_
367  // End public_function group
370 
371 // ------------------------------------------------------------------------- END
digital_in_t int_pin
Definition: presence.h:212
void presence_general_call_addr(presence_t *ctx)
General call address.
uint16_t ptat25_data
Definition: presence.h:195
pin_name_t scl
Definition: presence.h:233
float presence_get_calib_constants()
Calibration constant K.
i2c_master_t i2c
Definition: presence.h:216
uint16_t checksum_data
Definition: presence.h:200
void presence_cfg_setup(presence_cfg_t *cfg)
Config Object Initialization function.
Click configuration structure definition.
Definition: presence.h:229
Click ctx object definition.
Definition: presence.h:208
#define PRESENCE_RETVAL
Definition: presence.h:63
uint8_t presence_get_interrupt_state(presence_t *ctx)
hal_i2c_address_t i2c_address
Definition: presence.h:243
uint8_t * eeprom
Definition: presence.h:194
hal_i2c_speed_t i2c_speed
Definition: presence.h:242
uint16_t u0_data
Definition: presence.h:197
Definition: presence.h:192
eeprom_data_t eeprom_data
Definition: presence.h:222
pin_name_t int_pin
Definition: presence.h:238
uint8_t tobj_data
Definition: presence.h:198
float presence_ambient_temperature(presence_t *ctx)
Ambient Temperature.
float presence_object_temperature(presence_t *ctx)
Object Temperature.
PRESENCE_RETVAL presence_init(presence_t *ctx, presence_cfg_t *cfg)
Initialization function.
uint16_t m_data
Definition: presence.h:196
void presence_generic_write(presence_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
void presence_generic_read(presence_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
pin_name_t sda
Definition: presence.h:234
hal_i2c_address_t slave_address
Definition: presence.h:220
uint8_t presence_eeprom_process(presence_t *ctx)
EEPRM PROCESS.
uint32_t uout_data
Definition: presence.h:199