lr10
2.1.0.0
|
API for configuring and manipulating LR 10 Click driver. More...
Modules | |
LR 10 Device Settings | |
Settings for registers of LR 10 Click driver. | |
LR 10 MikroBUS Map | |
MikroBUS pin mapping of LR 10 Click driver. | |
Functions | |
void | lr10_cfg_setup (lr10_cfg_t *cfg) |
LR 10 configuration object setup function. More... | |
err_t | lr10_init (lr10_t *ctx, lr10_cfg_t *cfg) |
LR 10 initialization function. More... | |
void | lr10_hw_reset (lr10_t *ctx) |
LR 10 HW reset function. More... | |
err_t | lr10_generic_write (lr10_t *ctx, uint8_t *data_in, uint16_t len) |
LR 10 data writing function. More... | |
err_t | lr10_generic_read (lr10_t *ctx, uint8_t *data_out, uint16_t len) |
LR 10 data reading function. More... | |
err_t | lr10_write_cmd (lr10_t *ctx, uint8_t *command) |
LR 10 command writing function. More... | |
err_t | lr10_write_cmd_param (lr10_t *ctx, uint8_t *command, uint8_t *param) |
LR 10 command - parameter writing function. More... | |
err_t | lr10_write_cmd_sub_param (lr10_t *ctx, uint8_t *command, uint8_t *sub_param, uint8_t *param, lr10_en_quote_t en_quote) |
LR 10 command - subcommands - parameter writing function. More... | |
err_t | lr10_inquire_cmd (lr10_t *ctx, uint8_t *command) |
LR 10 inquire command function. More... | |
API for configuring and manipulating LR 10 Click driver.
void lr10_cfg_setup | ( | lr10_cfg_t * | cfg | ) |
LR 10 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See lr10_cfg_t object definition for detailed explanation. |
err_t lr10_generic_read | ( | lr10_t * | ctx, |
uint8_t * | data_out, | ||
uint16_t | len | ||
) |
LR 10 data reading function.
This function reads a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See lr10_t object definition for detailed explanation. |
[out] | data_out | : Output read data. |
[in] | len | : Number of bytes to be read. |
>0
- Number of data bytes read, <=0
- Error/Empty Ring buffer. See #err_t definition for detailed explanation. err_t lr10_generic_write | ( | lr10_t * | ctx, |
uint8_t * | data_in, | ||
uint16_t | len | ||
) |
LR 10 data writing function.
This function writes a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See lr10_t object definition for detailed explanation. |
[in] | data_in | : Data buffer for sending. |
[in] | len | : Number of bytes for sending. |
>=0
- Success, <0
- Error. See #err_t definition for detailed explanation. void lr10_hw_reset | ( | lr10_t * | ctx | ) |
LR 10 HW reset function.
This function performs a hardware reset of the device.
[in] | ctx | : Click context object. See lr10_t object definition for detailed explanation. |
err_t lr10_init | ( | lr10_t * | ctx, |
lr10_cfg_t * | cfg | ||
) |
LR 10 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See lr10_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See lr10_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t lr10_inquire_cmd | ( | lr10_t * | ctx, |
uint8_t * | command | ||
) |
LR 10 inquire command function.
This function writes a desired inquire command by using UART serial interface.
[in] | ctx | : Click context object. See lr10_t object definition for detailed explanation. |
[in] | command | : Command buffer for sending. |
>=0
- Success, <0
- Error. See #err_t definition for detailed explanation. err_t lr10_write_cmd | ( | lr10_t * | ctx, |
uint8_t * | command | ||
) |
LR 10 command writing function.
This function writes a desired command by using UART serial interface.
[in] | ctx | : Click context object. See lr10_t object definition for detailed explanation. |
[in] | command | : Command buffer for sending. |
>=0
- Success, <0
- Error. See #err_t definition for detailed explanation. err_t lr10_write_cmd_param | ( | lr10_t * | ctx, |
uint8_t * | command, | ||
uint8_t * | param | ||
) |
LR 10 command - parameter writing function.
This function writes a desired command and parameter by using UART serial interface.
[in] | ctx | : Click context object. See lr10_t object definition for detailed explanation. |
[in] | command | : Command buffer for sending. |
[in] | param | : Parameter buffer for sending. |
>=0
- Success, <0
- Error. See #err_t definition for detailed explanation. err_t lr10_write_cmd_sub_param | ( | lr10_t * | ctx, |
uint8_t * | command, | ||
uint8_t * | sub_param, | ||
uint8_t * | param, | ||
lr10_en_quote_t | en_quote | ||
) |
LR 10 command - subcommands - parameter writing function.
This function writes a desired command, subcommands and parameter by using UART serial interface.
[in] | ctx | : Click context object. See lr10_t object definition for detailed explanation. |
[in] | command | : Command buffer for sending. |
[in] | sub_param | : Subcommands buffer for sending. |
[in] | param | : Parameter buffer for sending. |
[in] | en_quote | : Enable quote. See lr10_en_quote_t definition for detailed explanation. |
>=0
- Success, <0
- Error. See #err_t definition for detailed explanation.