micrfrx2
2.1.0.0
|
API for configuring and manipulating MICRF RX 2 Click driver. More...
Modules | |
MICRF RX 2 Settings | |
Settings for configuration of MICRF RX 2 Click driver. | |
MICRF RX 2 MikroBUS Map | |
MikroBUS pin mapping of MICRF RX 2 Click driver. | |
Functions | |
void | micrfrx2_cfg_setup (micrfrx2_cfg_t *cfg) |
MICRF RX 2 configuration object setup function. More... | |
err_t | micrfrx2_init (micrfrx2_t *ctx, micrfrx2_cfg_t *cfg) |
MICRF RX 2 initialization function. More... | |
void | micrfrx2_set_clock_pin (micrfrx2_t *ctx) |
MICRF RX 2 set clock pin function. More... | |
void | micrfrx2_clear_clock_pin (micrfrx2_t *ctx) |
MICRF RX 2 clear clock pin function. More... | |
void | micrfrx2_enable_device (micrfrx2_t *ctx) |
MICRF RX 2 enable device function. More... | |
void | micrfrx2_disable_device (micrfrx2_t *ctx) |
MICRF RX 2 disable device function. More... | |
uint8_t | micrfrx2_get_data_pin (micrfrx2_t *ctx) |
MICRF RX 2 get data pin function. More... | |
err_t | micrfrx2_read_rssi_voltage (micrfrx2_t *ctx, float *data_out) |
MICRF RX 2 read RSSI pin voltage level function. More... | |
API for configuring and manipulating MICRF RX 2 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void micrfrx2_cfg_setup | ( | micrfrx2_cfg_t * | cfg | ) |
MICRF RX 2 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See micrfrx2_cfg_t object definition for detailed explanation. |
void micrfrx2_clear_clock_pin | ( | micrfrx2_t * | ctx | ) |
MICRF RX 2 clear clock pin function.
This function clears clock pin to low logic state.
[in] | ctx | : Click context object. See micrfrx2_t object definition for detailed explanation. |
void micrfrx2_disable_device | ( | micrfrx2_t * | ctx | ) |
MICRF RX 2 disable device function.
This function disables device by setting the SHD pin to high logic state.
[in] | ctx | : Click context object. See micrfrx2_t object definition for detailed explanation. |
void micrfrx2_enable_device | ( | micrfrx2_t * | ctx | ) |
MICRF RX 2 enable device function.
This function enables device by setting the SHD pin to low logic state.
[in] | ctx | : Click context object. See micrfrx2_t object definition for detailed explanation. |
uint8_t micrfrx2_get_data_pin | ( | micrfrx2_t * | ctx | ) |
MICRF RX 2 get data pin function.
This function returns the DOUT pin logic state.
[in] | ctx | : Click context object. See micrfrx2_t object definition for detailed explanation. |
err_t micrfrx2_init | ( | micrfrx2_t * | ctx, |
micrfrx2_cfg_t * | cfg | ||
) |
MICRF RX 2 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See micrfrx2_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See micrfrx2_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t micrfrx2_read_rssi_voltage | ( | micrfrx2_t * | ctx, |
float * | data_out | ||
) |
MICRF RX 2 read RSSI pin voltage level function.
This function reads results of AD conversion of the RSSI pin and converts them to proportional voltage level.
[in] | ctx | : Click context object. See micrfrx2_t object definition for detailed explanation. |
[out] | data_out | : Output voltage level of the analog pin [V]. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void micrfrx2_set_clock_pin | ( | micrfrx2_t * | ctx | ) |
MICRF RX 2 set clock pin function.
This function sets clock pin to high logic state.
[in] | ctx | : Click context object. See micrfrx2_t object definition for detailed explanation. |