irda2  2.0.0.0
Modules | Functions
IrDA 2 Click Driver

API for configuring and manipulating IrDA 2 Click driver. More...

Modules

 IrDA 2 Device Settings
 Settings for registers of IrDA 2 Click driver.
 
 IrDA 2 MikroBUS Map
 MikroBUS pin mapping of IrDA 2 Click driver.
 

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

API for configuring and manipulating IrDA 2 Click driver.

Function Documentation

◆ irda2_cfg_setup()

void irda2_cfg_setup ( irda2_cfg_t cfg)

IrDA 2 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See irda2_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ irda2_default_cfg()

void irda2_default_cfg ( irda2_t ctx)

IrDA 2 default configuration function.

This function executes a default configuration of IrDA 2 click board.

Parameters
[in]ctx: Click context object. See irda2_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ irda2_generic_multiple_receive()

void irda2_generic_multiple_receive ( irda2_t ctx,
char *  rx_data,
char  termination_char 
)

Generic Multiple Receive function.

This function allows data receiving operation of multiple data bytes to be performed.

Parameters
ctxClick object.
rx_dataMemory where read data be stored.
termination_charTermination character.
Returns
Nothing
Note
The function will receive data bytes from the device until termination character was received. At the end of the received data buffer, this function will add '\0' character.

◆ irda2_generic_multiple_send()

void irda2_generic_multiple_send ( irda2_t ctx,
char *  tx_data 
)

Generic Multiple Send function.

This function allows data sending operation of multiple data bytes to be performed.

Parameters
ctxClick object.
tx_dataData to be sent.
Returns
Nothing
Note
None.

◆ irda2_generic_single_receive()

char irda2_generic_single_receive ( irda2_t ctx)

Generic Single Receive function.

This function allows data receiving operation of single data byte to be performed.

Parameters
ctxClick object.
Returns
Received data byte.
Note
None.

◆ irda2_generic_single_send()

void irda2_generic_single_send ( irda2_t ctx,
char  tx_data 
)

Generic Single Send function.

This function allows data sending operation of single data byte to be performed.

Parameters
ctxClick object.
tx_dataData to be sent.
Returns
Nothing
Note
None.

◆ irda2_init()

err_t irda2_init ( irda2_t ctx,
irda2_cfg_t cfg 
)

IrDA 2 initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters
[out]ctx: Click context object. See irda2_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See irda2_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ irda2_mode_setup()

void irda2_mode_setup ( irda2_t ctx,
irda2_mode_t  state 
)

Mode Setup function.

This function allows IrDA 2 click mode to be set.

Parameters
ctxClick object.
state0 - Command mode, 1 - Data mode.
Returns
Nothing
Note
None.

◆ irda2_pwr_setup()

void irda2_pwr_setup ( irda2_t ctx,
irda2_pwr_t  state 
)

Power Setup function.

This function allows IrDA 2 click power mode to be set.

Parameters
ctxClick object.
state0 - Power off, 1 - Power on.
Returns
Nothing
Note
None.

◆ irda2_reset()

void irda2_reset ( irda2_t ctx)

Reset function.

This function executes a device reset operation.

Parameters
ctxClick object.
Returns
Nothing
Note
After the reset operation was done, the device will be returned back to normal mode.