hydrogen  2.0.0.0
hydrogen.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 HYDROGEN_H
29 #define HYDROGEN_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_analog_in.h"
36 
57 // TODO -- dodati makroe koji definisu adrese registara
58  // hydrogen_reg
60 
75 // TODO -- dodati makroe koji definisu komande/vrednosti koje se upisuju u registre
76  // hydrogen_set
78 
93 #define HYDROGEN_MAP_MIKROBUS( cfg, mikrobus ) \
94  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
95 
96  // hydrogen_map // hydrogen
98 
103 typedef struct
104 {
105  analog_in_t adc;
107 } hydrogen_t;
108 
113 typedef struct
114 {
115  pin_name_t an;
117  // static variable
118  analog_in_resolution_t resolution;
119  float vref;
122 
127 typedef enum
128 {
130  HYDROGEN_ERROR = -1
131 
133 
150 
166 
179 err_t hydrogen_read_an_pin_value ( hydrogen_t *ctx, uint16_t *data_out );
180 
195 err_t hydrogen_read_an_pin_voltage ( hydrogen_t *ctx, float *data_out );
196 
197 #ifdef __cplusplus
198 }
199 #endif
200 #endif // HYDROGEN_H
201  // hydrogen
203 
204 // ------------------------------------------------------------------------ END
hydrogen_cfg_t::an
pin_name_t an
Definition: hydrogen.h:115
hydrogen_init
err_t hydrogen_init(hydrogen_t *ctx, hydrogen_cfg_t *cfg)
Hydrogen initialization function.
hydrogen_t::adc
analog_in_t adc
Definition: hydrogen.h:105
hydrogen_cfg_setup
void hydrogen_cfg_setup(hydrogen_cfg_t *cfg)
Hydrogen configuration object setup function.
hydrogen_return_value_t
hydrogen_return_value_t
Hydrogen Click return value data.
Definition: hydrogen.h:128
hydrogen_t
Hydrogen Click context object.
Definition: hydrogen.h:104
hydrogen_read_an_pin_value
err_t hydrogen_read_an_pin_value(hydrogen_t *ctx, uint16_t *data_out)
Hydrogen read AN pin value function.
hydrogen_cfg_t
Hydrogen Click configuration object.
Definition: hydrogen.h:114
hydrogen_read_an_pin_voltage
err_t hydrogen_read_an_pin_voltage(hydrogen_t *ctx, float *data_out)
Hydrogen read AN pin voltage level function.
hydrogen_cfg_t::resolution
analog_in_resolution_t resolution
Definition: hydrogen.h:118
hydrogen_cfg_t::vref
float vref
Definition: hydrogen.h:119
HYDROGEN_ERROR
@ HYDROGEN_ERROR
Definition: hydrogen.h:130
HYDROGEN_OK
@ HYDROGEN_OK
Definition: hydrogen.h:129