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 "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 
73 #define HEARTRATE5_REG0H 0x00
74 #define HEARTRATE5_REG1H 0x01
75 #define HEARTRATE5_REG2H 0x02
76 #define HEARTRATE5_REG3H 0x03
77 #define HEARTRATE5_REG4H 0x04
78 #define HEARTRATE5_REG5H 0x05
79 #define HEARTRATE5_REG6H 0x06
80 #define HEARTRATE5_REG7H 0x07
81 #define HEARTRATE5_REG8H 0x08
82 #define HEARTRATE5_REG9H 0x09
83 #define HEARTRATE5_REGAH 0x0A
84 #define HEARTRATE5_REGBH 0x0B
85 #define HEARTRATE5_REGCH 0x0C
86 #define HEARTRATE5_REGDH 0x0D
87 #define HEARTRATE5_REGEH 0x0E
88 #define HEARTRATE5_REGFH 0x0F
89 #define HEARTRATE5_REG10H 0x10
90 #define HEARTRATE5_REG11H 0x11
91 #define HEARTRATE5_REG12H 0x12
92 #define HEARTRATE5_REG13H 0x13
93 #define HEARTRATE5_REG14H 0x14
94 #define HEARTRATE5_REG15H 0x15
95 #define HEARTRATE5_REG16H 0x16
96 #define HEARTRATE5_REG17H 0x17
97 #define HEARTRATE5_REG18H 0x18
98 #define HEARTRATE5_REG19H 0x19
99 #define HEARTRATE5_REG1AH 0x1A
100 #define HEARTRATE5_REG1BH 0x1B
101 #define HEARTRATE5_REG1CH 0x1C
102 
103 #define HEARTRATE5_REG1DH 0x1D
104 #define HEARTRATE5_REG1EH 0x1E
105 #define HEARTRATE5_REG20H 0x20
106 #define HEARTRATE5_REG21H 0x21
107 #define HEARTRATE5_REG22H 0x22
108 #define HEARTRATE5_REG23H 0x23
109 #define HEARTRATE5_REG29H 0x29
110 
111 #define HEARTRATE5_REG2AH 0x2A
112 #define HEARTRATE5_REG2BH 0x2B
113 #define HEARTRATE5_REG2CH 0x2C
114 #define HEARTRATE5_REG2DH 0x2D
115 #define HEARTRATE5_REG2EH 0x2E
116 #define HEARTRATE5_REG2FH 0x2F
117 #define HEARTRATE5_REG31H 0x31
118 
124 #define HEARTRATE5_REG32H 0x32
125 #define HEARTRATE5_REG33H 0x33
126 
127 #define HEARTRATE5_REG34H 0x34
128 #define HEARTRATE5_REG35H 0x35
129 
135 #define HEARTRATE5_REG36H 0x36
136 #define HEARTRATE5_REG37H 0x37
137 
138 #define HEARTRATE5_REG39H 0x39
139 #define HEARTRATE5_REG3AH 0x3A
140 #define HEARTRATE5_REG3DH 0x3D
141 #define HEARTRATE5_REG3FH 0x3F
142 #define HEARTRATE5_REG40H 0x40
143  // heartrate5_reg
145 
166 #define HEARTRATE5_SET_DEV_ADDR 0x58
167  // heartrate5_set
169 
184 #define HEARTRATE5_MAP_MIKROBUS( cfg, mikrobus ) \
185  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
186  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
187  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
188  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
189  // heartrate5_map // heartrate5
192 
197 typedef struct
198 {
199  // Output pins
200  digital_out_t rst;
202  // Input pins
203  digital_in_t int_pin;
205  // Modules
206  i2c_master_t i2c;
208  // I2C slave address
209  uint8_t slave_address;
211 } heartrate5_t;
212 
217 typedef struct
218 {
219  pin_name_t scl;
220  pin_name_t sda;
222  pin_name_t rst;
223  pin_name_t int_pin;
225  uint32_t i2c_speed;
226  uint8_t i2c_address;
229 
234 typedef enum
235 {
237  HEARTRATE5_ERROR = -1
238 
240 
257 
272 
287 
302 err_t heartrate5_generic_write ( heartrate5_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
303 
318 err_t heartrate5_generic_read ( heartrate5_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
319 
330 void heartrate5_write_reg( heartrate5_t *ctx, uint8_t reg_addr, uint32_t write_data );
331 
341 uint32_t heartrate5_read_reg( heartrate5_t *ctx, uint8_t reg_addr );
342 
351 
360 
369 
378 
387 
396 
405 
414 
415 #ifdef __cplusplus
416 }
417 #endif
418 #endif // HEARTRATE5_H
419  // heartrate5
421 
422 // ------------------------------------------------------------------------ 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:198
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:225
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:209
heartrate5_t::rst
digital_out_t rst
Definition: heartrate5.h:200
HEARTRATE5_ERROR
@ HEARTRATE5_ERROR
Definition: heartrate5.h:237
heartrate5_cfg_t::int_pin
pin_name_t int_pin
Definition: heartrate5.h:223
heartrate5_t::int_pin
digital_in_t int_pin
Definition: heartrate5.h:203
heartrate5_cfg_t::i2c_address
uint8_t i2c_address
Definition: heartrate5.h:226
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:222
heartrate5_cfg_t
Heart Rate 5 Click configuration object.
Definition: heartrate5.h:218
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:236
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:206
heartrate5_cfg_t::sda
pin_name_t sda
Definition: heartrate5.h:220
heartrate5_cfg_t::scl
pin_name_t scl
Definition: heartrate5.h:219
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:235