waterdetect3.h File Reference

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

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

Go to the source code of this file.

Data Structures
struct	waterdetect3_t
	Water Detect 3 Click context object. More...
struct	waterdetect3_cfg_t
	Water Detect 3 Click configuration object. More...

Macros
#define	WATERDETECT3_PIN_STATE_HIGH   0x01
	Water Detect 3 description setting.
#define	WATERDETECT3_PIN_STATE_LOW   0x00
#define	WATERDETECT3_MAP_MIKROBUS(cfg, mikrobus)    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
	MikroBUS pin mapping.

Enumerations
enum	waterdetect3_return_value_t { WATERDETECT3_OK = 0 , WATERDETECT3_ERROR = -1 }
	Water Detect 3 Click return value data. More...

Functions
void	waterdetect3_cfg_setup (waterdetect3_cfg_t *cfg)
	Water Detect 3 configuration object setup function.
err_t	waterdetect3_init (waterdetect3_t *ctx, waterdetect3_cfg_t *cfg)
	Water Detect 3 initialization function.
uint8_t	waterdetect3_get_int (waterdetect3_t *ctx)
	Water Detect 3 interrupt pin reading function.

Detailed Description

This file contains API for Water Detect 3 Click Driver.

Enumeration Type Documentation

waterdetect3_return_value_t

enum waterdetect3_return_value_t

Water Detect 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
WATERDETECT3_OK
WATERDETECT3_ERROR