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 "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_in.h"
46 #include "drv_analog_in.h"
47 
68 #define CO_MAP_MIKROBUS( cfg, mikrobus ) \
69  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
70  // co_map // co
73 
78 typedef struct
79 {
80  analog_in_t adc;
82 } co_t;
83 
88 typedef struct
89 {
90  pin_name_t an;
92  // static variable
93 
94  analog_in_resolution_t resolution;
95  float vref;
97 } co_cfg_t;
98 
103 typedef enum
104 {
105  CO_OK = 0,
106  CO_ERROR = -1
107 
109 
125 void co_cfg_setup ( co_cfg_t *cfg );
126 
141 err_t co_init ( co_t *ctx, co_cfg_t *cfg );
142 
155 err_t co_read_an_pin_value ( co_t *ctx, uint16_t *data_out );
156 
171 err_t co_read_an_pin_voltage ( co_t *ctx, float *data_out );
172 
173 #ifdef __cplusplus
174 }
175 #endif
176 #endif // CO_H
177  // co
179 
180 // ------------------------------------------------------------------------ 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:79
co_cfg_t
CO Click configuration object.
Definition: co.h:89
co_cfg_t::resolution
analog_in_resolution_t resolution
Definition: co.h:94
co_cfg_t::vref
float vref
Definition: co.h:95
CO_ERROR
@ CO_ERROR
Definition: co.h:106
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_cfg_t::an
pin_name_t an
Definition: co.h:90
co_return_value_t
co_return_value_t
CO Click return value data.
Definition: co.h:104
co_t::adc
analog_in_t adc
Definition: co.h:80
CO_OK
@ CO_OK
Definition: co.h:105
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.