heartrate10  2.0.0.0
heartrate10.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef HEARTRATE10_H
29 #define HEARTRATE10_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 
59 #define HEARTRATE10_REG_INT_STATUS 0x00
60 #define HEARTRATE10_REG_INT_ENABLE 0x02
61 #define HEARTRATE10_REG_FIFO_WR_PTR 0x04
62 #define HEARTRATE10_REG_FIFO_OVF_CNT 0x05
63 #define HEARTRATE10_REG_FIFO_RD_PTR 0x06
64 #define HEARTRATE10_REG_FIFO_DATA 0x07
65 #define HEARTRATE10_REG_FIFO_CFG 0x08
66 #define HEARTRATE10_REG_MODE_CFG1 0x09
67 #define HEARTRATE10_REG_MODE_CFG2 0x0A
68 #define HEARTRATE10_REG_LED1_PA 0x0C
69 #define HEARTRATE10_REG_LED2_PA 0x0D
70 #define HEARTRATE10_REG_LED3_PA 0x0E
71 #define HEARTRATE10_REG_LED4_PA 0x0F
72 #define HEARTRATE10_REG_LED_RANGE 0x11
73 #define HEARTRATE10_REG_PILOT_PA 0x12
74 #define HEARTRATE10_REG_LED_SEQ1 0x13
75 #define HEARTRATE10_REG_LED_SEQ2 0x14
76 #define HEARTRATE10_REG_DAC1_CROSSTALK_CODE 0x26
77 #define HEARTRATE10_REG_DAC2_CROSSTALK_CODE 0x27
78 #define HEARTRATE10_REG_DAC3_CROSSTALK_CODE 0x28
79 #define HEARTRATE10_REG_DAC4_CROSSTALK_CODE 0x29
80 #define HEARTRATE10_REG_PROX_INT_THRESHOLD 0x30
81 #define HEARTRATE10_REG_LED_COMPARATOR_EN 0x31
82 #define HEARTRATE10_REG_LED_COMPARATOR_STATUS 0x32
83 #define HEARTRATE10_REG_REV_ID 0xFE
84 #define HEARTRATE10_REG_PART_ID 0xFF
85  // heartrate10_reg
87 
102 #define HEARTRATE10_PART_ID 0x2B
103 
109 #define HEARTRATE10_SET_DEV_ADDR 0x57
110  // heartrate10_set
112 
127 #define HEARTRATE10_MAP_MIKROBUS( cfg, mikrobus ) \
128  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
129  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
130  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
131  // heartrate10_map // heartrate10
134 
139 typedef struct
140 {
141  // Input pins
142  digital_in_t int_pin;
144  // Modules
145  i2c_master_t i2c;
147  // I2C slave address
148  uint8_t slave_address;
150 } heartrate10_t;
151 
156 typedef struct
157 {
158  pin_name_t scl;
159  pin_name_t sda;
161  pin_name_t int_pin;
163  uint32_t i2c_speed;
164  uint8_t i2c_address;
167 
172 typedef enum
173 {
175  HEARTRATE10_ERROR = -1
176 
178 
195 
210 
225 
238 err_t heartrate10_generic_write ( heartrate10_t *ctx, uint8_t reg, uint8_t tx_data );
239 
252 err_t heartrate10_generic_read ( heartrate10_t *ctx, uint8_t reg, uint8_t *rx_data );
253 
263 uint8_t heartrate10_get_int_pin ( heartrate10_t *ctx );
264 
272 void heartrate10_reset ( heartrate10_t *ctx );
273 
286 err_t heartrate10_fifo_read ( heartrate10_t *ctx, uint8_t *rx_buf, uint8_t rx_len );
287 
300 
318 err_t heartrate10_read_complete_fifo_data ( heartrate10_t *ctx, uint32_t *led1, uint32_t *led2, uint32_t *led3, uint32_t *led4 );
319 
320 #ifdef __cplusplus
321 }
322 #endif
323 #endif // HEARTRATE10_H
324  // heartrate10
326 
327 // ------------------------------------------------------------------------ END
heartrate10_reset
void heartrate10_reset(heartrate10_t *ctx)
Reset device.
HEARTRATE10_OK
Definition: heartrate10.h:173
heartrate10_read_complete_fifo_data
err_t heartrate10_read_complete_fifo_data(heartrate10_t *ctx, uint32_t *led1, uint32_t *led2, uint32_t *led3, uint32_t *led4)
Read all led samples.
heartrate10_t
Heart Rate 10 Click context object.
Definition: heartrate10.h:138
heartrate10_cfg_t
Heart Rate 10 Click configuration object.
Definition: heartrate10.h:155
heartrate10_default_cfg
err_t heartrate10_default_cfg(heartrate10_t *ctx)
Heart Rate 10 default configuration function.
heartrate10_generic_write
err_t heartrate10_generic_write(heartrate10_t *ctx, uint8_t reg, uint8_t tx_data)
Writing function.
heartrate10_generic_read
err_t heartrate10_generic_read(heartrate10_t *ctx, uint8_t reg, uint8_t *rx_data)
Reading function.
heartrate10_return_value_t
heartrate10_return_value_t
Heart Rate 10 Click return value data.
Definition: heartrate10.h:171
heartrate10_read_fifo_sample
uint32_t heartrate10_read_fifo_sample(heartrate10_t *ctx)
Read single sample of FIFO data.
heartrate10_get_int_pin
uint8_t heartrate10_get_int_pin(heartrate10_t *ctx)
Get interrupt pin state.
HEARTRATE10_ERROR
Definition: heartrate10.h:174
heartrate10_cfg_setup
void heartrate10_cfg_setup(heartrate10_cfg_t *cfg)
Heart Rate 10 configuration object setup function.
heartrate10_fifo_read
err_t heartrate10_fifo_read(heartrate10_t *ctx, uint8_t *rx_buf, uint8_t rx_len)
Read fifo register data.
heartrate10_init
err_t heartrate10_init(heartrate10_t *ctx, heartrate10_cfg_t *cfg)
Heart Rate 10 initialization function.