ecg7  2.0.0.0
ecg7.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 ECG7_H
29 #define ECG7_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_analog_in.h"
48 #include "drv_i2c_master.h"
49 
70 #define ECG7_ADC_RESOLUTION 0x0FFF
71 #define ECG7_VREF_3V3 3.3
72 #define ECG7_VREF_5V 5.0
73 
79 #define ECG7_SET_DEV_ADDR 0x4D
80  // ecg7_set
82 
97 #define ECG7_MAP_MIKROBUS( cfg, mikrobus ) \
98  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
99  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
100  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
101  // ecg7_map // ecg7
104 
109 typedef enum
110 {
115 
120 typedef struct
121 {
122  analog_in_t adc;
123  i2c_master_t i2c;
125  uint8_t slave_address;
126  pin_name_t chip_select;
127  float vref;
130 } ecg7_t;
131 
136 typedef struct
137 {
138  pin_name_t an;
139  pin_name_t scl;
140  pin_name_t sda;
142  analog_in_resolution_t resolution;
143  float vref;
145  uint32_t i2c_speed;
146  uint8_t i2c_address;
150 } ecg7_cfg_t;
151 
156 typedef enum
157 {
158  ECG7_OK = 0,
159  ECG7_ERROR = -1
160 
162 
179 
195 
209 err_t ecg7_init ( ecg7_t *ctx, ecg7_cfg_t *cfg );
210 
222 err_t ecg7_read_raw_adc ( ecg7_t *ctx, uint16_t *raw_adc );
223 
235 err_t ecg7_read_voltage ( ecg7_t *ctx, float *voltage );
236 
248 err_t ecg7_set_vref ( ecg7_t *ctx, float vref );
249 
250 #ifdef __cplusplus
251 }
252 #endif
253 #endif // ECG7_H
254  // ecg7
256 
257 // ------------------------------------------------------------------------ END
ecg7_cfg_setup
void ecg7_cfg_setup(ecg7_cfg_t *cfg)
ECG 7 configuration object setup function.
ecg7_t::i2c
i2c_master_t i2c
Definition: ecg7.h:123
ecg7_cfg_t::i2c_address
uint8_t i2c_address
Definition: ecg7.h:146
ecg7_t
ECG 7 Click context object.
Definition: ecg7.h:121
ecg7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: ecg7.h:145
ecg7_cfg_t::resolution
analog_in_resolution_t resolution
Definition: ecg7.h:142
ECG7_ERROR
@ ECG7_ERROR
Definition: ecg7.h:159
ecg7_t::slave_address
uint8_t slave_address
Definition: ecg7.h:125
ecg7_t::chip_select
pin_name_t chip_select
Definition: ecg7.h:126
ecg7_cfg_t::scl
pin_name_t scl
Definition: ecg7.h:139
ecg7_drv_t
ecg7_drv_t
ECG 7 Click driver selector.
Definition: ecg7.h:110
ecg7_read_raw_adc
err_t ecg7_read_raw_adc(ecg7_t *ctx, uint16_t *raw_adc)
ECG 7 read raw ADC value function.
ecg7_t::drv_sel
ecg7_drv_t drv_sel
Definition: ecg7.h:128
ecg7_cfg_t
ECG 7 Click configuration object.
Definition: ecg7.h:137
ECG7_DRV_SEL_ADC
@ ECG7_DRV_SEL_ADC
Definition: ecg7.h:111
ECG7_OK
@ ECG7_OK
Definition: ecg7.h:158
ecg7_cfg_t::an
pin_name_t an
Definition: ecg7.h:138
ecg7_drv_interface_selection
void ecg7_drv_interface_selection(ecg7_cfg_t *cfg, ecg7_drv_t drv_sel)
ECG 7 driver interface setup function.
ecg7_cfg_t::vref
float vref
Definition: ecg7.h:143
ecg7_set_vref
err_t ecg7_set_vref(ecg7_t *ctx, float vref)
ECG 7 set vref function.
ecg7_read_voltage
err_t ecg7_read_voltage(ecg7_t *ctx, float *voltage)
ECG 7 read voltage level function.
ecg7_init
err_t ecg7_init(ecg7_t *ctx, ecg7_cfg_t *cfg)
ECG 7 initialization function.
ecg7_cfg_t::sda
pin_name_t sda
Definition: ecg7.h:140
ecg7_cfg_t::drv_sel
ecg7_drv_t drv_sel
Definition: ecg7.h:148
ecg7_return_value_t
ecg7_return_value_t
ECG 7 Click return value data.
Definition: ecg7.h:157
ecg7_t::adc
analog_in_t adc
Definition: ecg7.h:122
ECG7_DRV_SEL_I2C
@ ECG7_DRV_SEL_I2C
Definition: ecg7.h:112
ecg7_t::vref
float vref
Definition: ecg7.h:127