ismrx
2.0.0.0
|
API for configuring and manipulating ISM RX Click driver. More...
Modules | |
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. More... | |
err_t | ismrx_init (ismrx_t *ctx, ismrx_cfg_t *cfg) |
ISM RX initialization function. More... | |
err_t | ismrx_task_init (ismrx_t *ctx, ismrx_cfg_t *cfg) |
ISM RX initialization function. More... | |
err_t | ismrx_default_cfg (ismrx_t *ctx) |
ISM RX default configuration function. More... | |
err_t | ismrx_generic_write (ismrx_t *ctx, uint8_t reg, uint8_t data_in) |
ISM RX data writing function. More... | |
err_t | ismrx_generic_read (ismrx_t *ctx, uint8_t reg, uint8_t *data_out) |
ISM RX data reading function. More... | |
err_t | ismrx_master_reset (ismrx_t *ctx) |
ISM RX software reset. More... | |
void | ismrx_start_drx (ismrx_t *ctx) |
ISM RX start receiving signal. More... | |
void | ismrx_stop_drx (ismrx_t *ctx) |
ISM RX stop receiving signal. More... | |
uint8_t | ismrx_get_data (ismrx_t *ctx) |
ISM RX get miso pin state. More... | |
API for configuring and manipulating ISM RX Click driver.
void ismrx_cfg_setup | ( | ismrx_cfg_t * | cfg | ) |
ISM RX configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See ismrx_cfg_t object definition for detailed explanation. |
err_t ismrx_default_cfg | ( | ismrx_t * | ctx | ) |
ISM RX default configuration function.
This function executes a default configuration of ISM RX. click board.
[in] | ctx | : Click context object. See ismrx_t object definition for detailed explanation. |
0
- Success, -1
- Error.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.
[in] | ctx | : Click context object. See ismrx_t object definition for detailed explanation. |
[in] | reg | : Start register address. |
[out] | data_out | : Output read byte. |
0
- Success, -1
- Error.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.
[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. |
0
- Success, -1
- Error.uint8_t ismrx_get_data | ( | ismrx_t * | ctx | ) |
ISM RX get miso pin state.
This function get's miso pin state.
[in] | ctx | : Click context object. See ismrx_t object definition for detailed explanation. |
err_t ismrx_init | ( | ismrx_t * | ctx, |
ismrx_cfg_t * | cfg | ||
) |
ISM RX initialization function.
This function initializes spi module for device configuration.
[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. |
0
- Success, -1
- Error.err_t ismrx_master_reset | ( | ismrx_t * | ctx | ) |
ISM RX software reset.
This sends command for reseting device.
[in] | ctx | : Click context object. See ismrx_t object definition for detailed explanation. |
0
- Success, -1
- Error.void ismrx_start_drx | ( | ismrx_t * | ctx | ) |
ISM RX start receiving signal.
This function adjust device to start receiving signal in discontinuous mode.
[in] | ctx | : Click context object. See ismrx_t object definition for detailed explanation. |
void ismrx_stop_drx | ( | ismrx_t * | ctx | ) |
ISM RX stop receiving signal.
This function adjust device to stop receiving signal in discontinuous mode.
[in] | ctx | : Click context object. See ismrx_t object definition for detailed explanation. |
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.
[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. |
0
- Success, -1
- Error.