flame
2.0.0.0
cmake
flame
lib_flame
include
flame.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 FLAME_H
36
#define FLAME_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 FLAME_MAP_MIKROBUS( cfg, mikrobus ) \
66
cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
67
cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
68
74
#define FLAME_RETVAL uint8_t
75
76
#define FLAME_OK 0x00
77
#define FLAME_INIT_ERROR 0xFF
78
// End group macro
81
// --------------------------------------------------------------- PUBLIC TYPES
90
typedef
struct
91
{
92
93
// Input pins
94
95
digital_in_t
an
;
96
digital_in_t
int_pin
;
97
98
}
flame_t
;
99
103
typedef
struct
104
{
105
// Additional gpio pins
106
107
pin_name_t
an
;
108
pin_name_t
int_pin
;
109
110
}
flame_cfg_t
;
111
// End types group
113
114
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
115
121
#ifdef __cplusplus
122
extern
"C"
{
123
#endif
124
133
void
flame_cfg_setup
(
flame_cfg_t
*cfg );
134
142
FLAME_RETVAL
flame_init
(
flame_t
*ctx,
flame_cfg_t
*cfg );
143
150
uint8_t
flame_check_status
(
flame_t
*ctx );
151
158
uint8_t
flame_get_interrupt
(
flame_t
*ctx );
159
160
161
#ifdef __cplusplus
162
}
163
#endif
164
#endif // _FLAME_H_
165
// End public_function group
168
169
// ------------------------------------------------------------------------- END
flame_cfg_t
Click configuration structure definition.
Definition:
flame.h:104
flame_check_status
uint8_t flame_check_status(flame_t *ctx)
Check the flame status function.
flame_t
Click ctx object definition.
Definition:
flame.h:91
flame_get_interrupt
uint8_t flame_get_interrupt(flame_t *ctx)
Get interrupt status.
flame_t::an
digital_in_t an
Definition:
flame.h:95
flame_init
FLAME_RETVAL flame_init(flame_t *ctx, flame_cfg_t *cfg)
Initialization function.
flame_cfg_t::int_pin
pin_name_t int_pin
Definition:
flame.h:108
flame_t::int_pin
digital_in_t int_pin
Definition:
flame.h:96
flame_cfg_t::an
pin_name_t an
Definition:
flame.h:107
flame_cfg_setup
void flame_cfg_setup(flame_cfg_t *cfg)
Config Object Initialization function.
FLAME_RETVAL
#define FLAME_RETVAL
Definition:
flame.h:74
Generated by
1.8.20