heartrate5  2.0.0.0
heartrate5.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 HEARTRATE5_H
29 #define HEARTRATE5_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 
63 #define HEARTRATE5_REG0H 0x00
64 #define HEARTRATE5_REG1H 0x01
65 #define HEARTRATE5_REG2H 0x02
66 #define HEARTRATE5_REG3H 0x03
67 #define HEARTRATE5_REG4H 0x04
68 #define HEARTRATE5_REG5H 0x05
69 #define HEARTRATE5_REG6H 0x06
70 #define HEARTRATE5_REG7H 0x07
71 #define HEARTRATE5_REG8H 0x08
72 #define HEARTRATE5_REG9H 0x09
73 #define HEARTRATE5_REGAH 0x0A
74 #define HEARTRATE5_REGBH 0x0B
75 #define HEARTRATE5_REGCH 0x0C
76 #define HEARTRATE5_REGDH 0x0D
77 #define HEARTRATE5_REGEH 0x0E
78 #define HEARTRATE5_REGFH 0x0F
79 #define HEARTRATE5_REG10H 0x10
80 #define HEARTRATE5_REG11H 0x11
81 #define HEARTRATE5_REG12H 0x12
82 #define HEARTRATE5_REG13H 0x13
83 #define HEARTRATE5_REG14H 0x14
84 #define HEARTRATE5_REG15H 0x15
85 #define HEARTRATE5_REG16H 0x16
86 #define HEARTRATE5_REG17H 0x17
87 #define HEARTRATE5_REG18H 0x18
88 #define HEARTRATE5_REG19H 0x19
89 #define HEARTRATE5_REG1AH 0x1A
90 #define HEARTRATE5_REG1BH 0x1B
91 #define HEARTRATE5_REG1CH 0x1C
92 
93 #define HEARTRATE5_REG1DH 0x1D
94 #define HEARTRATE5_REG1EH 0x1E
95 #define HEARTRATE5_REG20H 0x20
96 #define HEARTRATE5_REG21H 0x21
97 #define HEARTRATE5_REG22H 0x22
98 #define HEARTRATE5_REG23H 0x23
99 #define HEARTRATE5_REG29H 0x29
100 
101 #define HEARTRATE5_REG2AH 0x2A
102 #define HEARTRATE5_REG2BH 0x2B
103 #define HEARTRATE5_REG2CH 0x2C
104 #define HEARTRATE5_REG2DH 0x2D
105 #define HEARTRATE5_REG2EH 0x2E
106 #define HEARTRATE5_REG2FH 0x2F
107 #define HEARTRATE5_REG31H 0x31
108 
114 #define HEARTRATE5_REG32H 0x32
115 #define HEARTRATE5_REG33H 0x33
116 
117 #define HEARTRATE5_REG34H 0x34
118 #define HEARTRATE5_REG35H 0x35
119 
125 #define HEARTRATE5_REG36H 0x36
126 #define HEARTRATE5_REG37H 0x37
127 
128 #define HEARTRATE5_REG39H 0x39
129 #define HEARTRATE5_REG3AH 0x3A
130 #define HEARTRATE5_REG3DH 0x3D
131 #define HEARTRATE5_REG3FH 0x3F
132 #define HEARTRATE5_REG40H 0x40
133  // heartrate5_reg
135 
156 #define HEARTRATE5_SET_DEV_ADDR 0x58
157  // heartrate5_set
159 
174 #define HEARTRATE5_MAP_MIKROBUS( cfg, mikrobus ) \
175  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
176  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
177  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
178  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
179  // heartrate5_map // heartrate5
182 
187 typedef struct
188 {
189  // Output pins
190  digital_out_t rst;
192  // Input pins
193  digital_in_t int_pin;
195  // Modules
196  i2c_master_t i2c;
198  // I2C slave address
199  uint8_t slave_address;
201 } heartrate5_t;
202 
207 typedef struct
208 {
209  pin_name_t scl;
210  pin_name_t sda;
212  pin_name_t rst;
213  pin_name_t int_pin;
215  uint32_t i2c_speed;
216  uint8_t i2c_address;
219 
224 typedef enum
225 {
227  HEARTRATE5_ERROR = -1
228 
230 
247 
262 
277 
292 err_t heartrate5_generic_write ( heartrate5_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
293 
308 err_t heartrate5_generic_read ( heartrate5_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
309 
320 void heartrate5_write_reg( heartrate5_t *ctx, uint8_t reg_addr, uint32_t write_data );
321 
331 uint32_t heartrate5_read_reg( heartrate5_t *ctx, uint8_t reg_addr );
332 
341 
350 
359 
368 
377 
386 
395 
404 
405 #ifdef __cplusplus
406 }
407 #endif
408 #endif // HEARTRATE5_H
409  // heartrate5
411 
412 // ------------------------------------------------------------------------ END
heartrate5_get_aled2_val_led3v_al
uint32_t heartrate5_get_aled2_val_led3v_al(heartrate5_t *ctx)
Heart Rate 5 get ALED2 data function.
heartrate5_cfg_setup
void heartrate5_cfg_setup(heartrate5_cfg_t *cfg)
Heart Rate 5 configuration object setup function.
heartrate5_t
Heart Rate 5 Click context object.
Definition: heartrate5.h:188
heartrate5_get_led1_val
uint32_t heartrate5_get_led1_val(heartrate5_t *ctx)
Heart Rate 5 get LED1 data function.
heartrate5_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: heartrate5.h:215
heartrate5_read_reg
uint32_t heartrate5_read_reg(heartrate5_t *ctx, uint8_t reg_addr)
Heart Rate 5 register reading function.
heartrate5_t::slave_address
uint8_t slave_address
Definition: heartrate5.h:199
heartrate5_t::rst
digital_out_t rst
Definition: heartrate5.h:190
HEARTRATE5_ERROR
@ HEARTRATE5_ERROR
Definition: heartrate5.h:227
heartrate5_cfg_t::int_pin
pin_name_t int_pin
Definition: heartrate5.h:213
heartrate5_t::int_pin
digital_in_t int_pin
Definition: heartrate5.h:193
heartrate5_cfg_t::i2c_address
uint8_t i2c_address
Definition: heartrate5.h:216
heartrate5_get_aled1_val
uint32_t heartrate5_get_aled1_val(heartrate5_t *ctx)
Heart Rate 5 get ALED1 data function.
heartrate5_write_reg
void heartrate5_write_reg(heartrate5_t *ctx, uint8_t reg_addr, uint32_t write_data)
Heart Rate 5 register write function.
heartrate5_default_cfg
err_t heartrate5_default_cfg(heartrate5_t *ctx)
Heart Rate 5 default configuration function.
heartrate5_hw_reset
void heartrate5_hw_reset(heartrate5_t *ctx)
Heart Rate 5 hardware reset function.
heartrate5_cfg_t::rst
pin_name_t rst
Definition: heartrate5.h:212
heartrate5_cfg_t
Heart Rate 5 Click configuration object.
Definition: heartrate5.h:208
heartrate5_sw_reset
void heartrate5_sw_reset(heartrate5_t *ctx)
Heart Rate 5 software reset function.
heartrate5_get_led1_aled1_val
uint32_t heartrate5_get_led1_aled1_val(heartrate5_t *ctx)
Heart Rate 5 get LED1_ALED1 data function.
heartrate5_init
err_t heartrate5_init(heartrate5_t *ctx, heartrate5_cfg_t *cfg)
Heart Rate 5 initialization function.
HEARTRATE5_OK
@ HEARTRATE5_OK
Definition: heartrate5.h:226
heartrate5_get_led2_aled2_val
uint32_t heartrate5_get_led2_aled2_val(heartrate5_t *ctx)
Heart Rate 5 get LED2_ALED2 data function.
heartrate5_t::i2c
i2c_master_t i2c
Definition: heartrate5.h:196
heartrate5_cfg_t::sda
pin_name_t sda
Definition: heartrate5.h:210
heartrate5_cfg_t::scl
pin_name_t scl
Definition: heartrate5.h:209
heartrate5_generic_read
err_t heartrate5_generic_read(heartrate5_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Heart Rate 5 I2C reading function.
heartrate5_get_led2_val
uint32_t heartrate5_get_led2_val(heartrate5_t *ctx)
Heart Rate 5 get LED2 data function.
heartrate5_generic_write
err_t heartrate5_generic_write(heartrate5_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Heart Rate 5 I2C writing function.
heartrate5_return_value_t
heartrate5_return_value_t
Heart Rate 5 Click return value data.
Definition: heartrate5.h:225