zerocross.h File Reference

This file contains API for Zero-Cross Click Driver. More...

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

Go to the source code of this file.

Data Structures
struct	zerocross_t
	Zero-Cross Click context object. More...
struct	zerocross_cfg_t
	Zero-Cross Click configuration object. More...

Macros
#define	ZEROCROSS_PIN_STATE_LOW   0x00
	Zero-Cross description setting.
#define	ZEROCROSS_PIN_STATE_HIGH   0x01
#define	ZEROCROSS_MAP_MIKROBUS(cfg, mikrobus)    cfg.zc = MIKROBUS( mikrobus, MIKROBUS_INT )
	MikroBUS pin mapping.

Enumerations
enum	zerocross_return_value_t { ZEROCROSS_OK = 0 , ZEROCROSS_ERROR = -1 }
	Zero-Cross Click return value data. More...

Functions
void	zerocross_cfg_setup (zerocross_cfg_t *cfg)
	Zero-Cross configuration object setup function.
err_t	zerocross_init (zerocross_t *ctx, zerocross_cfg_t *cfg)
	Zero-Cross initialization function.
uint8_t	zerocross_pin_read (zerocross_t *ctx)
	Zero-Cross pin reading function.
void	zerocross_get_freq (zerocross_t *ctx, float *freq)
	Zero-Cross frequency reading function.

Detailed Description

This file contains API for Zero-Cross Click Driver.

Enumeration Type Documentation

zerocross_return_value_t

enum zerocross_return_value_t

Zero-Cross Click return value data.

Predefined enum values for driver return values.

Enumerator
ZEROCROSS_OK
ZEROCROSS_ERROR