relay2
2.0.0.0
cmake
relay2
lib_relay2
include
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
42
#ifdef PREINIT_SUPPORTED
43
#include "preinit.h"
44
#endif
45
46
#ifdef MikroCCoreVersion
47
#if MikroCCoreVersion >= 1
48
#include "delays.h"
49
#endif
50
#endif
51
52
#include "drv_digital_out.h"
53
#include "drv_digital_in.h"
54
55
// -------------------------------------------------------------- PUBLIC MACROS
65
#define RELAY2_MAP_MIKROBUS( cfg, mikrobus ) \
66
cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
67
cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM );
68
74
#define RELAY2_RETVAL uint8_t
75
76
#define RELAY2_OK 0x70
77
#define RELAY2_INIT_ERROR 0xFF
78
// End group macro
81
// --------------------------------------------------------------- PUBLIC TYPES
90
typedef
struct
91
{
92
// Output pins
93
94
digital_out_t
an
;
95
digital_out_t
pwm
;
96
97
}
relay2_t
;
98
102
typedef
struct
103
{
104
// Additional gpio pins
105
106
pin_name_t
an
;
107
pin_name_t
pwm
;
108
109
}
relay2_cfg_t
;
110
// End types group
112
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
113
119
#ifdef __cplusplus
120
extern
"C"
{
121
#endif
122
131
void
relay2_cfg_setup
(
relay2_cfg_t
*cfg );
132
140
RELAY2_RETVAL
relay2_init
(
relay2_t
*ctx,
relay2_cfg_t
*cfg );
141
150
void
relay2_relay2_control
(
relay2_t
*ctx, uint8_t pin_state );
151
161
void
relay2_relay1_control
(
relay2_t
*ctx, uint8_t pin_state );
162
163
#ifdef __cplusplus
164
}
165
#endif
166
#endif // _RELAY2_H_
167
// End public_function group
170
171
// ------------------------------------------------------------------------- END
relay2_t
Click ctx object definition.
Definition:
relay2.h:91
relay2_cfg_t::pwm
pin_name_t pwm
Definition:
relay2.h:107
relay2_t::an
digital_out_t an
Definition:
relay2.h:94
relay2_cfg_t::an
pin_name_t an
Definition:
relay2.h:106
relay2_relay1_control
void relay2_relay1_control(relay2_t *ctx, uint8_t pin_state)
relay2_relay2Control
relay2_cfg_t
Click configuration structure definition.
Definition:
relay2.h:103
relay2_init
RELAY2_RETVAL relay2_init(relay2_t *ctx, relay2_cfg_t *cfg)
Initialization function.
relay2_relay2_control
void relay2_relay2_control(relay2_t *ctx, uint8_t pin_state)
relay2_relay2Control
RELAY2_RETVAL
#define RELAY2_RETVAL
Definition:
relay2.h:74
relay2_cfg_setup
void relay2_cfg_setup(relay2_cfg_t *cfg)
Config Object Initialization function.
relay2_t::pwm
digital_out_t pwm
Definition:
relay2.h:95
Generated by
1.8.20