waterdetect2  2.1.0.0
Main Page

Water Detect 2 click

PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU

[click Product page](CLICK_PRODUCT_PAGE_LINK)


Click library

  • Author : Nenad Filipovic
  • Date : Jul 2023.
  • Type : GPIO type

Software Support

We provide a library for the Water Detect 2 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for Water Detect 2 Click driver.

Standard key functions :

Example key functions :

Example Description

This library contains API for Water Detect 2 Click driver. Water Detect 2 click is used for detecting water and other electroconductive liquids.

The demo application is composed of two sections :

Application Init

Initializes driver and performs the default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
waterdetect2_cfg_t waterdetect2_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
waterdetect2_cfg_setup( &waterdetect2_cfg );
WATERDETECT2_MAP_MIKROBUS( waterdetect2_cfg, MIKROBUS_1 );
if ( DIGITAL_OUT_UNSUPPORTED_PIN == waterdetect2_init( &waterdetect2, &waterdetect2_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
waterdetect2_default_cfg( &waterdetect2 );
log_info( &logger, " Application Task " );
}

Application Task

Reads fluid presence status and determines if there is fluid presence or not.

void application_task ( void )
{
static uint8_t fluid_status = waterdetect2_get_fluid_status( &waterdetect2 );
if ( fluid_status != fluid_status_old )
{
if ( WATERDETECT2_FLUID_DETECTED == fluid_status )
{
log_printf( &logger, " Fluid present! \r\n" );
}
else
{
log_printf( &logger, " No fluid present. \r\n" );
}
log_printf( &logger, "------------------- \r\n" );
fluid_status_old = fluid_status;
}
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.WaterDetect2

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. UART terminal is available in all MikroElektronika compilers.


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_MAP_MIKROBUS
#define WATERDETECT2_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: waterdetect2.h:71
waterdetect2_disable
void waterdetect2_disable(waterdetect2_t *ctx)
Water Detect 2 disable function.
application_task
void application_task(void)
Definition: main.c:60
waterdetect2_enable
void waterdetect2_enable(waterdetect2_t *ctx)
Water Detect 2 enable function.
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.
application_init
void application_init(void)
Definition: main.c:29
WATERDETECT2_FLUID_DETECTED
#define WATERDETECT2_FLUID_DETECTED
Definition: waterdetect2.h:53
waterdetect2_t
Water Detect 2 Click context object.
Definition: waterdetect2.h:83