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 "drv_digital_out.h"
39 
40 // -------------------------------------------------------------- PUBLIC MACROS
50 #define SIGNALRELAY_MAP_MIKROBUS( cfg, mikrobus ) \
51  cfg.re1= MIKROBUS( mikrobus, MIKROBUS_AN ); \
52  cfg.re2= MIKROBUS( mikrobus, MIKROBUS_RST ); \
53  cfg.re3= MIKROBUS( mikrobus, MIKROBUS_CS ); \
54  cfg.re4= MIKROBUS( mikrobus, MIKROBUS_PWM );
55 
61 #define SIGNALRELAY_RETVAL uint8_t
62 
63 #define SIGNALRELAY_OK 0x00
64 #define SIGNALRELAY_INIT_ERROR 0xFF
65 
71 #define SIGNALRELAY_RELAY_1 1
72 #define SIGNALRELAY_RELAY_2 2
73 #define SIGNALRELAY_RELAY_3 3
74 #define SIGNALRELAY_RELAY_4 4
75 
81 #define SIGNALRELAY_STATE_ON 0x01
82 #define SIGNALRELAY_STATE_OFF 0x00
83  // End group macro
86 // --------------------------------------------------------------- PUBLIC TYPES
95 typedef struct
96 {
97  // Output pins
98 
99  digital_out_t re1;
100  digital_out_t re2;
101  digital_out_t re3;
102  digital_out_t re4;
103 
104 } signalrelay_t;
105 
109 typedef struct
110 {
111  // Additional gpio pins
112 
113  pin_name_t re1;
114  pin_name_t re2;
115  pin_name_t re3;
116  pin_name_t re4;
117 
119  // End types group
121 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
122 
128 #ifdef __cplusplus
129 extern "C"{
130 #endif
131 
141 
150 
160 
168 void signalrelay_relay_state( signalrelay_t *ctx, uint8_t relay, uint8_t state );
169 
170 
171 #ifdef __cplusplus
172 }
173 #endif
174 #endif // _SIGNALRELAY_H_
175  // End public_function group
178 
179 // ------------------------------------------------------------------------- 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:99
signalrelay_t::re3
digital_out_t re3
Definition: signalrelay.h:101
signalrelay_t::re4
digital_out_t re4
Definition: signalrelay.h:102
signalrelay_cfg_t::re2
pin_name_t re2
Definition: signalrelay.h:114
signalrelay_cfg_t::re1
pin_name_t re1
Definition: signalrelay.h:113
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:116
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:100
signalrelay_cfg_t
Click configuration structure definition.
Definition: signalrelay.h:110
SIGNALRELAY_RETVAL
#define SIGNALRELAY_RETVAL
Definition: signalrelay.h:61
signalrelay_t
Click ctx object definition.
Definition: signalrelay.h:96
signalrelay_cfg_t::re3
pin_name_t re3
Definition: signalrelay.h:115