heartrate2  2.0.0.0
heartrate2.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 HEARTRATE2_H
36 #define HEARTRATE2_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_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define HEARTRATE2_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
66  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
67  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
68 
74 #define HEARTRATE2_RETVAL uint8_t
75 
76 #define HEARTRATE2_OK_OK 0x00
77 #define HEARTRATE2_INIT_ERROR 0xFF
78 
84 #define HEARTRATE2_SLAVE_ADDRESS 0x62
85 
91 #define HEARTRATE2_REG_INT_STATUS_1 0x00
92 #define HEARTRATE2_REG_INT_STATUS_2 0x01
93 #define HEARTRATE2_REG_INT_ENABLE_1 0x02
94 #define HEARTRATE2_REG_INT_ENABLE_2 0x03
95 #define HEARTRATE2_REG_FIFO_WRITE_PTR 0x04
96 #define HEARTRATE2_REG_FIFO_READ_PTR 0x05
97 #define HEARTRATE2_REG_OVERFLOW_CNT 0x06
98 #define HEARTRATE2_REG_FIFO_DATA_CNT 0x07
99 #define HEARTRATE2_REG_FIFO_DATA_REG 0x08
100 #define HEARTRATE2_REG_FIFO_CFG_1 0x09
101 #define HEARTRATE2_REG_FIFO_CFG_2 0x0A
102 #define HEARTRATE2_REG_SYSTEM_CTRL 0x0D
103 #define HEARTRATE2_REG_PPG_SYNC_CTRL 0x10
104 #define HEARTRATE2_REG_PPG_CFG_1 0x11
105 #define HEARTRATE2_REG_PPG_CFG_2 0x12
106 #define HEARTRATE2_REG_PPG_CFG_3 0x13
107 #define HEARTRATE2_REG_PROX_INT_THRESHOLD 0x14
108 #define HEARTRATE2_REG_PHOTO_DIODE_BIAS 0x15
109 #define HEARTRATE2_REG_PICKET_FENCE 0x16
110 #define HEARTRATE2_REG_LED_SQUENCE_REG_1 0x20
111 #define HEARTRATE2_REG_LED_SQUENCE_REG_2 0x21
112 #define HEARTRATE2_REG_LED_SQUENCE_REG_3 0x22
113 #define HEARTRATE2_REG_LED_1_PA 0x23
114 #define HEARTRATE2_REG_LED_2_PA 0x24
115 #define HEARTRATE2_REG_LED_3_PA 0x25
116 #define HEARTRATE2_REG_LED_PILOT_PA 0x29
117 #define HEARTRATE2_REG_LED_RANGE_1 0x2A
118 #define HEARTRATE2_REG_S1_HI_RES_DAC_1 0x2C
119 #define HEARTRATE2_REG_S2_HI_RES_DAC_1 0x2D
120 #define HEARTRATE2_REG_S3_HI_RES_DAC_1 0x2E
121 #define HEARTRATE2_REG_S4_HI_RES_DAC_1 0x2F
122 #define HEARTRATE2_REG_S5_HI_RES_DAC_1 0x30
123 #define HEARTRATE2_REG_S6_HI_RES_DAC_1 0x31
124 #define HEARTRATE2_REG_DIE_TEMP_CFG 0x40
125 #define HEARTRATE2_REG_DIE_TEMP_INT 0x41
126 #define HEARTRATE2_REG_DIE_TEMP_FRAC 0x42
127 #define HEARTRATE2_REG_DAC_CALIBRATION_EN 0x50
128 #define HEARTRATE2_REG_SHA_CMD 0xF0
129 #define HEARTRATE2_REG_SHA_CFG 0xF1
130 #define HEARTRATE2_REG_MEM_CTRL 0xF2
131 #define HEARTRATE2_REG_MEM_INDEX 0xF3
132 #define HEARTRATE2_REG_MEM_DATA 0xF4
133 #define HEARTRATE2_REG_REV_ID 0xFE
134 #define HEARTRATE2_REG_PART_ID 0xFF
135 
141 #define HEARTRATE2_SYS_CTRL_SW_RESET 0x01
142 #define HEARTRATE2_SYS_CTRL_SHUT_DOWN 0x02
143 #define HEARTRATE2_SYS_CTRL_POWER_ON 0x00
144 #define HEARTRATE2_SYS_CTRL_LOW_PWR_MODE 0x04
145 #define HEARTRATE2_SYS_CTRL_SINGLE_PPG 0x08
146 #define HEARTRATE2_SYS_CTRL_DUAL_PPG 0x00
147 
153 #define HEARTRATE2_PPG_CFG_1_ALC_ENABLE 0x00
154 #define HEARTRATE2_PPG_CFG_1_ALC_DISABLE 0x80
155 #define HEARTRATE2_PPG_CFG_1_ADD_OFFSET 0x40
156 #define HEARTRATE2_PPG_CFG_1_NO_OFFSET 0x00
157 #define HEARTRATE2_PPG_CFG_1_ADC_RANGE_4096 0x00
158 #define HEARTRATE2_PPG_CFG_1_ADC_RANGE_8192 0x04
159 #define HEARTRATE2_PPG_CFG_1_ADC_RANGE_16384 0x08
160 #define HEARTRATE2_PPG_CFG_1_ADC_RANGE_32768 0x0C
161 #define HEARTRATE2_PPG_CFG_1_PPG_TINT_21p3 0x00
162 #define HEARTRATE2_PPG_CFG_1_PPG_TINT_35p9 0x01
163 #define HEARTRATE2_PPG_CFG_1_PPG_TINT_65p2 0x02
164 #define HEARTRATE2_PPG_CFG_1_PPG_TINT_123p8 0x03
165 
171 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_24p995_N1 0x00
172 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_50p027_N1 0x08
173 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_84p021_N1 0x10
174 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_99p902_N1 0x18
175 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_199p805_N1 0x20
176 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_399p610_N1 0x28
177 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_24p995_N2 0x30
178 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_50p027_N2 0x38
179 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_84p021_N2 0x40
180 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_99p902_N2 0x48
181 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_8p000_N1 0x50
182 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_16p000_N1 0x58
183 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_32p000_N1 0x60
184 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_64p000_N1 0x68
185 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_128p000_N1 0x70
186 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_256p000_N1 0x78
187 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_512p000_N1 0x80
188 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_1024p000_N1 0x88
189 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_2048p000_N1 0x90
190 #define HEARTRATE2_PPG_CFG_2_CLK_FREQ_4096p000_N1 0x98
191 #define HEARTRATE2_PPG_CFG_2_SMP_AVG_1 0x00
192 #define HEARTRATE2_PPG_CFG_2_SMP_AVG_2 0x01
193 #define HEARTRATE2_PPG_CFG_2_SMP_AVG_4 0x02
194 #define HEARTRATE2_PPG_CFG_2_SMP_AVG_8 0x03
195 #define HEARTRATE2_PPG_CFG_2_SMP_AVG_16 0x04
196 #define HEARTRATE2_PPG_CFG_2_SMP_AVG_32 0x05
197 #define HEARTRATE2_PPG_CFG_2_SMP_AVG_64 0x06
198 #define HEARTRATE2_PPG_CFG_2_SMP_AVG_128 0x07
199 
205 #define HEARTRATE2_PPG_CFG_3_LED_SETLNG_4 0x00
206 #define HEARTRATE2_PPG_CFG_3_LED_SETLNG_6 0x40
207 #define HEARTRATE2_PPG_CFG_3_LED_SETLNG_8 0x80
208 #define HEARTRATE2_PPG_CFG_3_LED_SETLNG_12 0xC0
209 #define HEARTRATE2_PPG_CFG_3_FILTER_CDM 0x00
210 #define HEARTRATE2_PPG_CFG_3_FILTER_FDM 0x20
211 #define HEARTRATE2_PPG_CFG_3_BURST_RATE_8HZ 0x00
212 #define HEARTRATE2_PPG_CFG_3_BURST_RATE_32HZ 0x02
213 #define HEARTRATE2_PPG_CFG_3_BURST_RATE_84HZ 0x04
214 #define HEARTRATE2_PPG_CFG_3_BURST_RATE_256HZ 0x06
215 #define HEARTRATE2_PPG_CFG_3_BURST_ENABLE 0x01
216 #define HEARTRATE2_PPG_CFG_3_BURST_DISABLE 0x00
217 
223 #define HEARTRATE2_PHOTO_DIODE_BIAS1_0_65_PF 0x01
224 #define HEARTRATE2_PHOTO_DIODE_BIAS1_65_130_PF 0x05
225 #define HEARTRATE2_PHOTO_DIODE_BIAS1_130_260_PF 0x06
226 #define HEARTRATE2_PHOTO_DIODE_BIAS1_260_520_PF 0x07
227 #define HEARTRATE2_PHOTO_DIODE_BIAS2_0_65_PF 0x10
228 #define HEARTRATE2_PHOTO_DIODE_BIAS2_65_130_PF 0x50
229 #define HEARTRATE2_PHOTO_DIODE_BIAS2_130_260_PF 0x60
230 #define HEARTRATE2_PHOTO_DIODE_BIAS2_260_520_PF 0x70
231 
237 #define HEARTRATE2_LED_RANGE1_LED1_CURRENT_31_MA 0x00
238 #define HEARTRATE2_LED_RANGE1_LED1_CURRENT_62_MA 0x01
239 #define HEARTRATE2_LED_RANGE1_LED1_CURRENT_93_MA 0x02
240 #define HEARTRATE2_LED_RANGE1_LED1_CURRENT_124_MA 0x03
241 #define HEARTRATE2_LED_RANGE1_LED2_CURRENT_31_MA 0x00
242 #define HEARTRATE2_LED_RANGE1_LED2_CURRENT_62_MA 0x04
243 #define HEARTRATE2_LED_RANGE1_LED2_CURRENT_93_MA 0x08
244 #define HEARTRATE2_LED_RANGE1_LED2_CURRENT_124_MA 0x0C
245 #define HEARTRATE2_LED_RANGE1_LED3_CURRENT_31_MA 0x00
246 #define HEARTRATE2_LED_RANGE1_LED3_CURRENT_62_MA 0x10
247 #define HEARTRATE2_LED_RANGE1_LED3_CURRENT_93_MA 0x20
248 #define HEARTRATE2_LED_RANGE1_LED3_CURRENT_124_MA 0x30
249 
255 #define HEARTRATE2_FIFO_CFG_2_FLUSH_FIFO 0x10
256 #define HEARTRATE2_FIFO_CFG_2_FIFO_READ_DATA_CLR 0x08
257 #define HEARTRATE2_FIFO_CFG_2_FIFO_STAT_DATA_CLR 0x00
258 #define HEARTRATE2_FIFO_CFG_2_FULL_TYPE_RPT 0x00
259 #define HEARTRATE2_FIFO_CFG_2_FULL_TYPE_ONCE 0x04
260 #define HEARTRATE2_FIFO_CFG_2_FIFO_ROLL_OVER 0x02
261 #define HEARTRATE2_FIFO_CFG_2_FIFO_STOP 0x00
262 
268 #define HEARTRATE2_INT_1_FULL 0x80
269 #define HEARTRATE2_INT_1_NOT_FULL 0x00
270 #define HEARTRATE2_INT_1_DATA_RDY 0x40
271 #define HEARTRATE2_INT_1_DATA_NOT_RDY 0x00
272 #define HEARTRATE2_INT_1_ALC_OVERFLOW 0x20
273 #define HEARTRATE2_INT_1_ALC_NORMAL 0x00
274 #define HEARTRATE2_INT_1_PROXIMITY_INT 0x10
275 #define HEARTRATE2_INT_1_PROXIMITY_NORMAL 0x00
276 #define HEARTRATE2_INT_1_LED_COMPLIANT 0x08
277 #define HEARTRATE2_INT_1_LED_NOT_COMPLIANT 0x00
278 #define HEARTRATE2_INT_1_DIE_TEMP_RDY 0x04
279 #define HEARTRATE2_INT_1_DIE_TEMP_NOT_RDY 0x00
280 #define HEARTRATE2_INT_1_PWR_RDY 0x01
281 #define HEARTRATE2_INT_1_PWR_NOT_RDY 0x00
282 
288 #define HEARTRATE2_INT_1_FULL 0x80
289 #define HEARTRATE2_INT_1_NOT_FULL 0x00
290 #define HEARTRATE2_INT_1_DATA_RDY 0x40
291 #define HEARTRATE2_INT_1_DATA_NOT_RDY 0x00
292 #define HEARTRATE2_INT_1_ALC_OVERFLOW 0x20
293 #define HEARTRATE2_INT_1_ALC_NORMAL 0x00
294 #define HEARTRATE2_INT_1_PROXIMITY_INT 0x10
295 #define HEARTRATE2_INT_1_PROXIMITY_NORMAL 0x00
296 #define HEARTRATE2_INT_1_LED_COMPLIANT 0x08
297 #define HEARTRATE2_INT_1_LED_NOT_COMPLIANT 0x00
298 #define HEARTRATE2_INT_1_DIE_TEMP_RDY 0x04
299 #define HEARTRATE2_INT_1_DIE_TEMP_NOT_RDY 0x00
300 #define HEARTRATE2_INT_1_PWR_RDY 0x01
301 #define HEARTRATE2_INT_1_PWR_NOT_RDY 0x00
302 #define HEARTRATE2_INT_2_SHA_AUTHENTICATION_DONE 0x01
303 #define HEARTRATE2_INT_2_SHA_AUTHENTICATION_NOT_DONE 0x00
304 
310 #define HEARTRATE2_FIFO_TAG_PPG1_LEDC1 0x01
311 #define HEARTRATE2_FIFO_TAG_PPG1_LEDC2 0x02
312 #define HEARTRATE2_FIFO_TAG_PPG1_LEDC3 0x03
313 #define HEARTRATE2_FIFO_TAG_PPG1_LEDC4 0x04
314 #define HEARTRATE2_FIFO_TAG_PPG1_LEDC5 0x05
315 #define HEARTRATE2_FIFO_TAG_PPG1_LEDC6 0x06
316 #define HEARTRATE2_FIFO_TAG_PPF1_LEDC1 0x0D
317 #define HEARTRATE2_FIFO_TAG_PPF1_LEDC2 0x0E
318 #define HEARTRATE2_FIFO_TAG_PPF1_LEDC3 0x0F
319 #define HEARTRATE2_FIFO_TAG_PROX1 0x19
320 #define HEARTRATE2_FIFO_TAG_SUB_DAC_UPDATE 0x1D
321 #define HEARTRATE2_FIFO_TAG_INVALID_DATA 0x1E
322 #define HEARTRATE2_FIFO_TAG_TIME_STAMP 0x1F
323 
329 #define HEARTRATE2_LEDSQ_GREEN 0x1
330 #define HEARTRATE2_LEDSQ_IR 0x2
331 #define HEARTRATE2_LEDSQ_RED 0x3
332 #define HEARTRATE2_LEDSQ_PILOT_LED1 0x8
333 #define HEARTRATE2_LEDSQ_DIRECT_AMBIENT 0x9
334 #define HEARTRATE2_LEDSQ_OFF 0x0
335 
341 #define HEARTRATE2_DEV_ID 0x36
342 #define HEARTRATE2_ERROR 0xEE
343 #define HEARTRATE2_OK 0xFF
344 
350 #define HEARTRATE2_INT_ENABLE 0x01
351 #define HEARTRATE2_INT_DISABLE 0x00
352 
358 #define HEARTRATE2_PPG_CFG_ALC_EN 0x01
359 #define HEARTRATE2_PPG_CFG_ALC_DS 0x00
360 
366 #define HEARTRATE2_PPG_CFG_OFFSET_ADD 0x01
367 #define HEARTRATE2_PPG_CFG_OFFSET_NO 0x00
368 
374 #define HEARTRATE2_PPG_CFG_TINT_14p8_US 0x00
375 #define HEARTRATE2_PPG_CFG_TINT_29p4_US 0x01
376 #define HEARTRATE2_PPG_CFG_TINT_58p7_US 0x02
377 #define HEARTRATE2_PPG_CFG_TINT_117p3_US 0x03
378 
384 #define HEARTRATE2_PPG_CFG_LED_RANGE_4k 0x00
385 #define HEARTRATE2_PPG_CFG_LED_RANGE_8k 0x01
386 #define HEARTRATE2_PPG_CFG_LED_RANGE_16k 0x02
387 #define HEARTRATE2_PPG_CFG_LED_RANGE_32k 0x03
388 
394 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_24sps 0x00
395 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_50sps 0x01
396 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_84sps 0x02
397 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_99sps 0x03
398 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_199sps 0x04
399 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_399sps 0x05
400 #define HEARTRATE2_PPG_CFG_SMP_RATE_P2_24sps 0x06
401 #define HEARTRATE2_PPG_CFG_SMP_RATE_P2_50sps 0x07
402 #define HEARTRATE2_PPG_CFG_SMP_RATE_P2_84sps 0x08
403 #define HEARTRATE2_PPG_CFG_SMP_RATE_P2_99sps 0x09
404 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_8sps 0x0A
405 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_16sps 0x0B
406 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_32sps 0x0C
407 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_64sps 0x0D
408 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_128sps 0x0E
409 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_256sps 0x0F
410 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_512sps 0x10
411 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_1024sps 0x11
412 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_2048sps 0x12
413 #define HEARTRATE2_PPG_CFG_SMP_RATE_P1_4096sps 0x13
414 
420 #define HEARTRATE2_PPG_CFG_SMP_AVG_1 0x00
421 #define HEARTRATE2_PPG_CFG_SMP_AVG_2 0x01
422 #define HEARTRATE2_PPG_CFG_SMP_AVG_4 0x02
423 #define HEARTRATE2_PPG_CFG_SMP_AVG_8 0x03
424 #define HEARTRATE2_PPG_CFG_SMP_AVG_16 0x04
425 #define HEARTRATE2_PPG_CFG_SMP_AVG_32 0x05
426 #define HEARTRATE2_PPG_CFG_SMP_AVG_64 0x06
427 #define HEARTRATE2_PPG_CFG_SMP_AVG_128 0x07
428 
434 #define HEARTRATE2_LED_RANGE_CURRENT_31_MA 0x00
435 #define HEARTRATE2_LED_RANGE_CURRENT_62_MA 0x01
436 #define HEARTRATE2_LED_RANGE_CURRENT_93_MA 0x02
437 #define HEARTRATE2_LED_RANGE_CURRENT_124_MA 0x03
438 
444 #define HEARTRATE2_CONFIG_GREEN 0xAA
445 #define HEARTRATE2_CONFIG_IR 0xBB
446 #define HEARTRATE2_CONFIG_RED 0xCC
447 
453 #define HEARTRATE2_PIN_HIGH 1
454 #define HEARTRATE2_PIN_LOW 0
455 
461 #define HEARTRATE2_TEMPERATURE_RESOLUTION 0.0625f
462 #define HEARTRATE2_TEMPERATURE_MASK 0x0F
463 
469 #define HEARTRATE2_FIFO_DATA_MASK 0x07FFFF
470 #define HEARTRATE2_FIFO_RES 19
471 #define HEARTRATE2_FIFO_TAG_MASK 0x1F
472 
478 #define HEARTRATE2_LEDSQ_SHIFT 4
479 
485 #define HEARTRATE2_INT_SHIFT_FULL 7
486 #define HEARTRATE2_INT_SHIFT_DATA_RDY 6
487 #define HEARTRATE2_INT_SHIFT_ALC_OVF 5
488 #define HEARTRATE2_INT_SHIFT_PROXY 4
489 #define HEARTRATE2_INT_SHIFT_LED_COMPLIANT 3
490 #define HEARTRATE2_INT_SHIFT_DIE_TEMEP 2
491 #define HEARTRATE2_INT_SHIFT_PWR_RDY 0
492 #define HEARTRATE2_INT_SHIFT_SHA 0
493 #define HEARTRATE2_INT_MASK 0x01
494 
500 #define HEARTRATE2_PPG_CFG_ALC 7
501 #define HEARTRATE2_PPG_CFG_OFFSET 6
502 #define HEARTRATE2_PPG_CFG_ADC_RANGE 2
503 #define HEARTRATE2_PPG_CFG_TINT 0
504 #define HEARTRATE2_PPG_CFG_SMP_RATE 3
505 #define HEARTRATE2_PPG_CFG_SMP_AVG 0
506 
512 #define HEARTRATE2_LED_RANGE_SHIFT_GREEN 0
513 #define HEARTRATE2_LED_RANGE_SHIFT_IR 2
514 #define HEARTRATE2_LED_RANGE_SHIFT_RED 4
515  // End group macro
518 // --------------------------------------------------------------- PUBLIC TYPES
527 typedef struct
528 {
529  uint32_t data_val;
530  uint8_t tag;
532 
536 typedef struct
537 {
538  uint8_t ledsq1;
539  uint8_t ledsq2;
540  uint8_t ledsq3;
541  uint8_t ledsq4;
542  uint8_t ledsq5;
543  uint8_t ledsq6;
545 
549 typedef struct
550 {
551  uint8_t green;
552  uint8_t ir;
553  uint8_t red;
555 
559 typedef struct
560 {
561  uint8_t green;
562  uint8_t ir;
563  uint8_t red;
565 
569 typedef struct
570 {
571  uint8_t alc;
572  uint8_t offset;
573  uint8_t ppg_tint;
574  uint8_t led_range;
575  uint8_t smp_rate;
576  uint8_t smp_freq;
578 
582 typedef struct
583 {
584  uint8_t full_fifo;
585  uint8_t data_rdy;
586  uint8_t alc_ovf;
587  uint8_t proxy;
588  uint8_t led_compliant;
589  uint8_t die_temp;
590  uint8_t pwr_rdy;
591  uint8_t sha;
593 
597 typedef struct
598 {
599  // Output pins
600 
601  digital_out_t cs;
602 
603  // Input pins
604 
605  digital_in_t an;
606  digital_in_t int_pin;
607 
608  // Modules
609 
610  i2c_master_t i2c;
611 
612  // ctx variable
613 
614  uint8_t slave_address;
615 
616 } heartrate2_t;
617 
621 typedef struct
622 {
623  // Communication gpio pins
624 
625  pin_name_t scl;
626  pin_name_t sda;
627 
628  // Additional gpio pins
629 
630  pin_name_t an;
631  pin_name_t cs;
632  pin_name_t int_pin;
633 
634  // static variable
635 
636  uint32_t i2c_speed;
637  uint8_t i2c_address;
638 
640  // End types group
642 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
643 
649 #ifdef __cplusplus
650 extern "C"{
651 #endif
652 
662 
672 
684 void heartrate2_default_cfg ( heartrate2_t *ctx, uint8_t cfg_led );
685 
695 void heartrate2_generic_write ( heartrate2_t *ctx, uint8_t reg_adr, uint8_t write_data );
696 
705 uint8_t heartrate2_generic_read ( heartrate2_t *ctx, uint8_t reg_adr );
706 
717 void heartrate2_read_buf ( heartrate2_t *ctx, uint8_t reg_adr, uint8_t *read_buf, uint8_t buf_size );
718 
728 
740 
749 
761 
771 
783 
795 
807 
817 
826 
835 
843 void heartrate2_set_en ( heartrate2_t *ctx, uint8_t state );
844 
845 #ifdef __cplusplus
846 }
847 #endif
848 #endif // _HEARTRATE2_H_
849  // End public_function group
852 
853 // ------------------------------------------------------------------------- END
heartrate2_int_control
uint8_t heartrate2_int_control(heartrate2_t *ctx, heartrate2_int_t *int_ctrl)
Function for configurating interrupt registers.
heartrate2_ledsq_cfg_t::ledsq5
uint8_t ledsq5
Definition: heartrate2.h:542
heartrate2_fifo_data_t::data_val
uint32_t data_val
Definition: heartrate2.h:529
heartrate2_ppg_cfg_t::smp_rate
uint8_t smp_rate
Definition: heartrate2.h:575
heartrate2_ppg_cfg_t::offset
uint8_t offset
Definition: heartrate2.h:572
heartrate2_ppg_config
uint8_t heartrate2_ppg_config(heartrate2_t *ctx, heartrate2_ppg_cfg_t *ppg_cfg)
Function for configurating ppg registers.
heartrate2_ledsq_cfg_t::ledsq2
uint8_t ledsq2
Definition: heartrate2.h:539
heartrate2_ledsq_cfg_t::ledsq1
uint8_t ledsq1
Definition: heartrate2.h:538
heartrate2_get_gp
uint8_t heartrate2_get_gp(heartrate2_t *ctx)
Function for reading gp pin status.
heartrate2_ledpa_config
void heartrate2_ledpa_config(heartrate2_t *ctx, heartrate2_ledpa_t *ledpa)
Function for configurating led pa registers.
heartrate2_ppg_cfg_t::ppg_tint
uint8_t ppg_tint
Definition: heartrate2.h:573
heartrate2_t::int_pin
digital_in_t int_pin
Definition: heartrate2.h:606
heartrate2_int_t::led_compliant
uint8_t led_compliant
Definition: heartrate2.h:588
heartrate2_cfg_t::cs
pin_name_t cs
Definition: heartrate2.h:631
heartrate2_generic_write
void heartrate2_generic_write(heartrate2_t *ctx, uint8_t reg_adr, uint8_t write_data)
Generic write function.
heartrate2_int_t::pwr_rdy
uint8_t pwr_rdy
Definition: heartrate2.h:590
heartrate2_led_range_curr_t::ir
uint8_t ir
Definition: heartrate2.h:562
heartrate2_ledpa_t::red
uint8_t red
Definition: heartrate2.h:553
heartrate2_cfg_t::sda
pin_name_t sda
Definition: heartrate2.h:626
heartrate2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: heartrate2.h:636
heartrate2_default_cfg
void heartrate2_default_cfg(heartrate2_t *ctx, uint8_t cfg_led)
Click Default Configuration function.
heartrate2_int_t::full_fifo
uint8_t full_fifo
Definition: heartrate2.h:584
heartrate2_fifo_data_t::tag
uint8_t tag
Definition: heartrate2.h:530
heartrate2_t
Click ctx object definition.
Definition: heartrate2.h:598
heartrate2_int_t::sha
uint8_t sha
Definition: heartrate2.h:591
heartrate2_ppg_cfg_t
Structure configurating ppg.
Definition: heartrate2.h:570
heartrate2_ppg_cfg_t::smp_freq
uint8_t smp_freq
Definition: heartrate2.h:576
heartrate2_t::slave_address
uint8_t slave_address
Definition: heartrate2.h:614
heartrate2_int_t::proxy
uint8_t proxy
Definition: heartrate2.h:587
heartrate2_ledpa_t::green
uint8_t green
Definition: heartrate2.h:551
heartrate2_int_t
Structure for interrupt status.
Definition: heartrate2.h:583
heartrate2_ledsq_cfg_t::ledsq4
uint8_t ledsq4
Definition: heartrate2.h:541
heartrate2_cfg_t::an
pin_name_t an
Definition: heartrate2.h:630
heartrate2_led_sequence_config
uint8_t heartrate2_led_sequence_config(heartrate2_t *ctx, heartrate2_ledsq_cfg_t *ledsq)
Function for configurating led sequence registers.
heartrate2_set_en
void heartrate2_set_en(heartrate2_t *ctx, uint8_t state)
Function for setting en pin status.
heartrate2_int_t::alc_ovf
uint8_t alc_ovf
Definition: heartrate2.h:586
heartrate2_cfg_t::int_pin
pin_name_t int_pin
Definition: heartrate2.h:632
heartrate2_cfg_t
Click configuration structure definition.
Definition: heartrate2.h:622
heartrate2_t::i2c
i2c_master_t i2c
Definition: heartrate2.h:610
heartrate2_cfg_t::scl
pin_name_t scl
Definition: heartrate2.h:625
heartrate2_ledsq_cfg_t::ledsq6
uint8_t ledsq6
Definition: heartrate2.h:543
heartrate2_soft_reset
void heartrate2_soft_reset(heartrate2_t *ctx)
Function for restarting device.
heartrate2_int_t::die_temp
uint8_t die_temp
Definition: heartrate2.h:589
heartrate2_fifo_data_t
Structure for reading fifo data.
Definition: heartrate2.h:528
heartrate2_read_temp
float heartrate2_read_temp(heartrate2_t *ctx)
Function for reading temperature of device.
heartrate2_led_range_curr_t
Structure setting led current range.
Definition: heartrate2.h:560
heartrate2_get_int
uint8_t heartrate2_get_int(heartrate2_t *ctx)
Function for reading int pin status.
heartrate2_ledpa_t::ir
uint8_t ir
Definition: heartrate2.h:552
heartrate2_led_range_curr_t::red
uint8_t red
Definition: heartrate2.h:563
heartrate2_ppg_cfg_t::led_range
uint8_t led_range
Definition: heartrate2.h:574
heartrate2_ledsq_cfg_t::ledsq3
uint8_t ledsq3
Definition: heartrate2.h:540
heartrate2_led_range_curr_t::green
uint8_t green
Definition: heartrate2.h:561
heartrate2_ppg_cfg_t::alc
uint8_t alc
Definition: heartrate2.h:571
heartrate2_t::an
digital_in_t an
Definition: heartrate2.h:605
heartrate2_ledpa_t
Structure led brightness.
Definition: heartrate2.h:550
heartrate2_cfg_t::i2c_address
uint8_t i2c_address
Definition: heartrate2.h:637
heartrate2_read_fifo
void heartrate2_read_fifo(heartrate2_t *ctx, heartrate2_fifo_data_t *fifo)
Generic function for reading data from fifo registar.
heartrate2_ledsq_cfg_t
Structure configurating led sequence.
Definition: heartrate2.h:537
heartrate2_generic_read
uint8_t heartrate2_generic_read(heartrate2_t *ctx, uint8_t reg_adr)
Generic read function.
HEARTRATE2_RETVAL
#define HEARTRATE2_RETVAL
Definition: heartrate2.h:74
heartrate2_int_t::data_rdy
uint8_t data_rdy
Definition: heartrate2.h:585
heartrate2_t::cs
digital_out_t cs
Definition: heartrate2.h:601
heartrate2_read_buf
void heartrate2_read_buf(heartrate2_t *ctx, uint8_t reg_adr, uint8_t *read_buf, uint8_t buf_size)
Function for reading data buffer from registar.
heartrate2_led_range_curr_config
uint8_t heartrate2_led_range_curr_config(heartrate2_t *ctx, heartrate2_led_range_curr_t *led_range)
Function for configurating led current range registers.
heartrate2_cfg_setup
void heartrate2_cfg_setup(heartrate2_cfg_t *cfg)
Config Object Initialization function.
heartrate2_int_status
void heartrate2_int_status(heartrate2_t *ctx, heartrate2_int_t *int_status)
Function for reading interrupt status.
heartrate2_init
HEARTRATE2_RETVAL heartrate2_init(heartrate2_t *ctx, heartrate2_cfg_t *cfg)
Initialization function.