ireclipse2  2.1.0.0
Data Structures | Macros | Enumerations | Functions
ireclipse2.h File Reference

This file contains API for IR Eclipse 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  ireclipse2_t
 IR Eclipse 2 Click context object. More...
 
struct  ireclipse2_cfg_t
 IR Eclipse 2 Click configuration object. More...
 

Macros

#define IRECLIPSE2_STATE_NO_ECLIPSE   0
 IR Eclipse 2 description setting. More...
 
#define IRECLIPSE2_STATE_ECLIPSE   1
 
#define IRECLIPSE2_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  ireclipse2_return_value_t { IRECLIPSE2_OK = 0, IRECLIPSE2_ERROR = -1 }
 IR Eclipse 2 Click return value data. More...
 

Functions

void ireclipse2_cfg_setup (ireclipse2_cfg_t *cfg)
 IR Eclipse 2 configuration object setup function. More...
 
err_t ireclipse2_init (ireclipse2_t *ctx, ireclipse2_cfg_t *cfg)
 IR Eclipse 2 initialization function. More...
 
void ireclipse2_enable (ireclipse2_t *ctx)
 IR Eclipse 2 enable function. More...
 
void ireclipse2_disable (ireclipse2_t *ctx)
 IR Eclipse 2 disable function. More...
 
uint8_t ireclipse2_get_state (ireclipse2_t *ctx)
 IR Eclipse 2 get state function. More...
 

Detailed Description

This file contains API for IR Eclipse 2 Click Driver.

Enumeration Type Documentation

◆ ireclipse2_return_value_t

IR Eclipse 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
IRECLIPSE2_OK 
IRECLIPSE2_ERROR