waterdetect  2.0.0.0
waterdetect.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 WATERDETECT_H
36 #define WATERDETECT_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define WATERDETECT_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT );
53 
59 #define WATERDETECT_RETVAL uint8_t
60 
61 #define WATERDETECT_OK 0x00
62 #define WATERDETECT_INIT_ERROR 0xFF
63  // End group macro
66 // --------------------------------------------------------------- PUBLIC TYPES
75 typedef struct
76 {
77  // Input pins
78 
79  digital_in_t int_pin;
80 
82 
86 typedef struct
87 {
88  // Additional gpio pins
89 
90  pin_name_t int_pin;
91 
93  // End types group
95 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
96 
102 #ifdef __cplusplus
103 extern "C"{
104 #endif
105 
115 
124 
133 
146 uint8_t waterdetect_get_status ( waterdetect_t *ctx );
147 
148 #ifdef __cplusplus
149 }
150 #endif
151 #endif // _WATERDETECT_H_
152  // End public_function group
155 
156 // ------------------------------------------------------------------------- END
waterdetect_default_cfg
void waterdetect_default_cfg(waterdetect_t *ctx)
Click Default Configuration function.
waterdetect_t
Click ctx object definition.
Definition: waterdetect.h:75
waterdetect_t::int_pin
digital_in_t int_pin
Definition: waterdetect.h:79
waterdetect_cfg_t::int_pin
pin_name_t int_pin
Definition: waterdetect.h:90
waterdetect_cfg_t
Click configuration structure definition.
Definition: waterdetect.h:86
waterdetect_cfg_setup
void waterdetect_cfg_setup(waterdetect_cfg_t *cfg)
Config Object Initialization function.
waterdetect_init
WATERDETECT_RETVAL waterdetect_init(waterdetect_t *ctx, waterdetect_cfg_t *cfg)
Initialization function.
WATERDETECT_RETVAL
#define WATERDETECT_RETVAL
Definition: waterdetect.h:59
waterdetect_get_status
uint8_t waterdetect_get_status(waterdetect_t *ctx)
Get the status of the water detection function.