easypull  2.1.0.0
easypull.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 EASYPULL_H
29 #define EASYPULL_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 
67 #define EASYPULL_PIN_STATE_HIGH 0x01
68 #define EASYPULL_PIN_STATE_LOW 0x00
69  // easypull_set
71 
86 #define EASYPULL_MAP_MIKROBUS( cfg, mikrobus ) \
87  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
88  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
89  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
90  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
91  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
92  // easypull_map // easypull
95 
100 typedef struct
101 {
102  digital_in_t an;
103  digital_in_t rst;
104  digital_in_t cs;
105  digital_in_t pwm;
106  digital_in_t int_pin;
108 } easypull_t;
109 
114 typedef struct
115 {
116  pin_name_t an;
117  pin_name_t rst;
118  pin_name_t cs;
119  pin_name_t pwm;
120  pin_name_t int_pin;
123 
128 typedef enum
129 {
131  EASYPULL_ERROR = -1
132 
134 
151 
166 
178 
190 
202 
214 
226 
227 #ifdef __cplusplus
228 }
229 #endif
230 #endif // EASYPULL_H
231  // easypull
233 
234 // ------------------------------------------------------------------------ END
easypull_cfg_t::int_pin
pin_name_t int_pin
Definition: easypull.h:120
easypull_get_int_pin
uint8_t easypull_get_int_pin(easypull_t *ctx)
EasyPull INT pin reading function.
easypull_cfg_t::cs
pin_name_t cs
Definition: easypull.h:118
easypull_get_an_pin
uint8_t easypull_get_an_pin(easypull_t *ctx)
EasyPull AN pin reading function.
easypull_t::int_pin
digital_in_t int_pin
Definition: easypull.h:106
easypull_t::cs
digital_in_t cs
Definition: easypull.h:104
easypull_cfg_t::an
pin_name_t an
Definition: easypull.h:116
easypull_get_rst_pin
uint8_t easypull_get_rst_pin(easypull_t *ctx)
EasyPull RST pin reading function.
easypull_cfg_t::rst
pin_name_t rst
Definition: easypull.h:117
easypull_cfg_t::pwm
pin_name_t pwm
Definition: easypull.h:119
easypull_return_value_t
easypull_return_value_t
EasyPull Click return value data.
Definition: easypull.h:129
easypull_t
EasyPull Click context object.
Definition: easypull.h:101
EASYPULL_OK
@ EASYPULL_OK
Definition: easypull.h:130
easypull_t::an
digital_in_t an
Definition: easypull.h:102
easypull_get_cs_pin
uint8_t easypull_get_cs_pin(easypull_t *ctx)
EasyPull CS pin reading function.
easypull_cfg_t
EasyPull Click configuration object.
Definition: easypull.h:115
EASYPULL_ERROR
@ EASYPULL_ERROR
Definition: easypull.h:131
easypull_init
err_t easypull_init(easypull_t *ctx, easypull_cfg_t *cfg)
EasyPull initialization function.
easypull_t::rst
digital_in_t rst
Definition: easypull.h:103
easypull_get_pwm_pin
uint8_t easypull_get_pwm_pin(easypull_t *ctx)
EasyPull PWM pin reading function.
easypull_cfg_setup
void easypull_cfg_setup(easypull_cfg_t *cfg)
EasyPull configuration object setup function.
easypull_t::pwm
digital_in_t pwm
Definition: easypull.h:105