irda3 2.0.0.0
irda3.h File Reference

This file contains API for IrDA 3 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  irda3_t
 IrDA 3 Click context object. More...
 
struct  irda3_cfg_t
 IrDA 3 Click configuration object. More...
 

Macros

#define DRV_BUFFER_SIZE   500
 IrDA 3 driver buffer size.
 
#define IRDA3_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  irda3_return_value_t { IRDA3_OK = 0 , IRDA3_ERROR = -1 }
 IrDA 3 Click return value data. More...
 
enum  irda3_mode_t { IRDA3_MODE_CMD = 0 , IRDA3_MODE_DATA }
 Click mode settings. More...
 
enum  irda3_pwr_t { IRDA3_PWR_OFF = 0 , IRDA3_PWR_ON }
 Click power mode settings. More...
 

Functions

void irda3_cfg_setup (irda3_cfg_t *cfg)
 IrDA 3 configuration object setup function.
 
err_t irda3_init (irda3_t *ctx, irda3_cfg_t *cfg)
 IrDA 3 initialization function.
 
void irda3_default_cfg (irda3_t *ctx)
 IrDA 3 default configuration function.
 
void irda3_mode_setup (irda3_t *ctx, irda3_mode_t state)
 Mode Setup function.
 
void irda3_pwr_setup (irda3_t *ctx, irda3_pwr_t state)
 Power Setup function.
 
void irda3_reset (irda3_t *ctx)
 Reset function.
 
void irda3_generic_multiple_send (irda3_t *ctx, char *tx_data)
 Generic Multiple Send function.
 
void irda3_generic_multiple_receive (irda3_t *ctx, char *rx_data, char termination_char)
 Generic Multiple Receive function.
 
void irda3_generic_single_send (irda3_t *ctx, char tx_data)
 Generic Single Send function.
 
char irda3_generic_single_receive (irda3_t *ctx)
 Generic Single Receive function.
 

Detailed Description

This file contains API for IrDA 3 Click Driver.

Enumeration Type Documentation

◆ irda3_mode_t

Click mode settings.

Enumerator
IRDA3_MODE_CMD 
IRDA3_MODE_DATA 

◆ irda3_pwr_t

Click power mode settings.

Enumerator
IRDA3_PWR_OFF 
IRDA3_PWR_ON 

◆ irda3_return_value_t

IrDA 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
IRDA3_OK 
IRDA3_ERROR