flame  2.0.0.0
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 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 
51 // -------------------------------------------------------------- PUBLIC MACROS
61 #define FLAME_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
63  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
64 
70 #define FLAME_RETVAL uint8_t
71 
72 #define FLAME_OK 0x00
73 #define FLAME_INIT_ERROR 0xFF
74  // End group macro
77 // --------------------------------------------------------------- PUBLIC TYPES
86 typedef struct
87 {
88 
89  // Input pins
90 
91  digital_in_t an;
92  digital_in_t int_pin;
93 
94 } flame_t;
95 
99 typedef struct
100 {
101  // Additional gpio pins
102 
103  pin_name_t an;
104  pin_name_t int_pin;
105 
106 } flame_cfg_t;
107  // End types group
109 
110 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
111 
117 #ifdef __cplusplus
118 extern "C"{
119 #endif
120 
130 
139 
146 uint8_t flame_check_status ( flame_t *ctx );
147 
154 uint8_t flame_get_interrupt ( flame_t *ctx );
155 
156 
157 #ifdef __cplusplus
158 }
159 #endif
160 #endif // _FLAME_H_
161  // End public_function group
164 
165 // ------------------------------------------------------------------------- END
flame_cfg_t
Click configuration structure definition.
Definition: flame.h:100
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:87
flame_get_interrupt
uint8_t flame_get_interrupt(flame_t *ctx)
Get interrupt status.
flame_t::an
digital_in_t an
Definition: flame.h:91
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:104
flame_t::int_pin
digital_in_t int_pin
Definition: flame.h:92
flame_cfg_t::an
pin_name_t an
Definition: flame.h:103
flame_cfg_setup
void flame_cfg_setup(flame_cfg_t *cfg)
Config Object Initialization function.
FLAME_RETVAL
#define FLAME_RETVAL
Definition: flame.h:70