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	IRDA2_TX_DRV_BUFFER_SIZE   100
	IrDA 2 driver buffer size.
#define	IRDA2_RX_DRV_BUFFER_SIZE   300
#define	IRDA2_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

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.
err_t	irda2_init (irda2_t *ctx, irda2_cfg_t *cfg)
	IrDA 2 initialization function.
void	irda2_default_cfg (irda2_t *ctx)
	IrDA 2 default configuration function.
void	irda2_mode_setup (irda2_t *ctx, irda2_mode_t state)
	Mode Setup function.
void	irda2_pwr_setup (irda2_t *ctx, irda2_pwr_t state)
	Power Setup function.
void	irda2_reset (irda2_t *ctx)
	Reset function.
err_t	irda2_generic_write (irda2_t *ctx, uint8_t *data_in, uint16_t len)
	IrDA 2 data writing function.
err_t	irda2_generic_read (irda2_t *ctx, uint8_t *data_out, uint16_t len)
	IrDA 2 data reading function.

Detailed Description

This file contains API for IrDA 2 Click Driver.

Enumeration Type Documentation

irda2_mode_t

enum irda2_mode_t

Click mode settings.

Enumerator
IRDA2_MODE_CMD
IRDA2_MODE_DATA

irda2_pwr_t

enum irda2_pwr_t

Click power mode settings.

Enumerator
IRDA2_PWR_OFF
IRDA2_PWR_ON

irda2_return_value_t

enum irda2_return_value_t

IrDA 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
IRDA2_OK
IRDA2_ERROR