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
32extern "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_digital_out.h"
46#include "drv_digital_in.h"
47
63#define EASYPULL_PIN_STATE_HIGH 0x01
64#define EASYPULL_PIN_STATE_LOW 0x00
65 // easypull_set
67
82#define EASYPULL_MAP_MIKROBUS( cfg, mikrobus ) \
83 cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
84 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
85 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
86 cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
87 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
88 // easypull_map // easypull
91
96typedef struct
97{
98 digital_in_t an;
99 digital_in_t rst;
100 digital_in_t cs;
101 digital_in_t pwm;
102 digital_in_t int_pin;
104} easypull_t;
105
110typedef struct
111{
112 pin_name_t an;
113 pin_name_t rst;
114 pin_name_t cs;
115 pin_name_t pwm;
116 pin_name_t int_pin;
119
124typedef enum
125{
127 EASYPULL_ERROR = -1
128
130
147
162
174
186
198
210
222
223#ifdef __cplusplus
224}
225#endif
226#endif // EASYPULL_H
227 // easypull
229
230// ------------------------------------------------------------------------ END
easypull_return_value_t
EasyPull Click return value data.
Definition: easypull.h:125
@ EASYPULL_ERROR
Definition: easypull.h:127
@ EASYPULL_OK
Definition: easypull.h:126
err_t easypull_init(easypull_t *ctx, easypull_cfg_t *cfg)
EasyPull initialization function.
uint8_t easypull_get_cs_pin(easypull_t *ctx)
EasyPull CS pin reading function.
uint8_t easypull_get_pwm_pin(easypull_t *ctx)
EasyPull PWM pin reading function.
uint8_t easypull_get_an_pin(easypull_t *ctx)
EasyPull AN pin reading function.
uint8_t easypull_get_rst_pin(easypull_t *ctx)
EasyPull RST pin reading function.
uint8_t easypull_get_int_pin(easypull_t *ctx)
EasyPull INT pin reading function.
void easypull_cfg_setup(easypull_cfg_t *cfg)
EasyPull configuration object setup function.
EasyPull Click configuration object.
Definition: easypull.h:111
pin_name_t int_pin
Definition: easypull.h:116
pin_name_t pwm
Definition: easypull.h:115
pin_name_t rst
Definition: easypull.h:113
pin_name_t an
Definition: easypull.h:112
pin_name_t cs
Definition: easypull.h:114
EasyPull Click context object.
Definition: easypull.h:97
digital_in_t cs
Definition: easypull.h:100
digital_in_t pwm
Definition: easypull.h:101
digital_in_t int_pin
Definition: easypull.h:102
digital_in_t rst
Definition: easypull.h:99
digital_in_t an
Definition: easypull.h:98