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 "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define FLAME_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
53  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
54 
60 #define FLAME_RETVAL uint8_t
61 
62 #define FLAME_OK 0x00
63 #define FLAME_INIT_ERROR 0xFF
64  // End group macro
67 // --------------------------------------------------------------- PUBLIC TYPES
76 typedef struct
77 {
78 
79  // Input pins
80 
81  digital_in_t an;
82  digital_in_t int_pin;
83 
84 } flame_t;
85 
89 typedef struct
90 {
91  // Additional gpio pins
92 
93  pin_name_t an;
94  pin_name_t int_pin;
95 
96 } flame_cfg_t;
97  // End types group
99 
100 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
101 
107 #ifdef __cplusplus
108 extern "C"{
109 #endif
110 
119 void flame_cfg_setup ( flame_cfg_t *cfg );
120 
129 
136 uint8_t flame_check_status ( flame_t *ctx );
137 
144 uint8_t flame_get_interrupt ( flame_t *ctx );
145 
146 
147 #ifdef __cplusplus
148 }
149 #endif
150 #endif // _FLAME_H_
151  // End public_function group
154 
155 // ------------------------------------------------------------------------- END
flame_cfg_t
Click configuration structure definition.
Definition: flame.h:89
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:76
flame_get_interrupt
uint8_t flame_get_interrupt(flame_t *ctx)
Get interrupt status.
flame_t::an
digital_in_t an
Definition: flame.h:81
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:94
flame_t::int_pin
digital_in_t int_pin
Definition: flame.h:82
flame_cfg_t::an
pin_name_t an
Definition: flame.h:93
flame_cfg_setup
void flame_cfg_setup(flame_cfg_t *cfg)
Config Object Initialization function.
FLAME_RETVAL
#define FLAME_RETVAL
Definition: flame.h:60