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 "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 
69 #define EEG_MAP_MIKROBUS( cfg, mikrobus ) \
70  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
71 
72  // eeg_map // eeg
74 
79 typedef struct
80 {
81  analog_in_t adc;
83 } eeg_t;
84 
89 typedef struct
90 {
91  pin_name_t an;
93  analog_in_resolution_t resolution;
94  float vref;
96 } eeg_cfg_t;
97 
102 typedef enum
103 {
104  EEG_OK = 0,
105  EEG_ERROR = -1
106 
108 
124 void eeg_cfg_setup ( eeg_cfg_t *cfg );
125 
140 err_t eeg_init ( eeg_t *ctx, eeg_cfg_t *cfg );
141 
154 err_t eeg_read_an_pin_value ( eeg_t *ctx, uint16_t *data_out );
155 
170 err_t eeg_read_an_pin_voltage ( eeg_t *ctx, float *data_out );
171 
172 #ifdef __cplusplus
173 }
174 #endif
175 #endif // EEG_H
176  // eeg
178 
179 // ------------------------------------------------------------------------ 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:93
eeg_return_value_t
eeg_return_value_t
EEG Click return value data.
Definition: eeg.h:103
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:81
eeg_cfg_setup
void eeg_cfg_setup(eeg_cfg_t *cfg)
EEG configuration object setup function.
EEG_OK
@ EEG_OK
Definition: eeg.h:104
eeg_t
EEG Click context object.
Definition: eeg.h:80
EEG_ERROR
@ EEG_ERROR
Definition: eeg.h:105
eeg_cfg_t::an
pin_name_t an
Definition: eeg.h:91
eeg_cfg_t
EEG Click configuration object.
Definition: eeg.h:90
eeg_cfg_t::vref
float vref
Definition: eeg.h:94