co  2.0.0.0
co.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 CO_H
29 #define CO_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_in.h"
36 #include "drv_analog_in.h"
37 
58 #define CO_MAP_MIKROBUS( cfg, mikrobus ) \
59  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
60  // co_map // co
63 
68 typedef struct
69 {
70  analog_in_t adc;
72 } co_t;
73 
78 typedef struct
79 {
80  pin_name_t an;
82  // static variable
83 
84  analog_in_resolution_t resolution;
85  float vref;
87 } co_cfg_t;
88 
93 typedef enum
94 {
95  CO_OK = 0,
96  CO_ERROR = -1
97 
99 
115 void co_cfg_setup ( co_cfg_t *cfg );
116 
131 err_t co_init ( co_t *ctx, co_cfg_t *cfg );
132 
145 err_t co_read_an_pin_value ( co_t *ctx, uint16_t *data_out );
146 
161 err_t co_read_an_pin_voltage ( co_t *ctx, float *data_out );
162 
163 #ifdef __cplusplus
164 }
165 #endif
166 #endif // CO_H
167  // co
169 
170 // ------------------------------------------------------------------------ END
co_read_an_pin_voltage
err_t co_read_an_pin_voltage(co_t *ctx, float *data_out)
CO read AN pin voltage level function.
co_t
CO Click context object.
Definition: co.h:67
co_cfg_t
CO Click configuration object.
Definition: co.h:77
CO_ERROR
Definition: co.h:95
co_cfg_setup
void co_cfg_setup(co_cfg_t *cfg)
CO configuration object setup function.
co_init
err_t co_init(co_t *ctx, co_cfg_t *cfg)
CO initialization function.
co_return_value_t
co_return_value_t
CO Click return value data.
Definition: co.h:92
CO_OK
Definition: co.h:94
co_read_an_pin_value
err_t co_read_an_pin_value(co_t *ctx, uint16_t *data_out)
CO read AN pin value function.