eeg  2.0.0.0
eeg.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 EEG_H
29 #define EEG_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 EEG_MAP_MIKROBUS( cfg, mikrobus ) \
60  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
61 
62  // eeg_map // eeg
64 
69 typedef struct
70 {
71  analog_in_t adc;
73 } eeg_t;
74 
79 typedef struct
80 {
81  pin_name_t an;
83  analog_in_resolution_t resolution;
84  float vref;
86 } eeg_cfg_t;
87 
92 typedef enum
93 {
94  EEG_OK = 0,
95  EEG_ERROR = -1
96 
98 
114 void eeg_cfg_setup ( eeg_cfg_t *cfg );
115 
130 err_t eeg_init ( eeg_t *ctx, eeg_cfg_t *cfg );
131 
144 err_t eeg_read_an_pin_value ( eeg_t *ctx, uint16_t *data_out );
145 
160 err_t eeg_read_an_pin_voltage ( eeg_t *ctx, float *data_out );
161 
162 #ifdef __cplusplus
163 }
164 #endif
165 #endif // EEG_H
166  // eeg
168 
169 // ------------------------------------------------------------------------ END
eeg_read_an_pin_voltage
err_t eeg_read_an_pin_voltage(eeg_t *ctx, float *data_out)
EEG read AN pin voltage level function.
eeg_cfg_t::resolution
analog_in_resolution_t resolution
Definition: eeg.h:83
eeg_return_value_t
eeg_return_value_t
EEG Click return value data.
Definition: eeg.h:93
eeg_init
err_t eeg_init(eeg_t *ctx, eeg_cfg_t *cfg)
EEG initialization function.
eeg_read_an_pin_value
err_t eeg_read_an_pin_value(eeg_t *ctx, uint16_t *data_out)
EEG read AN pin value function.
eeg_t::adc
analog_in_t adc
Definition: eeg.h:71
eeg_cfg_setup
void eeg_cfg_setup(eeg_cfg_t *cfg)
EEG configuration object setup function.
EEG_OK
@ EEG_OK
Definition: eeg.h:94
eeg_t
EEG Click context object.
Definition: eeg.h:70
EEG_ERROR
@ EEG_ERROR
Definition: eeg.h:95
eeg_cfg_t::an
pin_name_t an
Definition: eeg.h:81
eeg_cfg_t
EEG Click configuration object.
Definition: eeg.h:80
eeg_cfg_t::vref
float vref
Definition: eeg.h:84