micrftx  2.1.0.0
Modules | Functions
MICRF TX Click Driver

API for configuring and manipulating MICRF TX Click driver. More...

Modules

 MICRF TX Settings
 Settings for configuration of MICRF TX Click driver.
 
 MICRF TX MikroBUS Map
 MikroBUS pin mapping of MICRF TX Click driver.
 

Functions

void micrftx_cfg_setup (micrftx_cfg_t *cfg)
 MICRF TX configuration object setup function. More...
 
err_t micrftx_init (micrftx_t *ctx, micrftx_cfg_t *cfg)
 MICRF TX initialization function. More...
 
void micrftx_set_data_pin (micrftx_t *ctx)
 MICRF TX set data pin function. More...
 
void micrftx_clear_data_pin (micrftx_t *ctx)
 MICRF TX clear data pin function. More...
 
void micrftx_enable_device (micrftx_t *ctx)
 MICRF TX enable device function. More...
 
void micrftx_disable_device (micrftx_t *ctx)
 MICRF TX disable device function. More...
 
uint8_t micrftx_get_clock_pin (micrftx_t *ctx)
 MICRF TX get clock pin function. More...
 

Detailed Description

API for configuring and manipulating MICRF TX Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ micrftx_cfg_setup()

void micrftx_cfg_setup ( micrftx_cfg_t cfg)

MICRF TX configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ micrftx_clear_data_pin()

void micrftx_clear_data_pin ( micrftx_t ctx)

MICRF TX clear data pin function.

This function clears the data pin to low logic state.

Parameters
[in]ctx: Click context object. See micrftx_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ micrftx_disable_device()

void micrftx_disable_device ( micrftx_t ctx)

MICRF TX disable device function.

This function disables device by setting the EN pin to low logic state.

Parameters
[in]ctx: Click context object. See micrftx_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ micrftx_enable_device()

void micrftx_enable_device ( micrftx_t ctx)

MICRF TX enable device function.

This function enables device by setting the EN pin to high logic state.

Parameters
[in]ctx: Click context object. See micrftx_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ micrftx_get_clock_pin()

uint8_t micrftx_get_clock_pin ( micrftx_t ctx)

MICRF TX get clock pin function.

This function returns the clock pin logic state.

Parameters
[in]ctx: Click context object. See micrftx_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ micrftx_init()

err_t micrftx_init ( micrftx_t ctx,
micrftx_cfg_t cfg 
)

MICRF TX initialization function.

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

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

◆ micrftx_set_data_pin()

void micrftx_set_data_pin ( micrftx_t ctx)

MICRF TX set data pin function.

This function sets the data pin to high logic state.

Parameters
[in]ctx: Click context object. See micrftx_t object definition for detailed explanation.
Returns
None.
Note
None.