relay4  2.1.0.0
relay4.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 RELAY4_H
29 #define RELAY4_H
30 
31 #ifdef __cplusplus
32 extern "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 
68 #define RELAY4_MAP_MIKROBUS( cfg, mikrobus ) \
69  cfg.rl1 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
70  cfg.rl2 = MIKROBUS( mikrobus, MIKROBUS_PWM );
71  // relay4_map // relay4
74 
79 typedef struct
80 {
81  digital_out_t rl1;
82  digital_out_t rl2;
84 } relay4_t;
85 
90 typedef struct
91 {
92  pin_name_t rl1;
93  pin_name_t rl2;
95 } relay4_cfg_t;
96 
101 typedef enum
102 {
104  RELAY4_ERROR = -1
105 
107 
124 
138 err_t relay4_init ( relay4_t *ctx, relay4_cfg_t *cfg );
139 
149 
159 
169 
179 
189 
199 
200 #ifdef __cplusplus
201 }
202 #endif
203 #endif // RELAY4_H
204  // relay4
206 
207 // ------------------------------------------------------------------------ END
relay4_t::rl1
digital_out_t rl1
Definition: relay4.h:81
RELAY4_OK
@ RELAY4_OK
Definition: relay4.h:103
relay4_switch_relay2
void relay4_switch_relay2(relay4_t *ctx)
Relay 4 switch relay2 function.
relay4_cfg_t
Relay 4 Click configuration object.
Definition: relay4.h:91
RELAY4_ERROR
@ RELAY4_ERROR
Definition: relay4.h:104
relay4_t
Relay 4 Click context object.
Definition: relay4.h:80
relay4_cfg_setup
void relay4_cfg_setup(relay4_cfg_t *cfg)
Relay 4 configuration object setup function.
relay4_set_relay1_close
void relay4_set_relay1_close(relay4_t *ctx)
Relay 4 set relay1 close function.
relay4_set_relay1_open
void relay4_set_relay1_open(relay4_t *ctx)
Relay 4 set relay1 open function.
relay4_cfg_t::rl1
pin_name_t rl1
Definition: relay4.h:92
relay4_return_value_t
relay4_return_value_t
Relay 4 Click return value data.
Definition: relay4.h:102
relay4_set_relay2_open
void relay4_set_relay2_open(relay4_t *ctx)
Relay 4 set relay2 open function.
relay4_switch_relay1
void relay4_switch_relay1(relay4_t *ctx)
Relay 4 switch relay1 function.
relay4_t::rl2
digital_out_t rl2
Definition: relay4.h:82
relay4_set_relay2_close
void relay4_set_relay2_close(relay4_t *ctx)
Relay 4 set relay2 close function.
relay4_cfg_t::rl2
pin_name_t rl2
Definition: relay4.h:93
relay4_init
err_t relay4_init(relay4_t *ctx, relay4_cfg_t *cfg)
Relay 4 initialization function.