irda2
2.0.0.0
|
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... | |
API for configuring and manipulating IrDA 2 Click driver.
void irda2_cfg_setup | ( | irda2_cfg_t * | cfg | ) |
IrDA 2 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See irda2_cfg_t object definition for detailed explanation. |
void irda2_default_cfg | ( | irda2_t * | ctx | ) |
IrDA 2 default configuration function.
This function executes a default configuration of IrDA 2 click board.
[in] | ctx | : Click context object. See irda2_t object definition for detailed explanation. |
0
- Success, -1
- Error.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.
ctx | Click object. |
rx_data | Memory where read data be stored. |
termination_char | Termination character. |
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.
ctx | Click object. |
tx_data | Data to be sent. |
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.
ctx | Click object. |
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.
ctx | Click object. |
tx_data | Data to be sent. |
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.
[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. |
0
- Success, -1
- Error.void irda2_mode_setup | ( | irda2_t * | ctx, |
irda2_mode_t | state | ||
) |
Mode Setup function.
This function allows IrDA 2 click mode to be set.
ctx | Click object. |
state | 0 - Command mode, 1 - Data mode. |
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.
ctx | Click object. |
state | 0 - Power off, 1 - Power on. |
void irda2_reset | ( | irda2_t * | ctx | ) |
Reset function.
This function executes a device reset operation.
ctx | Click object. |