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 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 
63 #define WATERDETECT3_PIN_STATE_HIGH 0x01
64 #define WATERDETECT3_PIN_STATE_LOW 0x00
65  // waterdetect3_set
67 
82 #define WATERDETECT3_MAP_MIKROBUS( cfg, mikrobus ) \
83  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
84  // waterdetect3_map // waterdetect3
87 
92 typedef struct
93 {
94  digital_in_t int_pin;
97 
102 typedef struct
103 {
104  pin_name_t int_pin;
107 
112 typedef enum
113 {
115  WATERDETECT3_ERROR = -1
116 
118 
135 
150 
162 
163 #ifdef __cplusplus
164 }
165 #endif
166 #endif // WATERDETECT3_H
167  // waterdetect3
169 
170 // ------------------------------------------------------------------------ END
waterdetect3_t
Water Detect 3 Click context object.
Definition: waterdetect3.h:93
waterdetect3_t::int_pin
digital_in_t int_pin
Definition: waterdetect3.h:94
waterdetect3_cfg_t::int_pin
pin_name_t int_pin
Definition: waterdetect3.h:104
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:103
WATERDETECT3_ERROR
@ WATERDETECT3_ERROR
Definition: waterdetect3.h:115
WATERDETECT3_OK
@ WATERDETECT3_OK
Definition: waterdetect3.h:114
waterdetect3_return_value_t
waterdetect3_return_value_t
Water Detect 3 Click return value data.
Definition: waterdetect3.h:113
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.