micrfrx  2.1.0.0
Modules | Functions
MICRF RX Click Driver

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

Modules

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

Functions

void micrfrx_cfg_setup (micrfrx_cfg_t *cfg)
 MICRF RX configuration object setup function. More...
 
err_t micrfrx_init (micrfrx_t *ctx, micrfrx_cfg_t *cfg)
 MICRF RX initialization function. More...
 
void micrfrx_enable_squelch (micrfrx_t *ctx)
 MICRF RX enable squelch function. More...
 
void micrfrx_disable_squelch (micrfrx_t *ctx)
 MICRF RX disable squelch function. More...
 
void micrfrx_enable_device (micrfrx_t *ctx)
 MICRF RX enable device function. More...
 
void micrfrx_disable_device (micrfrx_t *ctx)
 MICRF RX disable device function. More...
 
uint8_t micrfrx_get_data_pin (micrfrx_t *ctx)
 MICRF RX get data pin function. More...
 
err_t micrfrx_read_rssi_voltage (micrfrx_t *ctx, float *data_out)
 MICRF RX read RSSI pin voltage level function. More...
 

Detailed Description

API for configuring and manipulating MICRF RX 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

◆ micrfrx_cfg_setup()

void micrfrx_cfg_setup ( micrfrx_cfg_t cfg)

MICRF RX configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ micrfrx_disable_device()

void micrfrx_disable_device ( micrfrx_t ctx)

MICRF RX disable device function.

This function disables device by setting the SHD pin to high logic state.

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

◆ micrfrx_disable_squelch()

void micrfrx_disable_squelch ( micrfrx_t ctx)

MICRF RX disable squelch function.

This function disables squelch by setting the SQC pin to high logic state.

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

◆ micrfrx_enable_device()

void micrfrx_enable_device ( micrfrx_t ctx)

MICRF RX enable device function.

This function enables device by setting the SHD pin to low logic state.

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

◆ micrfrx_enable_squelch()

void micrfrx_enable_squelch ( micrfrx_t ctx)

MICRF RX enable squelch function.

This function enables squelch by setting the SQC pin to low logic state.

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

◆ micrfrx_get_data_pin()

uint8_t micrfrx_get_data_pin ( micrfrx_t ctx)

MICRF RX get data pin function.

This function returns the DOUT pin logic state.

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

◆ micrfrx_init()

err_t micrfrx_init ( micrfrx_t ctx,
micrfrx_cfg_t cfg 
)

MICRF RX initialization function.

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

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

◆ micrfrx_read_rssi_voltage()

err_t micrfrx_read_rssi_voltage ( micrfrx_t ctx,
float *  data_out 
)

MICRF RX read RSSI pin voltage level function.

This function reads results of AD conversion of the RSSI pin and converts them to proportional voltage level.

Parameters
[in]ctx: Click context object. See micrfrx_t object definition for detailed explanation.
[out]data_out: Output voltage level of the analog pin [V].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
The conversion to voltage depends on the entered configuration of the ADC (resolution, reference voltage).