ookrx
2.1.0.0
|
API for configuring and manipulating OOK RX Click driver. More...
Modules | |
OOK RX Settings | |
Settings for configuration of OOK RX Click driver. | |
OOK RX MikroBUS Map | |
MikroBUS pin mapping of OOK RX Click driver. | |
Functions | |
void | ookrx_cfg_setup (ookrx_cfg_t *cfg) |
OOK RX configuration object setup function. More... | |
err_t | ookrx_init (ookrx_t *ctx, ookrx_cfg_t *cfg) |
OOK RX initialization function. More... | |
void | ookrx_enable_squelch (ookrx_t *ctx) |
OOK RX enable squelch function. More... | |
void | ookrx_disable_squelch (ookrx_t *ctx) |
OOK RX disable squelch function. More... | |
void | ookrx_enable_device (ookrx_t *ctx) |
OOK RX enable device function. More... | |
void | ookrx_disable_device (ookrx_t *ctx) |
OOK RX disable device function. More... | |
uint8_t | ookrx_get_data_pin (ookrx_t *ctx) |
OOK RX get data pin function. More... | |
err_t | ookrx_read_rssi_voltage (ookrx_t *ctx, float *data_out) |
OOK RX read RSSI pin voltage level function. More... | |
API for configuring and manipulating OOK RX Click driver.
void ookrx_cfg_setup | ( | ookrx_cfg_t * | cfg | ) |
OOK RX configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See ookrx_cfg_t object definition for detailed explanation. |
void ookrx_disable_device | ( | ookrx_t * | ctx | ) |
OOK RX disable device function.
This function disables device by setting the EN pin to low logic state.
[in] | ctx | : Click context object. See ookrx_t object definition for detailed explanation. |
void ookrx_disable_squelch | ( | ookrx_t * | ctx | ) |
OOK RX disable squelch function.
This function disables squelch by setting the SQC pin to high logic state.
[in] | ctx | : Click context object. See ookrx_t object definition for detailed explanation. |
void ookrx_enable_device | ( | ookrx_t * | ctx | ) |
OOK RX enable device function.
This function enables device by setting the EN pin to high logic state.
[in] | ctx | : Click context object. See ookrx_t object definition for detailed explanation. |
void ookrx_enable_squelch | ( | ookrx_t * | ctx | ) |
OOK RX enable squelch function.
This function enables squelch by setting the SQC pin to low logic state.
[in] | ctx | : Click context object. See ookrx_t object definition for detailed explanation. |
uint8_t ookrx_get_data_pin | ( | ookrx_t * | ctx | ) |
OOK RX get data pin function.
This function returns the DOUT pin logic state.
[in] | ctx | : Click context object. See ookrx_t object definition for detailed explanation. |
err_t ookrx_init | ( | ookrx_t * | ctx, |
ookrx_cfg_t * | cfg | ||
) |
OOK RX initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See ookrx_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See ookrx_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t ookrx_read_rssi_voltage | ( | ookrx_t * | ctx, |
float * | data_out | ||
) |
OOK 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.
[in] | ctx | : Click context object. See ookrx_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.