stretch  2.0.0.0
stretch.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 
35 #ifndef STRETCH_H
36 #define STRETCH_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_analog_in.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
43 
53 #define STRETCH_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.an_pin = MIKROBUS( mikrobus, MIKROBUS_AN ); \
55  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
56 
62 #define STRETCH_RETVAL uint8_t
63 
64 #define STRETCH_OK 0x00
65 #define STRETCH_INIT_ERROR 0xFF
66  // End group macro
69 // --------------------------------------------------------------- PUBLIC TYPES
78 typedef uint16_t stretch_data_t;
79 
83 typedef struct
84 {
85  // Output pins
86 
87  digital_out_t pwm;
88 
89  // Modules
90 
91  analog_in_t adc;
92 
93 } stretch_t;
94 
98 typedef struct
99 {
100  // Communication gpio pins
101 
102  pin_name_t an_pin;
103 
104  // Additional gpio pins
105 
106  pin_name_t pwm;
107 
108 
109  // static variable
110 
111  analog_in_resolution_t resolution; // Resolution
112  float vref; // VRef
113 
114 } stretch_cfg_t;
115  // End types group
117 
123 #ifdef __cplusplus
124 extern "C"{
125 #endif
126 
136 
146 
155 
165 
174 
183 
184 #ifdef __cplusplus
185 }
186 #endif
187 #endif // _STRETCH_H_
188  // End public_function group
191 
192 // ------------------------------------------------------------------------ END
stretch_data_t
uint16_t stretch_data_t
Analog data type.
Definition: stretch.h:78
stretch_cfg_t
Click configuration structure definition.
Definition: stretch.h:99
stretch_cfg_setup
void stretch_cfg_setup(stretch_cfg_t *cfg)
Config Object Initialization function.
stretch_t::adc
analog_in_t adc
Definition: stretch.h:91
stretch_init
STRETCH_RETVAL stretch_init(stretch_t *ctx, stretch_cfg_t *cfg)
Initialization function.
stretch_turn_off_led
void stretch_turn_off_led(stretch_t *ctx)
Turn off the LED function.
stretch_t::pwm
digital_out_t pwm
Definition: stretch.h:87
stretch_t
Click ctx object definition.
Definition: stretch.h:84
stretch_cfg_t::an_pin
pin_name_t an_pin
Definition: stretch.h:102
stretch_cfg_t::pwm
pin_name_t pwm
Definition: stretch.h:106
stretch_turn_on_led
void stretch_turn_on_led(stretch_t *ctx)
Turn on the LED function.
stretch_default_cfg
void stretch_default_cfg(stretch_t *ctx)
Click Default Configuration function.
STRETCH_RETVAL
#define STRETCH_RETVAL
Definition: stretch.h:62
stretch_cfg_t::resolution
analog_in_resolution_t resolution
Definition: stretch.h:111
stretch_generic_read
stretch_data_t stretch_generic_read(stretch_t *ctx)
Generic read function.
stretch_cfg_t::vref
float vref
Definition: stretch.h:112