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 "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_analog_in.h"
46 
67 // TODO -- dodati makroe koji definisu adrese registara
68  // hydrogen_reg
70 
85 // TODO -- dodati makroe koji definisu komande/vrednosti koje se upisuju u registre
86  // hydrogen_set
88 
103 #define HYDROGEN_MAP_MIKROBUS( cfg, mikrobus ) \
104  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
105 
106  // hydrogen_map // hydrogen
108 
113 typedef struct
114 {
115  analog_in_t adc;
117 } hydrogen_t;
118 
123 typedef struct
124 {
125  pin_name_t an;
127  // static variable
128  analog_in_resolution_t resolution;
129  float vref;
132 
137 typedef enum
138 {
140  HYDROGEN_ERROR = -1
141 
143 
160 
176 
189 err_t hydrogen_read_an_pin_value ( hydrogen_t *ctx, uint16_t *data_out );
190 
205 err_t hydrogen_read_an_pin_voltage ( hydrogen_t *ctx, float *data_out );
206 
207 #ifdef __cplusplus
208 }
209 #endif
210 #endif // HYDROGEN_H
211  // hydrogen
213 
214 // ------------------------------------------------------------------------ END
hydrogen_cfg_t::an
pin_name_t an
Definition: hydrogen.h:125
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:115
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:138
hydrogen_t
Hydrogen Click context object.
Definition: hydrogen.h:114
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:124
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:128
hydrogen_cfg_t::vref
float vref
Definition: hydrogen.h:129
HYDROGEN_ERROR
@ HYDROGEN_ERROR
Definition: hydrogen.h:140
HYDROGEN_OK
@ HYDROGEN_OK
Definition: hydrogen.h:139