emg  2.0.0.0
emg.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2021 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 EMG_H
29 #define EMG_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_analog_in.h"
52 
73 #define EMG_MAP_MIKROBUS( cfg, mikrobus ) \
74  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
75  // emg_map // emg
78 
83 typedef struct
84 {
85  analog_in_t adc;
87 } emg_t;
88 
93 typedef struct
94 {
95  pin_name_t an;
97  analog_in_resolution_t resolution;
98  float vref;
100 } emg_cfg_t;
101 
106 typedef enum
107 {
108  EMG_OK = 0,
109  EMG_ERROR = -1
110 
112 
128 void emg_cfg_setup ( emg_cfg_t *cfg );
129 
143 err_t emg_init ( emg_t *ctx, emg_cfg_t *cfg );
144 
156 err_t emg_read_an_pin_value ( emg_t *ctx, uint16_t *data_out );
157 
172 err_t emg_read_an_pin_voltage ( emg_t *ctx, float *data_out );
173 
174 #ifdef __cplusplus
175 }
176 #endif
177 #endif // EMG_H
178  // emg
180 
181 // ------------------------------------------------------------------------ END
emg_return_value_t
emg_return_value_t
EMG Click return value data.
Definition: emg.h:107
emg_cfg_t::an
pin_name_t an
Definition: emg.h:95
emg_read_an_pin_voltage
err_t emg_read_an_pin_voltage(emg_t *ctx, float *data_out)
EMG read AN pin voltage level function.
emg_cfg_t::vref
float vref
Definition: emg.h:98
emg_read_an_pin_value
err_t emg_read_an_pin_value(emg_t *ctx, uint16_t *data_out)
EMG read AN pin value function.
emg_init
err_t emg_init(emg_t *ctx, emg_cfg_t *cfg)
EMG initialization function.
emg_t::adc
analog_in_t adc
Definition: emg.h:85
EMG_ERROR
@ EMG_ERROR
Definition: emg.h:109
emg_cfg_t::resolution
analog_in_resolution_t resolution
Definition: emg.h:97
emg_cfg_t
EMG Click configuration object.
Definition: emg.h:94
emg_cfg_setup
void emg_cfg_setup(emg_cfg_t *cfg)
EMG configuration object setup function.
EMG_OK
@ EMG_OK
Definition: emg.h:108
emg_t
EMG Click context object.
Definition: emg.h:84