waterdetect3  2.1.0.0
waterdetect3.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef WATERDETECT3_H
29 #define WATERDETECT3_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 
67 #define WATERDETECT3_PIN_STATE_HIGH 0x01
68 #define WATERDETECT3_PIN_STATE_LOW 0x00
69  // waterdetect3_set
71 
86 #define WATERDETECT3_MAP_MIKROBUS( cfg, mikrobus ) \
87  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
88  // waterdetect3_map // waterdetect3
91 
96 typedef struct
97 {
98  digital_in_t int_pin;
101 
106 typedef struct
107 {
108  pin_name_t int_pin;
111 
116 typedef enum
117 {
119  WATERDETECT3_ERROR = -1
120 
122 
139 
154 
166 
167 #ifdef __cplusplus
168 }
169 #endif
170 #endif // WATERDETECT3_H
171  // waterdetect3
173 
174 // ------------------------------------------------------------------------ END
waterdetect3_t
Water Detect 3 Click context object.
Definition: waterdetect3.h:97
waterdetect3_t::int_pin
digital_in_t int_pin
Definition: waterdetect3.h:98
waterdetect3_cfg_t::int_pin
pin_name_t int_pin
Definition: waterdetect3.h:108
waterdetect3_init
err_t waterdetect3_init(waterdetect3_t *ctx, waterdetect3_cfg_t *cfg)
Water Detect 3 initialization function.
waterdetect3_cfg_t
Water Detect 3 Click configuration object.
Definition: waterdetect3.h:107
WATERDETECT3_ERROR
@ WATERDETECT3_ERROR
Definition: waterdetect3.h:119
WATERDETECT3_OK
@ WATERDETECT3_OK
Definition: waterdetect3.h:118
waterdetect3_return_value_t
waterdetect3_return_value_t
Water Detect 3 Click return value data.
Definition: waterdetect3.h:117
waterdetect3_cfg_setup
void waterdetect3_cfg_setup(waterdetect3_cfg_t *cfg)
Water Detect 3 configuration object setup function.
waterdetect3_get_int
uint8_t waterdetect3_get_int(waterdetect3_t *ctx)
Water Detect 3 interrupt pin reading function.