oximeter3  2.0.0.0
oximeter3.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 OXIMETER3_H
36 #define OXIMETER3_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define OXIMETER3_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define OXIMETER3_RETVAL uint8_t
77 
78 #define OXIMETER3_OK 0x00
79 #define OXIMETER3_INIT_ERROR 0xFF
80 #define OXIMETER3_ERROR 0xFF
81 
87 #define OXIMETER3_SLAVE_ADDRESS 0x13
88 
93 #define OXIMETER3_REG_COMMAND 0x80
94 #define OXIMETER3_REG_PRODUCT_ID 0x81
95 #define OXIMETER3_REG_PROX_RATE 0x82
96 #define OXIMETER3_REG_LED_CURRENT 0x83
97 #define OXIMETER3_REG_ALS_PARAMETER 0x84
98 #define OXIMETER3_REG_ALS_RESULT_MSB 0x85
99 #define OXIMETER3_REG_ALS_RESULT_LSB 0x86
100 #define OXIMETER3_REG_PROX_RESULT_MSB 0x87
101 #define OXIMETER3_REG_PROX_RESULT_LSB 0x88
102 #define OXIMETER3_REG_INTERRUPT_CTRL 0x89
103 #define OXIMETER3_REG_LOW_THRESHOLD_MSB 0x8A
104 #define OXIMETER3_REG_LOW_THRESHOLD_LSB 0x8B
105 #define OXIMETER3_REG_HIGH_THRESHOLD_MSB 0x8C
106 #define OXIMETER3_REG_HIGH_THRESHOLD_LSB 0x8D
107 #define OXIMETER3_REG_INTERRUPT_STATUS 0x8E
108 #define OXIMETER3_REG_PROX_MODULATOR_TIMING 0x8F
109 
115 #define OXIMETER3_CMD_ALS_SINGLE_MEASUREMENT_ENABLE 0x10
116 #define OXIMETER3_CMD_ALS_SINGLE_MEASUREMENT_DISABLE 0x00
117 #define OXIMETER3_CMD_PROX_SINGLE_MEASUREMENT_ENABLE 0x08
118 #define OXIMETER3_CMD_PROX_SINGLE_MEASUREMENT_DISABLE 0x00
119 #define OXIMETER3_CMD_ALS_PERIODIC_MEASUREMENT_ENABLE 0x04
120 #define OXIMETER3_CMD_ALS_PERIODIC_MEASUREMENT_DISABLE 0x00
121 #define OXIMETER3_CMD_PROX_PERIODIC_MEASUREMENT_ENABLE 0x02
122 #define OXIMETER3_CMD_PROX_PERIODIC_MEASUREMENT_DISABLE 0x00
123 #define OXIMETER3_CMD_MEASUREMENT_ENABLE 0x01
124 #define OXIMETER3_CMD_MEASUREMENT_DISABLE 0x00
125 
126 #define OXIMETER3_CMD_ALS_DATA_READY 0x40
127 #define OXIMETER3_CMD_PROX_DATA_READY 0x20
128 
134 #define OXIMETER3_PROX_RATE_1p95_MPS 0x00
135 #define OXIMETER3_PROX_RATE_3p90625_MPS 0x01
136 #define OXIMETER3_PROX_RATE_7p8125_MPS 0x02
137 #define OXIMETER3_PROX_RATE_16p625_MPS 0x03
138 #define OXIMETER3_PROX_RATE_31p25_MPS 0x04
139 #define OXIMETER3_PROX_RATE_62p5_MPS 0x05
140 #define OXIMETER3_PROX_RATE_125_MPS 0x06
141 #define OXIMETER3_PROX_RATE_250_MPS 0x07
142 
148 #define OXIMETER3_LED_CURR_MIN 1
149 #define OXIMETER3_LED_CURR_MID 12
150 #define OXIMETER3_LED_CURR_MAX 20
151 
157 #define OXIMETER3_ALS_PARAM_CONT_CONVERSION_ENABLE 0x80
158 #define OXIMETER3_ALS_PARAM_CONT_CONVERSION_DISABLE 0x00
159 #define OXIMETER3_ALS_PARAM_AUTO_OFSEN_ENABLE 0x08
160 #define OXIMETER3_ALS_PARAM_AUTO_OFSEN_DISABLE 0x00
161 #define OXIMETER3_ALS_PARAM_1_SAMPEL_PER_S 0x00
162 #define OXIMETER3_ALS_PARAM_2_SAMPEL_PER_S 0x10
163 #define OXIMETER3_ALS_PARAM_3_SAMPEL_PER_S 0x20
164 #define OXIMETER3_ALS_PARAM_4_SAMPEL_PER_S 0x30
165 #define OXIMETER3_ALS_PARAM_5_SAMPEL_PER_S 0x40
166 #define OXIMETER3_ALS_PARAM_6_SAMPEL_PER_S 0x50
167 #define OXIMETER3_ALS_PARAM_8_SAMPEL_PER_S 0x60
168 #define OXIMETER3_ALS_PARAM_10_SAMPEL_PER_S 0x70
169 
175 #define OXIMETER3_INT_CTRL_1_CNT 0x00
176 #define OXIMETER3_INT_CTRL_2_CNT 0x20
177 #define OXIMETER3_INT_CTRL_4_CNT 0x40
178 #define OXIMETER3_INT_CTRL_8_CNT 0x60
179 #define OXIMETER3_INT_CTRL_16_CNT 0x80
180 #define OXIMETER3_INT_CTRL_32_CNT 0xA0
181 #define OXIMETER3_INT_CTRL_64_CNT 0xC0
182 #define OXIMETER3_INT_CTRL_128_CNT 0xE0
183 #define OXIMETER3_INT_CTRL_INT_ON_PROX_RDY 0x08
184 #define OXIMETER3_INT_CTRL_INT_ON_ALS_RDY 0x04
185 #define OXIMETER3_INT_CTRL_INT_ON_THRESHOLD 0x02
186 #define OXIMETER3_INT_CTRL_INT_ON_THRESHOLD_PROX 0x00
187 #define OXIMETER3_INT_CTRL_INT_ON_THRESHOLD_ALS 0x01
188 
194 #define OXIMETER3_INT_STATUS_PROX 0x08
195 #define OXIMETER3_INT_STATUS_ALS 0x04
196 #define OXIMETER3_INT_STATUS_LOW_THRESHOLD 0x02
197 #define OXIMETER3_INT_STATUS_HIGH_THRESHOLD 0x01
198 
204 #define OXIMETER3_PROX_TIMING_FREQ_390p625_KHZ 0x00
205 #define OXIMETER3_PROX_TIMING_FREQ_781p25_KHZ 0x01
206 #define OXIMETER3_PROX_TIMING_FREQ_1p5625_MHZ 0x10
207 #define OXIMETER3_PROX_TIMING_FREQ_3p125_MHZ 0x11
208 
214 #define OXIMETER3_ID_VAL 0x21
215 
221 #define OXIMETER3_ALS 0x11
222 #define OXIMETER3_PROX 0x22
223 #define OXIMETER3_HEART_RATE 0x33
224 
230 #define SHIFT_VALUE 8
231  // End group macro
234 // --------------------------------------------------------------- PUBLIC TYPES
243 typedef struct
244 {
245  digital_in_t int_pin;
246 
247  // Modules
248 
249  i2c_master_t i2c;
250 
251  // ctx variable
252 
253  uint8_t slave_address;
254 
255 } oximeter3_t;
256 
260 typedef struct
261 {
262  // Communication gpio pins
263 
264  pin_name_t scl;
265  pin_name_t sda;
266 
267  // Additional gpio pins
268 
269  pin_name_t int_pin;
270 
271  // static variable
272 
273  uint32_t i2c_speed;
274  uint8_t i2c_address;
275 
277  // End types group
279 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
280 
286 #ifdef __cplusplus
287 extern "C"{
288 #endif
289 
299 
308 
319 void oximeter3_generic_write ( oximeter3_t *ctx, uint8_t reg, uint8_t data_buf );
320 
330 uint8_t oximeter3_generic_read ( oximeter3_t *ctx, uint8_t reg );
331 
340 
351 uint16_t oximeter3_read_value ( oximeter3_t *ctx, uint8_t type_macro );
352 
353 #ifdef __cplusplus
354 }
355 #endif
356 #endif // _OXIMETER3_H_
357  // End public_function group
360 
361 // ------------------------------------------------------------------------- END
oximeter3_cfg_t::scl
pin_name_t scl
Definition: oximeter3.h:264
oximeter3_generic_read
uint8_t oximeter3_generic_read(oximeter3_t *ctx, uint8_t reg)
Generic read function.
oximeter3_cfg_t::int_pin
pin_name_t int_pin
Definition: oximeter3.h:269
oximeter3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: oximeter3.h:273
oximeter3_cfg_t::sda
pin_name_t sda
Definition: oximeter3.h:265
oximeter3_generic_write
void oximeter3_generic_write(oximeter3_t *ctx, uint8_t reg, uint8_t data_buf)
Generic write function.
oximeter3_cfg_t
Click configuration structure definition.
Definition: oximeter3.h:261
oximeter3_cfg_setup
void oximeter3_cfg_setup(oximeter3_cfg_t *cfg)
Config Object Initialization function.
oximeter3_read_value
uint16_t oximeter3_read_value(oximeter3_t *ctx, uint8_t type_macro)
Generic function for reading als and proximity values.
oximeter3_init
OXIMETER3_RETVAL oximeter3_init(oximeter3_t *ctx, oximeter3_cfg_t *cfg)
Initialization function.
oximeter3_t::int_pin
digital_in_t int_pin
Definition: oximeter3.h:245
OXIMETER3_RETVAL
#define OXIMETER3_RETVAL
Definition: oximeter3.h:76
oximeter3_get_int_status
uint8_t oximeter3_get_int_status(oximeter3_t *ctx)
Gets state of the int pin.
oximeter3_t::i2c
i2c_master_t i2c
Definition: oximeter3.h:249
oximeter3_t
Click ctx object definition.
Definition: oximeter3.h:244
oximeter3_cfg_t::i2c_address
uint8_t i2c_address
Definition: oximeter3.h:274
oximeter3_t::slave_address
uint8_t slave_address
Definition: oximeter3.h:253