signalrelay  2.0.0.0
signalrelay.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 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef SIGNALRELAY_H
36 #define SIGNALRELAY_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 
50 // -------------------------------------------------------------- PUBLIC MACROS
60 #define SIGNALRELAY_MAP_MIKROBUS( cfg, mikrobus ) \
61  cfg.re1= MIKROBUS( mikrobus, MIKROBUS_AN ); \
62  cfg.re2= MIKROBUS( mikrobus, MIKROBUS_RST ); \
63  cfg.re3= MIKROBUS( mikrobus, MIKROBUS_CS ); \
64  cfg.re4= MIKROBUS( mikrobus, MIKROBUS_PWM );
65 
71 #define SIGNALRELAY_RETVAL uint8_t
72 
73 #define SIGNALRELAY_OK 0x00
74 #define SIGNALRELAY_INIT_ERROR 0xFF
75 
81 #define SIGNALRELAY_RELAY_1 1
82 #define SIGNALRELAY_RELAY_2 2
83 #define SIGNALRELAY_RELAY_3 3
84 #define SIGNALRELAY_RELAY_4 4
85 
91 #define SIGNALRELAY_STATE_ON 0x01
92 #define SIGNALRELAY_STATE_OFF 0x00
93  // End group macro
96 // --------------------------------------------------------------- PUBLIC TYPES
105 typedef struct
106 {
107  // Output pins
108 
109  digital_out_t re1;
110  digital_out_t re2;
111  digital_out_t re3;
112  digital_out_t re4;
113 
114 } signalrelay_t;
115 
119 typedef struct
120 {
121  // Additional gpio pins
122 
123  pin_name_t re1;
124  pin_name_t re2;
125  pin_name_t re3;
126  pin_name_t re4;
127 
129  // End types group
131 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
132 
138 #ifdef __cplusplus
139 extern "C"{
140 #endif
141 
151 
160 
170 
178 void signalrelay_relay_state( signalrelay_t *ctx, uint8_t relay, uint8_t state );
179 
180 
181 #ifdef __cplusplus
182 }
183 #endif
184 #endif // _SIGNALRELAY_H_
185  // End public_function group
188 
189 // ------------------------------------------------------------------------- END
signalrelay_init
SIGNALRELAY_RETVAL signalrelay_init(signalrelay_t *ctx, signalrelay_cfg_t *cfg)
Initialization function.
signalrelay_relay_state
void signalrelay_relay_state(signalrelay_t *ctx, uint8_t relay, uint8_t state)
Relays state.
signalrelay_t::re1
digital_out_t re1
Definition: signalrelay.h:109
signalrelay_t::re3
digital_out_t re3
Definition: signalrelay.h:111
signalrelay_t::re4
digital_out_t re4
Definition: signalrelay.h:112
signalrelay_cfg_t::re2
pin_name_t re2
Definition: signalrelay.h:124
signalrelay_cfg_t::re1
pin_name_t re1
Definition: signalrelay.h:123
signalrelay_default_cfg
void signalrelay_default_cfg(signalrelay_t *ctx)
Click Default Configuration function.
signalrelay_cfg_t::re4
pin_name_t re4
Definition: signalrelay.h:126
signalrelay_cfg_setup
void signalrelay_cfg_setup(signalrelay_cfg_t *cfg)
Config Object Initialization function.
signalrelay_t::re2
digital_out_t re2
Definition: signalrelay.h:110
signalrelay_cfg_t
Click configuration structure definition.
Definition: signalrelay.h:120
SIGNALRELAY_RETVAL
#define SIGNALRELAY_RETVAL
Definition: signalrelay.h:71
signalrelay_t
Click ctx object definition.
Definition: signalrelay.h:106
signalrelay_cfg_t::re3
pin_name_t re3
Definition: signalrelay.h:125