irda2  2.0.0.0
Data Structures | Macros | Enumerations | Functions
irda2.h File Reference

This file contains API for IrDA 2 Click Driver. More...

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

Go to the source code of this file.

Data Structures

struct  irda2_t
 IrDA 2 Click context object. More...
 
struct  irda2_cfg_t
 IrDA 2 Click configuration object. More...
 

Macros

#define DRV_BUFFER_SIZE   500
 IrDA 2 driver buffer size. More...
 
#define IRDA2_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  irda2_return_value_t { IRDA2_OK = 0, IRDA2_ERROR = -1 }
 IrDA 2 Click return value data. More...
 
enum  irda2_mode_t { IRDA2_MODE_CMD = 0, IRDA2_MODE_DATA }
 Click mode settings. More...
 
enum  irda2_pwr_t { IRDA2_PWR_OFF = 0, IRDA2_PWR_ON }
 Click power mode settings. More...
 

Functions

void irda2_cfg_setup (irda2_cfg_t *cfg)
 IrDA 2 configuration object setup function. More...
 
err_t irda2_init (irda2_t *ctx, irda2_cfg_t *cfg)
 IrDA 2 initialization function. More...
 
void irda2_default_cfg (irda2_t *ctx)
 IrDA 2 default configuration function. More...
 
void irda2_mode_setup (irda2_t *ctx, irda2_mode_t state)
 Mode Setup function. More...
 
void irda2_pwr_setup (irda2_t *ctx, irda2_pwr_t state)
 Power Setup function. More...
 
void irda2_reset (irda2_t *ctx)
 Reset function. More...
 
void irda2_generic_multiple_send (irda2_t *ctx, char *tx_data)
 Generic Multiple Send function. More...
 
void irda2_generic_multiple_receive (irda2_t *ctx, char *rx_data, char termination_char)
 Generic Multiple Receive function. More...
 
void irda2_generic_single_send (irda2_t *ctx, char tx_data)
 Generic Single Send function. More...
 
char irda2_generic_single_receive (irda2_t *ctx)
 Generic Single Receive function. More...
 

Detailed Description

This file contains API for IrDA 2 Click Driver.

Enumeration Type Documentation

◆ irda2_mode_t

Click mode settings.

Enumerator
IRDA2_MODE_CMD 
IRDA2_MODE_DATA 

◆ irda2_pwr_t

Click power mode settings.

Enumerator
IRDA2_PWR_OFF 
IRDA2_PWR_ON 

◆ irda2_return_value_t

IrDA 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
IRDA2_OK 
IRDA2_ERROR