pot  2.0.0.0
pot.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
34 #ifndef POT_H
35 #define POT_H
36 
37 #include "drv_digital_out.h"
38 #include "drv_digital_in.h"
39 #include "drv_analog_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
42 
52 #define POT_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.an_pin = MIKROBUS( mikrobus, MIKROBUS_AN )
54 
60 #define POT_RETVAL uint8_t
61 
62 #define POT_OK 0x00
63 #define POT_INIT_ERROR 0xFF
64  // End group macro
67 
68 // --------------------------------------------------------------- PUBLIC TYPES
77 typedef uint16_t pot_data_t;
78 
82 typedef struct
83 {
84  // Modules
85 
86  analog_in_t adc;
87 
88 } pot_t;
89 
93 typedef struct
94 {
95  // Communication gpio pins
96 
97  pin_name_t an_pin;
98 
99  // static variable
100 
101  analog_in_resolution_t resolution; // Resolution
102  float vref; // VRef
103 
104 } pot_cfg_t;
105  // End types group
107 
108 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
109 
115 #ifdef __cplusplus
116 extern "C"{
117 #endif
118 
127 void pot_cfg_setup ( pot_cfg_t *cfg );
128 
137 POT_RETVAL pot_init ( pot_t *ctx, pot_cfg_t *cfg );
138 
148 
149 #ifdef __cplusplus
150 }
151 #endif
152 #endif // _POT_H_
153  // End public_function group
156 
157 // ------------------------------------------------------------------------ END
uint16_t pot_data_t
Analog data type.
Definition: pot.h:77
analog_in_resolution_t resolution
Definition: pot.h:101
pin_name_t an_pin
Definition: pot.h:97
pot_data_t pot_generic_read(pot_t *ctx)
Generic read function.
void pot_cfg_setup(pot_cfg_t *cfg)
Config Object Initialization function.
#define POT_RETVAL
Definition: pot.h:60
POT_RETVAL pot_init(pot_t *ctx, pot_cfg_t *cfg)
Initialization function.
analog_in_t adc
Definition: pot.h:86
Click ctx object definition.
Definition: pot.h:82
Click configuration structure definition.
Definition: pot.h:93
float vref
Definition: pot.h:102