motion3.h File Reference

This file contains API for Motion 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	motion3_t
	Motion 3 Click context object. More...
struct	motion3_cfg_t
	Motion 3 Click configuration object. More...

Macros
#define	MOTION3_MODULE_ENABLE   0x00
	MikroBUS pin set.
#define	MOTION3_MODULE_DISABLE   0x01
#define	MOTION3_NO_DETECT_OBJECT   0x00
#define	MOTION3_DETECT_OBJECT   0x01
#define	MOTION3_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	motion3_return_value_t { MOTION3_OK = 0 , MOTION3_ERROR = -1 }
	Motion 3 Click return value data. More...
enum	motion3_detect_state_t { MOTION3_NO_DETECT = 0 , MOTION3_DETECTED }
enum	motion3_pin_state_t { MOTION3_PIN_STATE_LOW = 0 , MOTION3_PIN_STATE_HIGH }

Functions
void	motion3_cfg_setup (motion3_cfg_t *cfg)
	Motion 3 configuration object setup function.
err_t	motion3_init (motion3_t *ctx, motion3_cfg_t *cfg)
	Motion 3 initialization function.
void	motion3_enable (motion3_t *ctx, uint8_t state)
	Enable motion sensor function.
uint8_t	motion3_detect_state (motion3_t *ctx)
	Get detection state function.

Detailed Description

This file contains API for Motion 3 Click Driver.

Enumeration Type Documentation

motion3_return_value_t

enum motion3_return_value_t

Motion 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
MOTION3_OK
MOTION3_ERROR