relay2  2.0.0.0
relay2.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 RELAY2_H
36 #define RELAY2_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define RELAY2_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
53  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM );
54 
60 #define RELAY2_RETVAL uint8_t
61 
62 #define RELAY2_OK 0x70
63 #define RELAY2_INIT_ERROR 0xFF
64  // End group macro
67 // --------------------------------------------------------------- PUBLIC TYPES
76 typedef struct
77 {
78  // Output pins
79 
80  digital_out_t an;
81  digital_out_t pwm;
82 
83 } relay2_t;
84 
88 typedef struct
89 {
90  // Additional gpio pins
91 
92  pin_name_t an;
93  pin_name_t pwm;
94 
95 } relay2_cfg_t;
96  // End types group
98 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
99 
105 #ifdef __cplusplus
106 extern "C"{
107 #endif
108 
117 void relay2_cfg_setup ( relay2_cfg_t *cfg );
118 
127 
136 void relay2_relay2_control (relay2_t *ctx, uint8_t pin_state );
137 
147 void relay2_relay1_control (relay2_t *ctx, uint8_t pin_state );
148 
149 #ifdef __cplusplus
150 }
151 #endif
152 #endif // _RELAY2_H_
153  // End public_function group
156 
157 // ------------------------------------------------------------------------- END
RELAY2_RETVAL relay2_init(relay2_t *ctx, relay2_cfg_t *cfg)
Initialization function.
void relay2_relay1_control(relay2_t *ctx, uint8_t pin_state)
relay2_relay2Control
digital_out_t pwm
Definition: relay2.h:81
pin_name_t an
Definition: relay2.h:92
Click ctx object definition.
Definition: relay2.h:76
Click configuration structure definition.
Definition: relay2.h:88
void relay2_relay2_control(relay2_t *ctx, uint8_t pin_state)
relay2_relay2Control
digital_out_t an
Definition: relay2.h:80
pin_name_t pwm
Definition: relay2.h:93
#define RELAY2_RETVAL
Definition: relay2.h:60
void relay2_cfg_setup(relay2_cfg_t *cfg)
Config Object Initialization function.