presence  2.0.0.0
presence.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 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 // -------------------------------------------------------------- PUBLIC MACROS
52 #define PRESENCE_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
56 
62 #define PRESENCE_OK 0
63 #define PRESENCE_ERROR -1
64 
70 #define PRESENCE_REG_TP_OBJECT_MSB 0x01
71 #define PRESENCE_REG_TP_OBJECT_MID 0x02
72 #define PRESENCE_REG_TP_OBJECT_LSB 0x03
73 #define PRESENCE_REG_TP_AMBIENT_MSB 0x03
74 #define PRESENCE_REG_TP_AMBIENT_LSB 0x04
75 #define PRESENCE_REG_TP_OBJECT_LP1_MSB 0x05
76 #define PRESENCE_REG_TP_OBJECT_LP1_MID 0x06
77 #define PRESENCE_REG_TP_OBJECT_LP1_LSB 0x07
78 #define PRESENCE_REG_TP_OBJECT_LP2_MSB 0x07
79 #define PRESENCE_REG_TP_OBJECT_LP2_MID 0x08
80 #define PRESENCE_REG_TP_OBJECT_LP2_LSB 0x09
81 #define PRESENCE_REG_TP_AMBIENT_LP3_MSB 0x0A
82 #define PRESENCE_REG_TP_AMBIENT_LP3_LSB 0x0B
83 #define PRESENCE_REG_TP_OBJECT_LP2F_MSB 0x0C
84 #define PRESENCE_REG_TP_OBJECT_LP2F_MID 0x0D
85 #define PRESENCE_REG_TP_OBJECT_LP2F_LSB 0x0E
86 #define PRESENCE_REG_TP_PRESENCE 0x0F
87 #define PRESENCE_REG_TP_MOTION 0x10
88 #define PRESENCE_REG_TP_AMBIENT_SHOCK 0x11
89 #define PRESENCE_REG_INTERRUPT_STATUS 0x12
90 #define PRESENCE_REG_CHIP_STATUS 0x13
91 #define PRESENCE_REG_LOW_PASS_TIME_1 0x14
92 #define PRESENCE_REG_LOW_PASS_TIME_2 0x15
93 #define PRESENCE_REG_TP_PRESENCE_THR 0x16
94 #define PRESENCE_REG_TP_MOTION_THR 0x17
95 #define PRESENCE_REG_TP_AMB_SHOCK_THR 0x18
96 #define PRESENCE_REG_INTERRUPT_MASK_1 0x19
97 #define PRESENCE_REG_INTERRUPT_MASK_2 0x1A
98 #define PRESENCE_REG_TIMER_INTERRUPT 0x1B
99 #define PRESENCE_REG_TP_OT_THR_1 0x1C
100 #define PRESENCE_REG_TP_OT_THR_2 0x1D
101 #define PRESENCE_REG_EEPROM_CTRL 0x1F
102 
108 #define PRESENCE_EEPROM_PROTOCOL 0x20
109 #define PRESENCE_EEPROM_CHECKSUM_1 0x21
110 #define PRESENCE_EEPROM_CHECKSUM_2 0x22
111 #define PRESENCE_EEPROM_LOOKUP 0x29
112 #define PRESENCE_EEPROM_PTAT25_1 0x2A
113 #define PRESENCE_EEPROM_PTAT25_2 0x2B
114 #define PRESENCE_EEPROM_M_1 0x2C
115 #define PRESENCE_EEPROM_M_2 0x2D
116 #define PRESENCE_EEPROM_U0_1 0x2E
117 #define PRESENCE_EEPROM_U0_2 0x2F
118 #define PRESENCE_EEPROM_UOUT_1 0x30
119 #define PRESENCE_EEPROM_UOUT_2 0x31
120 #define PRESENCE_EEPROM_TOBJ 0x32
121 #define PRESENCE_EEPROM_SLAVE_ADDR 0x3F
122 
128 #define PRESENCE_DEVICE_SLAVE_ADDRESS 0x0C
129 #define PRESENCE_DEVICE_GEN_CALL_ADDRESS 0x00
130 
136 #define PRESENCE_LOW_PASS_TIME_512S 0x00
137 #define PRESENCE_LOW_PASS_TIME_256S 0x01
138 #define PRESENCE_LOW_PASS_TIME_128S 0x02
139 #define PRESENCE_LOW_PASS_TIME_64S 0x03
140 #define PRESENCE_LOW_PASS_TIME_32S 0x04
141 #define PRESENCE_LOW_PASS_TIME_16S 0x05
142 #define PRESENCE_LOW_PASS_TIME_8S 0x08
143 #define PRESENCE_LOW_PASS_TIME_4S 0x09
144 #define PRESENCE_LOW_PASS_TIME_2S 0x0A
145 #define PRESENCE_LOW_PASS_TIME_1S 0x0B
146 #define PRESENCE_LOW_PASS_TIME_0P50S 0x0C
147 #define PRESENCE_LOW_PASS_TIME_0P25S 0x0D
148 
154 #define PRESENCE_INT_MASK1_TP_OT 0x10
155 #define PRESENCE_INT_MASK1_PRESENCE 0x08
156 #define PRESENCE_INT_MASK1_MOTION 0x04
157 #define PRESENCE_INT_MASK1_AMB_SHOCK 0x02
158 #define PRESENCE_INT_MASK1_TIMER 0x01
159 
165 #define PRESENCE_INT_MASK2_TPOT_DIR 0x10
166 #define PRESENCE_INT_MASK2_SRC_TPOBJ_LP2 ( 0x00 << 2 )
167 #define PRESENCE_INT_MASK2_SRC_LP1_LP2 ( 0x01 << 2 )
168 #define PRESENCE_INT_MASK2_SRC_TPOBJ_LP2FROZEN ( 0x02 << 2 )
169 #define PRESENCE_INT_MASK2_SRC_LP1_LP2FROZEN ( 0x03 << 2 )
170 #define PRESENCE_INT_MASK2_CYCLE_TIME_30MS 0x00
171 #define PRESENCE_INT_MASK2_CYCLE_TIME_60MS 0x01
172 #define PRESENCE_INT_MASK2_CYCLE_TIME_120MS 0x02
173 #define PRESENCE_INT_MASK2_CYCLE_TIME_140MS 0x04
174  // End group macro
177 // --------------------------------------------------------------- PUBLIC TYPES
183 typedef struct
184 {
185  uint16_t ptat25_data;
186  uint16_t m_data;
187  uint16_t u0_data;
188  uint8_t tobj_data;
189  uint32_t uout_data;
190  uint16_t checksum_data;
191 
192 } eeprom_data_t;
193 
197 typedef struct
198 {
199  // Input pins
200  digital_in_t int_pin;
201 
202  // Modules
203  i2c_master_t i2c;
204 
205  // ctx variable
206  uint8_t slave_address;
207 
209 
210 } presence_t;
211 
215 typedef struct
216 {
217  // Communication gpio pins
218  pin_name_t scl;
219  pin_name_t sda;
220 
221  // Additional gpio pins
222  pin_name_t int_pin;
223 
224  // static variable
225  uint32_t i2c_speed;
226  uint8_t i2c_address;
227 
229 
230  // End types group
232 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
233 
239 #ifdef __cplusplus
240 extern "C"{
241 #endif
242 
252 
262 
276 
290 err_t presence_generic_write ( presence_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
291 
305 err_t presence_generic_read ( presence_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
306 
315 
324 
339 
350 
362 err_t presence_ambient_temperature( presence_t *ctx, float *temperature );
363 
375 err_t presence_object_temperature( presence_t *ctx, float *temperature );
376 
377 #ifdef __cplusplus
378 }
379 #endif
380 #endif // _PRESENCE_H_
381  // End public_function group
384 
385 // ------------------------------------------------------------------------- END
presence_t::eeprom_data
eeprom_data_t eeprom_data
Definition: presence.h:208
presence_cfg_t::sda
pin_name_t sda
Definition: presence.h:219
presence_t::i2c
i2c_master_t i2c
Definition: presence.h:203
presence_cfg_t::i2c_address
uint8_t i2c_address
Definition: presence.h:226
eeprom_data_t::m_data
uint16_t m_data
Definition: presence.h:186
presence_get_int_state
uint8_t presence_get_int_state(presence_t *ctx)
Get interrupt state function.
presence_ambient_temperature
err_t presence_ambient_temperature(presence_t *ctx, float *temperature)
Ambient Temperature.
presence_general_call_addr
void presence_general_call_addr(presence_t *ctx)
General call address.
presence_t::int_pin
digital_in_t int_pin
Definition: presence.h:200
eeprom_data_t::tobj_data
uint8_t tobj_data
Definition: presence.h:188
eeprom_data_t
Definition: presence.h:184
presence_cfg_setup
void presence_cfg_setup(presence_cfg_t *cfg)
Config Object Initialization function.
eeprom_data_t::uout_data
uint32_t uout_data
Definition: presence.h:189
presence_init
err_t presence_init(presence_t *ctx, presence_cfg_t *cfg)
Initialization function.
presence_cfg_t::int_pin
pin_name_t int_pin
Definition: presence.h:222
presence_t
Click ctx object definition.
Definition: presence.h:198
presence_object_temperature
err_t presence_object_temperature(presence_t *ctx, float *temperature)
Object Temperature.
presence_get_calib_constants
float presence_get_calib_constants(presence_t *ctx)
Calibration constant K.
presence_default_cfg
err_t presence_default_cfg(presence_t *ctx)
Presence default configuration function.
eeprom_data_t::u0_data
uint16_t u0_data
Definition: presence.h:187
presence_generic_write
err_t presence_generic_write(presence_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
presence_generic_read
err_t presence_generic_read(presence_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
eeprom_data_t::checksum_data
uint16_t checksum_data
Definition: presence.h:190
eeprom_data_t::ptat25_data
uint16_t ptat25_data
Definition: presence.h:185
presence_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: presence.h:225
presence_cfg_t::scl
pin_name_t scl
Definition: presence.h:218
presence_eeprom_process
err_t presence_eeprom_process(presence_t *ctx)
EEPRM PROCESS.
presence_cfg_t
Click configuration structure definition.
Definition: presence.h:216
presence_t::slave_address
uint8_t slave_address
Definition: presence.h:206