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 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_analog_in.h"
38 
59 #define EMG_MAP_MIKROBUS( cfg, mikrobus ) \
60  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
61  // emg_map // emg
64 
69 typedef struct
70 {
71  analog_in_t adc;
73 } emg_t;
74 
79 typedef struct
80 {
81  pin_name_t an;
83  analog_in_resolution_t resolution;
84  float vref;
86 } emg_cfg_t;
87 
92 typedef enum
93 {
94  EMG_OK = 0,
95  EMG_ERROR = -1
96 
98 
114 void emg_cfg_setup ( emg_cfg_t *cfg );
115 
129 err_t emg_init ( emg_t *ctx, emg_cfg_t *cfg );
130 
142 err_t emg_read_an_pin_value ( emg_t *ctx, uint16_t *data_out );
143 
158 err_t emg_read_an_pin_voltage ( emg_t *ctx, float *data_out );
159 
160 #ifdef __cplusplus
161 }
162 #endif
163 #endif // EMG_H
164  // emg
166 
167 // ------------------------------------------------------------------------ END
emg_return_value_t
emg_return_value_t
EMG Click return value data.
Definition: emg.h:91
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_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_ERROR
Definition: emg.h:94
emg_cfg_t
EMG Click configuration object.
Definition: emg.h:78
emg_cfg_setup
void emg_cfg_setup(emg_cfg_t *cfg)
EMG configuration object setup function.
EMG_OK
Definition: emg.h:93
emg_t
EMG Click context object.
Definition: emg.h:68