ipd2015  2.1.0.0
ipd2015.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 IPD2015_H
29 #define IPD2015_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 IPD2015_NONE_PIN_MASK 0x00
68 #define IPD2015_OUT1_PIN_MASK 0x01
69 #define IPD2015_OUT2_PIN_MASK 0x02
70 #define IPD2015_OUT3_PIN_MASK 0x04
71 #define IPD2015_OUT4_PIN_MASK 0x08
72 #define IPD2015_ALL_PIN_MASK 0x0F
73 
78 #define IPD2015_PIN_STATE_HIGH 0x01
79 #define IPD2015_PIN_STATE_LOW 0x00
80  // ipd2015_set
82 
97 #define IPD2015_MAP_MIKROBUS( cfg, mikrobus ) \
98  cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
99  cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
100  cfg.in3 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
101  cfg.in4 = MIKROBUS( mikrobus, MIKROBUS_INT )
102  // ipd2015_map // ipd2015
105 
110 typedef struct
111 {
112  digital_out_t in1;
113  digital_out_t in2;
114  digital_out_t in3;
115  digital_out_t in4;
117  uint8_t state;
119 } ipd2015_t;
120 
125 typedef struct
126 {
127  pin_name_t in1;
128  pin_name_t in2;
129  pin_name_t in3;
130  pin_name_t in4;
132 } ipd2015_cfg_t;
133 
138 typedef enum
139 {
141  IPD2015_ERROR = -1
142 
144 
161 
175 err_t ipd2015_init ( ipd2015_t *ctx, ipd2015_cfg_t *cfg );
176 
187 
198 
211 err_t ipd2015_set_out_level ( ipd2015_t *ctx, uint8_t out_sel, uint8_t state );
212 
222 
223 #ifdef __cplusplus
224 }
225 #endif
226 #endif // IPD2015_H
227  // ipd2015
229 
230 // ------------------------------------------------------------------------ END
IPD2015_OK
@ IPD2015_OK
Definition: ipd2015.h:140
ipd2015_get_out_state
uint8_t ipd2015_get_out_state(ipd2015_t *ctx)
IPD 2015 get output level function.
ipd2015_set_out_level
err_t ipd2015_set_out_level(ipd2015_t *ctx, uint8_t out_sel, uint8_t state)
IPD 2015 set output level function.
ipd2015_cfg_t
IPD 2015 Click configuration object.
Definition: ipd2015.h:126
ipd2015_all_pins_set
void ipd2015_all_pins_set(ipd2015_t *ctx)
IPD 2015 pin setting function.
ipd2015_return_value_t
ipd2015_return_value_t
IPD 2015 Click return value data.
Definition: ipd2015.h:139
ipd2015_init
err_t ipd2015_init(ipd2015_t *ctx, ipd2015_cfg_t *cfg)
IPD 2015 initialization function.
ipd2015_t::in4
digital_out_t in4
Definition: ipd2015.h:115
ipd2015_t::state
uint8_t state
Definition: ipd2015.h:117
ipd2015_cfg_t::in3
pin_name_t in3
Definition: ipd2015.h:129
ipd2015_t::in3
digital_out_t in3
Definition: ipd2015.h:114
ipd2015_t::in1
digital_out_t in1
Definition: ipd2015.h:112
ipd2015_cfg_t::in4
pin_name_t in4
Definition: ipd2015.h:130
IPD2015_ERROR
@ IPD2015_ERROR
Definition: ipd2015.h:141
ipd2015_cfg_t::in1
pin_name_t in1
Definition: ipd2015.h:127
ipd2015_all_pins_clear
void ipd2015_all_pins_clear(ipd2015_t *ctx)
IPD 2015 pin clearing function.
ipd2015_t::in2
digital_out_t in2
Definition: ipd2015.h:113
ipd2015_t
IPD 2015 Click context object.
Definition: ipd2015.h:111
ipd2015_cfg_setup
void ipd2015_cfg_setup(ipd2015_cfg_t *cfg)
IPD 2015 configuration object setup function.
ipd2015_cfg_t::in2
pin_name_t in2
Definition: ipd2015.h:128