heartrate4  2.0.0.0
heartrate4.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 HEARTRATE4_H
36 #define HEARTRATE4_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 HEARTRATE4_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl1 = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda1 = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.int1 = MIKROBUS( mikrobus, MIKROBUS_INT )
56 
62 #define HEARTRATE4_RETVAL uint8_t
63 
64 #define HEARTRATE4_OK 0x00
65 #define HEARTRATE4_INIT_ERROR 0xFF
66 
72 #define HEARTRATE4_I2C_ADDRESS 0x57
73 
84 #define HEARTRATE4_INT_STAT1 0x00
85 #define HEARTRATE4_INT_STAT2 0x01
86 #define HEARTRATE4_INT_ENABLE1 0x02
87 #define HEARTRATE4_INT_ENABLE2 0x03
88 
94 #define HEARTRATE4_FIFO_WRITE_PTR 0x04
95 #define HEARTRATE4_FIFO_OVERFLOW 0x05
96 #define HEARTRATE4_FIFO_READ_PTR 0x06
97 #define HEARTRATE4_FIFO_DATA 0x07
98 #define HEARTRATE4_BUFFER_LENGTH 32
99 
105 #define HEARTRATE4_FIFO_CONFIG 0x08
106 #define HEARTRATE4_MODE_CONFIG 0x09
107 #define HEARTRATE4_SPO2_CONFIG 0x0A //SpO2 Configuration
108 #define HEARTRATE4_LED1_PULSE_AMP 0x0C
109 #define HEARTRATE4_LED2_PULSE_AMP 0x0D
110 #define HEARTRATE4_LED3_PULSE_AMP 0x0E
111 #define HEARTRATE4_LED_PROX_AMP 0x10
112 #define HEARTRATE4_MULTI_LED_CONFIG1 0x11
113 #define HEARTRATE4_MULTI_LED_CONFIG2 0x12
114 #define HEARTRATE4_MIN_POWER_LEVEL 0x01
115 #define HEARTRATE4_AVG_POWER_LEVEL 0x1F
116 #define HEARTRATE4_MAX_POWER_LEVEL 0xFF
117 
123 #define HEARTRATE4_DIE_TEMP_INT 0x1F
124 #define HEARTRATE4_DIE_TEMP_FRAC 0x20
125 #define HEARTRATE4_DIE_TEMP_CONFIG 0x21
126 
132 #define HEARTRATE4_PROX_INT_THRESH 0x30
133 
139 #define HEARTRATE4_REVISION_ID 0xFE
140 #define HEARTRATE4_PART_ID 0xFF
141  //End registers addresses group of macro
143 
153 #define HEARTRATE4_INT_A_FULL_MASK (uint8_t)~0b10000000
154 #define HEARTRATE4_INT_A_FULL_ENABLE 0x80
155 #define HEARTRATE4_INT_A_FULL_DISABLE 0x00
156 #define HEARTRATE4_INT_DATA_RDY_MASK (uint8_t)~0b01000000
157 #define HEARTRATE4_INT_DATA_RDY_ENABLE 0x40
158 #define HEARTRATE4_INT_DATA_RDY_DISABLE 0x00
159 #define HEARTRATE4_INT_ALC_OVF_MASK (uint8_t)~0b00100000
160 #define HEARTRATE4_INT_ALC_OVF_ENABLE 0x20
161 #define HEARTRATE4_INT_ALC_OVF_DISABLE 0x00
162 #define HEARTRATE4_INT_PROX_INT_MASK (uint8_t)~0b00010000
163 #define HEARTRATE4_INT_PROX_INT_ENABLE 0x10
164 #define HEARTRATE4_INT_PROX_INT_DISABLE 0x00
165 #define HEARTRATE4_INT_DIE_TEMP_RDY_MASK (uint8_t)~0b00000010
166 #define HEARTRATE4_INT_DIE_TEMP_RDY_ENABLE 0x02
167 #define HEARTRATE4_INT_DIE_TEMP_RDY_DISABLE 0x00
168 
174 #define HEARTRATE4_SAMPLEAVG_MASK (uint8_t)~0b11100000
175 #define HEARTRATE4_SAMPLEAVG_1 0x00
176 #define HEARTRATE4_SAMPLEAVG_2 0x20
177 #define HEARTRATE4_SAMPLEAVG_4 0x40
178 #define HEARTRATE4_SAMPLEAVG_8 0x60
179 #define HEARTRATE4_SAMPLEAVG_16 0x80
180 #define HEARTRATE4_SAMPLEAVG_32 0xA0
181 #define HEARTRATE4_ROLLOVER_MASK 0xEF
182 #define HEARTRATE4_ROLLOVER_ENABLE 0x10
183 #define HEARTRATE4_ROLLOVER_DISABLE 0x00
184 #define HEARTRATE4_A_FULL_MASK 0xF0
185 
191 #define HEARTRATE4_SHUTDOWN_MASK 0x7F
192 #define HEARTRATE4_SHUTDOWN 0x80
193 #define HEARTRATE4_WAKEUP 0x00
194 #define HEARTRATE4_RESET_MASK 0xBF
195 #define HEARTRATE4_RESET 0x40
196 #define HEARTRATE4_MODE_MASK 0xF8
197 #define HEARTRATE4_MODE_REDONLY 0x02 // Heart Rate mode
198 #define HEARTRATE4_MODE_REDIRONLY 0x03 // SpO2 mode
199 #define HEARTRATE4_MODE_MULTILED 0x07 // Multi-LED mode
200 
206 #define HEARTRATE4_ADCRANGE_MASK 0x9F
207 #define HEARTRATE4_ADCRANGE_2048 0x00
208 #define HEARTRATE4_ADCRANGE_4096 0x20
209 #define HEARTRATE4_ADCRANGE_8192 0x40
210 #define HEARTRATE4_ADCRANGE_16384 0x60
211 #define HEARTRATE4_SAMPLERATE_MASK 0xE3
212 #define HEARTRATE4_SAMPLERATE_50 0x00
213 #define HEARTRATE4_SAMPLERATE_100 0x04
214 #define HEARTRATE4_SAMPLERATE_200 0x08
215 #define HEARTRATE4_SAMPLERATE_400 0x0C
216 #define HEARTRATE4_SAMPLERATE_800 0x10
217 #define HEARTRATE4_SAMPLERATE_1000 0x14
218 #define HEARTRATE4_SAMPLERATE_1600 0x18
219 #define HEARTRATE4_SAMPLERATE_3200 0x1C
220 #define HEARTRATE4_PULSEWIDTH_MASK 0xFC
221 #define HEARTRATE4_PULSEWIDTH_69 0x00
222 #define HEARTRATE4_PULSEWIDTH_118 0x01
223 #define HEARTRATE4_PULSEWIDTH_215 0x02
224 #define HEARTRATE4_PULSEWIDTH_411 0x03
225 
231 #define HEARTRATE4_SLOT1_MASK 0xF8
232 #define HEARTRATE4_SLOT2_MASK 0x8F
233 #define HEARTRATE4_SLOT3_MASK 0xF8
234 #define HEARTRATE4_SLOT4_MASK 0x8F
235 #define HEARTRATE4_SLOT_NONE 0x00
236 #define HEARTRATE4_SLOT_RED_LED 0x01
237 #define HEARTRATE4_SLOT_IR_LED 0x02
238 #define HEARTRATE4_SLOT_GREEN_LED 0x03
239 #define HEARTRATE4_SLOT_NONE_PILOT 0x04
240 #define HEARTRATE4_SLOT_RED_PILOT 0x05
241 #define HEARTRATE4_SLOT_IR_PILOT 0x06
242 #define HEARTRATE4_SLOT_GREEN_PILOT 0x07
243  // End command group macro // End group macro
246 // --------------------------------------------------------------- PUBLIC TYPES
255 typedef struct
256 {
257  // Input pins
258 
259  digital_in_t int1;
260 
261  // Modules
262 
263  i2c_master_t i2c;
264 
265  // ctx variable
266 
267  uint8_t slave_address;
268 
269 } heartrate4_t;
270 
274 typedef struct
275 {
276  // Communication gpio pins
277 
278  pin_name_t scl1;
279  pin_name_t sda1;
280 
281  // Additional gpio pins
282 
283  pin_name_t int1;
284 
285  // static variable
286 
287  uint32_t i2c_speed;
288  uint8_t i2c_address;
289 
291 
295 typedef struct
296 {
297  // Structure fields
298 
299  uint8_t avg_samp;
300  uint8_t mode;
301  uint8_t adc_range;
302  uint8_t samp_rate;
303  uint8_t pulse_width;
304  uint8_t led_pow_lvl;
305 
307  // End types group
309 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
310 
316 #ifdef __cplusplus
317 extern "C"{
318 #endif
319 
329 
339 
348 
358 void heartrate4_write_data ( heartrate4_t *ctx, uint8_t wr_addr, uint8_t wr_data );
359 
370 uint8_t heartrate4_read_data ( heartrate4_t *ctx, uint8_t rd_addr );
371 
382 void heartrate4_multi_read ( heartrate4_t *ctx, uint8_t rd_addr, uint8_t *buffer, uint8_t cnt );
383 
394 void heartrate4_set_new_value ( heartrate4_t *ctx, uint8_t reg, uint8_t mask, uint8_t value );
395 
406 uint8_t heartrate4_get_intrrupt ( heartrate4_t *ctx, uint8_t flag );
407 
432 void heartrate4_enable_disable_interrupts ( heartrate4_t *ctx, uint8_t interrupt_flag, uint8_t enable_flag );
433 
455 void heartrate4_setting_function ( heartrate4_t *ctx, uint8_t flag, uint8_t mode );
456 
477 void heartrate4_setting_prox_and_amp ( heartrate4_t *ctx, uint8_t flag, uint8_t write_data );
478 
488 void heartrate4_enable_slot ( heartrate4_t *ctx, uint8_t slot_num, uint8_t dev );
489 
498 
507 
527 void heartrate4_fifo_setting ( heartrate4_t *ctx, uint8_t flag, uint8_t samp_num );
528 
539 
550 
560 
570 
578 
587 
598 
619 uint8_t heartrate4_check_int_pow_and_temp ( heartrate4_t *ctx, uint8_t flag );
620 
631 uint16_t heartrate4_read_fifo_all_samples ( heartrate4_t *ctx, uint8_t *buff );
632 
642 
661 
662 #ifdef __cplusplus
663 }
664 #endif
665 #endif // _HEARTRATE4_H_
666  // End public_function group
669 
670 // ------------------------------------------------------------------------- END
heartrate4_t::i2c
i2c_master_t i2c
Definition: heartrate4.h:263
heartrate4_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: heartrate4.h:287
heartrate4_enable_disable_interrupts
void heartrate4_enable_disable_interrupts(heartrate4_t *ctx, uint8_t interrupt_flag, uint8_t enable_flag)
Enable or disable interrupt function.
heartrate4_set_registers_t
Click registers object definition.
Definition: heartrate4.h:296
heartrate4_setting_function
void heartrate4_setting_function(heartrate4_t *ctx, uint8_t flag, uint8_t mode)
Set corresponding configuration register function.
heartrate4_t
Click ctx object definition.
Definition: heartrate4.h:256
heartrate4_cfg_t::int1
pin_name_t int1
Definition: heartrate4.h:283
heartrate4_read_fifo_all_samples
uint16_t heartrate4_read_fifo_all_samples(heartrate4_t *ctx, uint8_t *buff)
Read all FIFO samples function.
heartrate4_set_registers_t::samp_rate
uint8_t samp_rate
Definition: heartrate4.h:302
heartrate4_check_int_pow_and_temp
uint8_t heartrate4_check_int_pow_and_temp(heartrate4_t *ctx, uint8_t flag)
Check interrupt, power ready or internal temperature ready flag function.
heartrate4_set_registers_t::avg_samp
uint8_t avg_samp
Definition: heartrate4.h:299
heartrate4_t::int1
digital_in_t int1
Definition: heartrate4.h:259
heartrate4_get_write_ptr
uint8_t heartrate4_get_write_ptr(heartrate4_t *ctx)
Read the FIFO Write Pointer function.
heartrate4_read_fifo_oldest_sample
uint32_t heartrate4_read_fifo_oldest_sample(heartrate4_t *ctx)
Read oldest FIFO sample function.
heartrate4_clear_fifo
void heartrate4_clear_fifo(heartrate4_t *ctx)
Clearing FIFO pointers function.
heartrate4_get_intrrupt
uint8_t heartrate4_get_intrrupt(heartrate4_t *ctx, uint8_t flag)
Get desired interrupt function.
heartrate4_read_data
uint8_t heartrate4_read_data(heartrate4_t *ctx, uint8_t rd_addr)
Generic read function.
heartrate4_read_temp_c
float heartrate4_read_temp_c(heartrate4_t *ctx)
Read temperature in Centigrade function.
heartrate4_enable_slot
void heartrate4_enable_slot(heartrate4_t *ctx, uint8_t slot_num, uint8_t dev)
Define slots in MultiLED mode function.
heartrate4_reset
void heartrate4_reset(heartrate4_t *ctx)
Reset device function.
heartrate4_set_registers_t::pulse_width
uint8_t pulse_width
Definition: heartrate4.h:303
heartrate4_get_red_val
uint32_t heartrate4_get_red_val(heartrate4_t *ctx)
Get Red value function.
heartrate4_cfg_t::scl1
pin_name_t scl1
Definition: heartrate4.h:278
heartrate4_read_temp_f
float heartrate4_read_temp_f(heartrate4_t *ctx)
Read temperature in Fahrenheit function.
heartrate4_default_cfg
void heartrate4_default_cfg(heartrate4_t *ctx)
Click Default Configuration function.
heartrate4_cfg_t::i2c_address
uint8_t i2c_address
Definition: heartrate4.h:288
heartrate4_multi_read
void heartrate4_multi_read(heartrate4_t *ctx, uint8_t rd_addr, uint8_t *buffer, uint8_t cnt)
Multi read function.
heartrate4_init
HEARTRATE4_RETVAL heartrate4_init(heartrate4_t *ctx, heartrate4_cfg_t *cfg)
Initialization function.
HEARTRATE4_RETVAL
#define HEARTRATE4_RETVAL
Definition: heartrate4.h:62
heartrate4_cfg_t
Click configuration structure definition.
Definition: heartrate4.h:275
heartrate4_cfg_setup
void heartrate4_cfg_setup(heartrate4_cfg_t *cfg)
Config Object Initialization function.
heartrate4_write_data
void heartrate4_write_data(heartrate4_t *ctx, uint8_t wr_addr, uint8_t wr_data)
Generic write function.
heartrate4_t::slave_address
uint8_t slave_address
Definition: heartrate4.h:267
heartrate4_fifo_setting
void heartrate4_fifo_setting(heartrate4_t *ctx, uint8_t flag, uint8_t samp_num)
Set FIFO configuration register function.
heartrate4_check_int
uint8_t heartrate4_check_int(heartrate4_t *ctx)
Get Interrupt state function.
heartrate4_set_new_value
void heartrate4_set_new_value(heartrate4_t *ctx, uint8_t reg, uint8_t mask, uint8_t value)
Set new value function.
heartrate4_set_registers_t::adc_range
uint8_t adc_range
Definition: heartrate4.h:301
heartrate4_set_registers
void heartrate4_set_registers(heartrate4_t *ctx, heartrate4_set_registers_t *registers)
Set registers values function.
heartrate4_disable_slots
void heartrate4_disable_slots(heartrate4_t *ctx)
Disable slots in MultiLED mode function.
heartrate4_set_registers_t::mode
uint8_t mode
Definition: heartrate4.h:300
heartrate4_setting_prox_and_amp
void heartrate4_setting_prox_and_amp(heartrate4_t *ctx, uint8_t flag, uint8_t write_data)
Set corresponding amplitude or proximity threshold function.
heartrate4_cfg_t::sda1
pin_name_t sda1
Definition: heartrate4.h:279
heartrate4_get_read_ptr
uint8_t heartrate4_get_read_ptr(heartrate4_t *ctx)
Read the FIFO Read Pointer function.
heartrate4_set_registers_t::led_pow_lvl
uint8_t led_pow_lvl
Definition: heartrate4.h:304