waterdetect2.h File Reference

This file contains API for Water Detect 2 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"

Go to the source code of this file.

Data Structures
struct	waterdetect2_t
	Water Detect 2 Click context object. More...
struct	waterdetect2_cfg_t
	Water Detect 2 Click configuration object. More...

Macros
#define	WATERDETECT2_FLUID_DETECTED   0
#define	WATERDETECT2_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	waterdetect2_return_value_t { WATERDETECT2_OK = 0 , WATERDETECT2_ERROR = -1 }
	Water Detect 2 Click return value data. More...

Functions
void	waterdetect2_cfg_setup (waterdetect2_cfg_t *cfg)
	Water Detect 2 configuration object setup function.
err_t	waterdetect2_init (waterdetect2_t *ctx, waterdetect2_cfg_t *cfg)
	Water Detect 2 initialization function.
void	waterdetect2_default_cfg (waterdetect2_t *ctx)
	Water Detect 2 default configuration function.
void	waterdetect2_enable (waterdetect2_t *ctx)
	Water Detect 2 enable function.
void	waterdetect2_disable (waterdetect2_t *ctx)
	Water Detect 2 disable function.
uint8_t	waterdetect2_get_fluid_status (waterdetect2_t *ctx)
	Water Detect 2 get fluid status function.

Detailed Description

This file contains API for Water Detect 2 Click Driver.

Enumeration Type Documentation

waterdetect2_return_value_t

enum waterdetect2_return_value_t

Water Detect 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
WATERDETECT2_OK
WATERDETECT2_ERROR