waterdetect2  2.1.0.0
waterdetect2.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 WATERDETECT2_H
29 #define WATERDETECT2_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 
53 #define WATERDETECT2_FLUID_DETECTED 0
54  // waterdetect2_get
56 
71 #define WATERDETECT2_MAP_MIKROBUS( cfg, mikrobus ) \
72  cfg.on = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
73  cfg.det = MIKROBUS( mikrobus, MIKROBUS_INT )
74  // waterdetect2_map // waterdetect2
77 
82 typedef struct
83 {
84  digital_out_t on;
85  digital_in_t det;
88 
93 typedef struct
94 {
95  pin_name_t on;
96  pin_name_t det;
99 
104 typedef enum
105 {
107  WATERDETECT2_ERROR = -1
108 
110 
127 
142 
154 
165 
176 
188 
189 #ifdef __cplusplus
190 }
191 #endif
192 #endif // WATERDETECT2_H
193  // waterdetect2
195 
196 // ------------------------------------------------------------------------ END
waterdetect2_cfg_t::on
pin_name_t on
Definition: waterdetect2.h:95
waterdetect2_cfg_t
Water Detect 2 Click configuration object.
Definition: waterdetect2.h:94
waterdetect2_cfg_setup
void waterdetect2_cfg_setup(waterdetect2_cfg_t *cfg)
Water Detect 2 configuration object setup function.
waterdetect2_get_fluid_status
uint8_t waterdetect2_get_fluid_status(waterdetect2_t *ctx)
Water Detect 2 get fluid status function.
waterdetect2_disable
void waterdetect2_disable(waterdetect2_t *ctx)
Water Detect 2 disable function.
waterdetect2_cfg_t::det
pin_name_t det
Definition: waterdetect2.h:96
waterdetect2_enable
void waterdetect2_enable(waterdetect2_t *ctx)
Water Detect 2 enable function.
waterdetect2_t::det
digital_in_t det
Definition: waterdetect2.h:85
WATERDETECT2_OK
@ WATERDETECT2_OK
Definition: waterdetect2.h:106
waterdetect2_init
err_t waterdetect2_init(waterdetect2_t *ctx, waterdetect2_cfg_t *cfg)
Water Detect 2 initialization function.
waterdetect2_default_cfg
void waterdetect2_default_cfg(waterdetect2_t *ctx)
Water Detect 2 default configuration function.
WATERDETECT2_ERROR
@ WATERDETECT2_ERROR
Definition: waterdetect2.h:107
waterdetect2_return_value_t
waterdetect2_return_value_t
Water Detect 2 Click return value data.
Definition: waterdetect2.h:105
waterdetect2_t::on
digital_out_t on
Definition: waterdetect2.h:84
waterdetect2_t
Water Detect 2 Click context object.
Definition: waterdetect2.h:83