ismrx 2.0.0.0
Topics | Functions
ISM RX Click Driver

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

Topics

 ISM RX Registers List
 List of registers of ISM RX Click driver.
 
 ISM RX Registers Settings
 Settings for registers of ISM RX Click driver.
 
 ISM RX MikroBUS Map
 MikroBUS pin mapping of ISM RX Click driver.
 

Functions

void ismrx_cfg_setup (ismrx_cfg_t *cfg)
 ISM RX configuration object setup function.
 
err_t ismrx_init (ismrx_t *ctx, ismrx_cfg_t *cfg)
 ISM RX initialization function.
 
err_t ismrx_task_init (ismrx_t *ctx, ismrx_cfg_t *cfg)
 ISM RX initialization function.
 
err_t ismrx_default_cfg (ismrx_t *ctx)
 ISM RX default configuration function.
 
err_t ismrx_generic_write (ismrx_t *ctx, uint8_t reg, uint8_t data_in)
 ISM RX data writing function.
 
err_t ismrx_generic_read (ismrx_t *ctx, uint8_t reg, uint8_t *data_out)
 ISM RX data reading function.
 
err_t ismrx_master_reset (ismrx_t *ctx)
 ISM RX software reset.
 
void ismrx_start_drx (ismrx_t *ctx)
 ISM RX start receiving signal.
 
void ismrx_stop_drx (ismrx_t *ctx)
 ISM RX stop receiving signal.
 
uint8_t ismrx_get_data (ismrx_t *ctx)
 ISM RX get miso pin state.
 

Detailed Description

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

◆ ismrx_cfg_setup()

void ismrx_cfg_setup ( ismrx_cfg_t * cfg)

ISM RX configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ ismrx_default_cfg()

err_t ismrx_default_cfg ( ismrx_t * ctx)

ISM RX default configuration function.

This function executes a default configuration of ISM RX. click board.

Parameters
[in]ctx: Click context object. See ismrx_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.

◆ ismrx_generic_read()

err_t ismrx_generic_read ( ismrx_t * ctx,
uint8_t reg,
uint8_t * data_out )

ISM RX data reading function.

This function reads a desired number of data bytes starting from the selected register by using SPI serial interface.

Parameters
[in]ctx: Click context object. See ismrx_t object definition for detailed explanation.
[in]reg: Start register address.
[out]data_out: Output read byte.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ ismrx_generic_write()

err_t ismrx_generic_write ( ismrx_t * ctx,
uint8_t reg,
uint8_t data_in )

ISM RX data writing function.

This function writes a desired number of data bytes starting from the selected register by using SPI serial interface.

Parameters
[in]ctx: Click context object. See ismrx_t object definition for detailed explanation.
[in]reg: Start register address.
[in]data_in: Byte to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ ismrx_get_data()

uint8_t ismrx_get_data ( ismrx_t * ctx)

ISM RX get miso pin state.

This function get's miso pin state.

Parameters
[in]ctx: Click context object. See ismrx_t object definition for detailed explanation.
Returns
miso pin state.

◆ ismrx_init()

err_t ismrx_init ( ismrx_t * ctx,
ismrx_cfg_t * cfg )

ISM RX initialization function.

This function initializes spi module for device configuration.

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

◆ ismrx_master_reset()

err_t ismrx_master_reset ( ismrx_t * ctx)

ISM RX software reset.

This sends command for resetting device.

Parameters
[in]ctx: Click context object. See ismrx_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
There is a 1 second delay after the reset command is sent.

◆ ismrx_start_drx()

void ismrx_start_drx ( ismrx_t * ctx)

ISM RX start receiving signal.

This function adjust device to start receiving signal in discontinuous mode.

Parameters
[in]ctx: Click context object. See ismrx_t object definition for detailed explanation.
Returns
Nothing.

◆ ismrx_stop_drx()

void ismrx_stop_drx ( ismrx_t * ctx)

ISM RX stop receiving signal.

This function adjust device to stop receiving signal in discontinuous mode.

Parameters
[in]ctx: Click context object. See ismrx_t object definition for detailed explanation.
Returns
Nothing.

◆ ismrx_task_init()

err_t ismrx_task_init ( ismrx_t * ctx,
ismrx_cfg_t * cfg )

ISM RX initialization function.

This function closes spi module and initializes data pin as GPIO.

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