heartrate7  2.0.0.0
heartrate7.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 HEARTRATE7_H
29 #define HEARTRATE7_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 
64 #define HEARTRATE7_REG0H 0x00
65 #define HEARTRATE7_REG1H 0x01
66 #define HEARTRATE7_REG2H 0x02
67 #define HEARTRATE7_REG3H 0x03
68 #define HEARTRATE7_REG4H 0x04
69 #define HEARTRATE7_REG5H 0x05
70 #define HEARTRATE7_REG6H 0x06
71 #define HEARTRATE7_REG7H 0x07
72 #define HEARTRATE7_REG8H 0x08
73 #define HEARTRATE7_REG9H 0x09
74 #define HEARTRATE7_REGAH 0x0A
75 #define HEARTRATE7_REGBH 0x0B
76 #define HEARTRATE7_REGCH 0x0C
77 #define HEARTRATE7_REGDH 0x0D
78 #define HEARTRATE7_REGEH 0x0E
79 #define HEARTRATE7_REGFH 0x0F
80 #define HEARTRATE7_REG10H 0x10
81 #define HEARTRATE7_REG11H 0x11
82 #define HEARTRATE7_REG12H 0x12
83 #define HEARTRATE7_REG13H 0x13
84 #define HEARTRATE7_REG14H 0x14
85 #define HEARTRATE7_REG15H 0x15
86 #define HEARTRATE7_REG16H 0x16
87 #define HEARTRATE7_REG17H 0x17
88 #define HEARTRATE7_REG18H 0x18
89 #define HEARTRATE7_REG19H 0x19
90 #define HEARTRATE7_REG1AH 0x1A
91 #define HEARTRATE7_REG1BH 0x1B
92 #define HEARTRATE7_REG1CH 0x1C
93 #define HEARTRATE7_REG1DH 0x1D
94 #define HEARTRATE7_REG1EH 0x1E
95 #define HEARTRATE7_REG20H 0x20
96 #define HEARTRATE7_REG21H 0x21
97 #define HEARTRATE7_REG22H 0x22
98 #define HEARTRATE7_REG23H 0x23
99 #define HEARTRATE7_REG29H 0x29
100 #define HEARTRATE7_REG2AH 0x2A
101 #define HEARTRATE7_REG2BH 0x2B
102 #define HEARTRATE7_REG2CH 0x2C
103 #define HEARTRATE7_REG2DH 0x2D
104 #define HEARTRATE7_REG2EH 0x2E
105 #define HEARTRATE7_REG2FH 0x2F
106 #define HEARTRATE7_REG31H 0x31
107 
113 #define HEARTRATE7_REG32H 0x32
114 #define HEARTRATE7_REG33H 0x33
115 #define HEARTRATE7_REG34H 0x34
116 #define HEARTRATE7_REG35H 0x35
117 
123 #define HEARTRATE7_REG36H 0x36
124 #define HEARTRATE7_REG37H 0x37
125 #define HEARTRATE7_REG39H 0x39
126 #define HEARTRATE7_REG3AH 0x3A
127 #define HEARTRATE7_REG3DH 0x3D
128 #define HEARTRATE7_REG3FH 0x3F
129 #define HEARTRATE7_REG40H 0x40
130  // heartrate7_reg
132 
148 #define HEARTRATE7_SET_DEV_ADDR 0x58
149  // heartrate7_set
151 
166 #define HEARTRATE7_MAP_MIKROBUS( cfg, mikrobus ) \
167  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
168  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
169  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
170  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
171  // heartrate7_map // heartrate7
174 
179 typedef struct
180 {
181  // Output pins
182  digital_out_t rst;
184  // Input pins
185  digital_in_t int_pin;
187  // Modules
188  i2c_master_t i2c;
190  // I2C slave address
191  uint8_t slave_address;
193 } heartrate7_t;
194 
199 typedef struct
200 {
201  pin_name_t scl;
202  pin_name_t sda;
204  pin_name_t rst;
205  pin_name_t int_pin;
207  uint32_t i2c_speed;
208  uint8_t i2c_address;
211 
216 typedef enum
217 {
219  HEARTRATE7_ERROR = -1
220 
222 
239 
254 
269 
284 err_t heartrate7_generic_write ( heartrate7_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
285 
300 err_t heartrate7_generic_read ( heartrate7_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
301 
312 void heartrate7_write_reg( heartrate7_t *ctx, uint8_t reg_addr, uint32_t write_data );
313 
323 uint32_t heartrate7_read_reg( heartrate7_t *ctx, uint8_t reg_addr );
324 
333 
342 
351 
360 
369 
378 
387 
396 
397 #ifdef __cplusplus
398 }
399 #endif
400 #endif // HEARTRATE7_H
401  // heartrate7
403 
404 // ------------------------------------------------------------------------ END
HEARTRATE7_OK
@ HEARTRATE7_OK
Definition: heartrate7.h:218
heartrate7_cfg_t::scl
pin_name_t scl
Definition: heartrate7.h:201
HEARTRATE7_ERROR
@ HEARTRATE7_ERROR
Definition: heartrate7.h:219
heartrate7_t
Heart Rate 7 Click context object.
Definition: heartrate7.h:180
heartrate7_get_aled1_val
uint32_t heartrate7_get_aled1_val(heartrate7_t *ctx)
Heart Rate 7 get ALED1 data function.
heartrate7_t::slave_address
uint8_t slave_address
Definition: heartrate7.h:191
heartrate7_generic_read
err_t heartrate7_generic_read(heartrate7_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Heart Rate 7 I2C reading function.
heartrate7_cfg_t::int_pin
pin_name_t int_pin
Definition: heartrate7.h:205
heartrate7_cfg_t::rst
pin_name_t rst
Definition: heartrate7.h:204
heartrate7_get_led1_val
uint32_t heartrate7_get_led1_val(heartrate7_t *ctx)
Heart Rate 7 get LED1 data function.
heartrate7_return_value_t
heartrate7_return_value_t
Heart Rate 7 Click return value data.
Definition: heartrate7.h:217
heartrate7_write_reg
void heartrate7_write_reg(heartrate7_t *ctx, uint8_t reg_addr, uint32_t write_data)
Heart Rate 7 register writing function.
heartrate7_t::rst
digital_out_t rst
Definition: heartrate7.h:182
heartrate7_t::int_pin
digital_in_t int_pin
Definition: heartrate7.h:185
heartrate7_read_reg
uint32_t heartrate7_read_reg(heartrate7_t *ctx, uint8_t reg_addr)
Heart Rate 7 register reading function.
heartrate7_init
err_t heartrate7_init(heartrate7_t *ctx, heartrate7_cfg_t *cfg)
Heart Rate 7 initialization function.
heartrate7_sw_reset
void heartrate7_sw_reset(heartrate7_t *ctx)
Heart Rate 7 software reset function.
heartrate7_cfg_t
Heart Rate 7 Click configuration object.
Definition: heartrate7.h:200
heartrate7_t::i2c
i2c_master_t i2c
Definition: heartrate7.h:188
heartrate7_hw_reset
void heartrate7_hw_reset(heartrate7_t *ctx)
Heart Rate 7 hardware reset function.
heartrate7_generic_write
err_t heartrate7_generic_write(heartrate7_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Heart Rate 7 I2C writing function.
heartrate7_cfg_setup
void heartrate7_cfg_setup(heartrate7_cfg_t *cfg)
Heart Rate 7 configuration object setup function.
heartrate7_get_led2_val
uint32_t heartrate7_get_led2_val(heartrate7_t *ctx)
Heart Rate 7 get LED2 data function.
heartrate7_default_cfg
err_t heartrate7_default_cfg(heartrate7_t *ctx)
Heart Rate 7 default configuration function.
heartrate7_get_aled2_val_led3v_al
uint32_t heartrate7_get_aled2_val_led3v_al(heartrate7_t *ctx)
Heart Rate 7 get ALED2 data function.
heartrate7_get_led1_aled1_val
uint32_t heartrate7_get_led1_aled1_val(heartrate7_t *ctx)
Heart Rate 7 get LED1_ALED1 data function.
heartrate7_get_led2_aled2_val
uint32_t heartrate7_get_led2_aled2_val(heartrate7_t *ctx)
Heart Rate 7 get LED2_ALED2 data function.
heartrate7_cfg_t::sda
pin_name_t sda
Definition: heartrate7.h:202
heartrate7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: heartrate7.h:207
heartrate7_cfg_t::i2c_address
uint8_t i2c_address
Definition: heartrate7.h:208