flicker
2.0.0.0
clicks
flicker
lib
include
flicker.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 FLICKER_H
36
#define FLICKER_H
37
38
#include "drv_digital_out.h"
39
#include "drv_digital_in.h"
40
41
// -------------------------------------------------------------- PUBLIC MACROS
51
#define FLICKER_MAP_MIKROBUS( cfg, mikrobus ) \
52
cfg.fon= MIKROBUS( mikrobus, MIKROBUS_RST );
53
59
#define FLICKER_RETVAL uint8_t
60
61
#define FLICKER_OK 0x00
62
#define FLICKER_INIT_ERROR 0xFF
63
// End group macro
66
// --------------------------------------------------------------- PUBLIC TYPES
75
typedef
struct
76
{
77
// Output pins
78
79
digital_out_t
fon
;
80
81
}
flicker_t
;
82
86
typedef
struct
87
{
88
// Additional gpio pins
89
90
pin_name_t
fon
;
91
92
}
flicker_cfg_t
;
93
// End types group
95
96
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
97
103
#ifdef __cplusplus
104
extern
"C"
{
105
#endif
106
114
void
flicker_cfg_setup
(
flicker_cfg_t
*cfg );
115
123
FLICKER_RETVAL
flicker_init
(
flicker_t
*ctx,
flicker_cfg_t
*cfg );
124
132
void
flicker_engage
(
flicker_t
*ctx );
133
134
#ifdef __cplusplus
135
}
136
#endif
137
#endif // _FLICKER_H_
138
// End public_function group
141
142
// ------------------------------------------------------------------------- END
flicker_cfg_t
Click configuration structure definition.
Definition:
flicker.h:86
FLICKER_RETVAL
#define FLICKER_RETVAL
Definition:
flicker.h:59
flicker_init
FLICKER_RETVAL flicker_init(flicker_t *ctx, flicker_cfg_t *cfg)
Initialization function.
flicker_engage
void flicker_engage(flicker_t *ctx)
Flicker engage function.
flicker_cfg_t::fon
pin_name_t fon
Definition:
flicker.h:90
flicker_t::fon
digital_out_t fon
Definition:
flicker.h:79
flicker_cfg_setup
void flicker_cfg_setup(flicker_cfg_t *cfg)
Config Object Initialization function..
flicker_t
Click ctx object definition.
Definition:
flicker.h:75
Generated by
1.8.16