API for configuring and manipulating LR Click driver. More...

Topics
	LR Device Settings
	Settings for registers of LR Click driver.

	LR MikroBUS Map
	MikroBUS pin mapping of LR Click driver.

Functions
void	lr_cfg_setup (lr_cfg_t *cfg)
	LR configuration object setup function.

err_t	lr_init (lr_t ctx, lr_cfg_t cfg)
	LR initialization function.

void	lr_default_cfg (lr_t ctx, bool cb_default, void(response_p)(char *response))
	LR default configuration function.

void	lr_generic_write (lr_t ctx, char data_buf, uint16_t len)
	LR data writing function.

int32_t	lr_generic_read (lr_t ctx, char data_buf, uint16_t max_len)
	LR data reading function.

void	lr_cmd (lr_t ctx, char cmd, char *response)
	Send command function.

uint8_t	lr_mac_tx (lr_t ctx, lr_mac_t mac)
	Function for writing mac parameters.

uint8_t	lr_join (lr_t ctx, char join_mode, char *response)
	Function for setting join mode.

uint8_t	lr_rx (lr_t ctx, char window_size, char *response)
	Main receiver function

uint8_t	lr_tx (lr_t ctx, char buffer)
	Main tnanceiver function.

void	lr_rx_isr (lr_t *ctx, char rx_input)
	Receiver.

void	lr_tick_isr (lr_t *ctx)
	Timer.

void	lr_tick_conf (lr_t *ctx, uint32_t timer_limit)
	Timer Configuration.

void	lr_isr_process (lr_t *ctx)
	Main Process.

void	lr_put_char (lr_t *ctx, char data_in)
	Function for write char.

Detailed Description

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

◆ lr_cfg_setup()

void lr_cfg_setup ( lr_cfg_t * cfg )

LR configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See lr_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ lr_cmd()

void lr_cmd	(	lr_t *	ctx,
		char *	cmd,
		char *	response )

Send command function.

Used by parser to send data inside the software buffer. User can send valid commands with this function but command string and data should be well formated.

Parameters

[in]	ctx	: Click context object. See lr_t object definition for detailed explanation.
[in]	comd	: Well formated command string.
[out]	response	: Response data.

Returns: Nothing.

Note: None.

◆ lr_default_cfg()

void lr_default_cfg	(	lr_t *	ctx,
		bool	cb_default,
		void()(char response)	response_p )

LR default configuration function.

This function executes a default configuration of LR click board.

Parameters

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

◆ lr_generic_read()

int32_t lr_generic_read	(	lr_t *	ctx,
		char *	data_buf,
		uint16_t	max_len )

LR data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See lr_t object definition for detailed explanation.
[out]	data_buf	: Output read data.
[in]	max_len	: Number of bytes to be read.

Returns

>0 - Number of data bytes read,
<=0 - Error/Empty Ring buffer.

Note: None.

◆ lr_generic_write()

void lr_generic_write	(	lr_t *	ctx,
		char *	data_buf,
		uint16_t	len )

LR data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See lr_t object definition for detailed explanation.
[in]	data_buf	: Data buffer for sending.
[in]	len	: Number of bytes for sending.

Returns: Nothing.

Note: None.

◆ lr_init()

err_t lr_init	(	lr_t *	ctx,
		lr_cfg_t *	cfg )

LR initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters

[out]	ctx	: Click context object. See lr_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See lr_cfg_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ lr_isr_process()

void lr_isr_process ( lr_t * ctx )

Main Process.

Function must be placed inside the infinite while loop.

Parameters

[in] ctx : Click context object. See lr_t object definition for detailed explanation.

Returns: Nothing.

Note: None.

◆ lr_join()

uint8_t lr_join	(	lr_t *	ctx,
		char *	join_mode,
		char *	response )

Function for setting join mode.

This function sets join mode.

Parameters

[in]	ctx	: Click context object. See lr_t object definition for detailed explanation.
[in]	join_mode	: Join mode.
[out]	response	: Response.

Returns: LR flag.

Note: None.

◆ lr_mac_tx()

uint8_t lr_mac_tx	(	lr_t *	ctx,
		lr_mac_t *	mac )

Function for writing mac parameters.

This function write mac parameters to tx_buffer.

Parameters

[in]	ctx	: Click context object. See lr_t object definition for detailed explanation.
[in]	mac	: Mac structure object

Returns: LR flag.

Note: None.

◆ lr_put_char()

void lr_put_char	(	lr_t *	ctx,
		char	data_in )

Function for write char.

Function write char into ctx objects.

Parameters

[in]	ctx	: Click context object. See lr_t object definition for detailed explanation.
[in]	data_in	: Char to be written

Returns: Nothing.

Note: None.

◆ lr_rx()

uint8_t lr_rx	(	lr_t *	ctx,
		char *	window_size,
		char *	response )

Main receiver function

This function is used for receive message.

Parameters

[in]	ctx	: Click context object. See lr_t object definition for detailed explanation.
[in]	window_size	: Window size.
[out]	response	: Response.

Returns: LR flag.

Note: None.

◆ lr_rx_isr()

void lr_rx_isr	(	lr_t *	ctx,
		char	rx_input )

Receiver.

Must be placed inside the user made uart interrupt routine.

Parameters

[in]	ctx	: Click context object. See lr_t object definition for detailed explanation.
[in]	rx_input	: Data from uart receive register

Returns: Nothing.

Note: None.

◆ lr_tick_conf()

void lr_tick_conf	(	lr_t *	ctx,
		uint32_t	timer_limit )

Timer Configuration.

Used to configure host watchdog. When timeout occurs response with no data will be parsed. If user provide 0 as argument timer will be turned off. By default after the initialization timer limit is turned on and set to

Parameters

[in]	ctx	: Click context object. See lr_t object definition for detailed explanation.
[in]	timer_limit	: ( 0 ~ 4294967296 )

Returns: Nothing.

TIMER_EXPIRED

Note

  
RN2483 have it's own watchdog timer, this one should be longer than watchdog and can be 
used to restart the module in case of when library does not receiving responses from the 
module.

◆ lr_tick_isr()

void lr_tick_isr ( lr_t * ctx )

Timer.

Used for host timing. Should be placed inside the previously made interrupt routine made by user that occurs on every one milisecond.

Parameters

[in] ctx : Click context object. See lr_t object definition for detailed explanation.

Returns: Nothing.

Note: None.

◆ lr_tx()

uint8_t lr_tx	(	lr_t *	ctx,
		char *	buffer )

Main tnanceiver function.

This function is used for sending message.

Parameters

[in]	ctx	: Click context object. See lr_t object definition for detailed explanation.
[in]	buffer	: Buffer to be send.

Returns: LR flag.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ lr_cfg_setup()

◆ lr_cmd()

◆ lr_default_cfg()

◆ lr_generic_read()

◆ lr_generic_write()

◆ lr_init()

◆ lr_isr_process()

◆ lr_join()

◆ lr_mac_tx()

◆ lr_put_char()

◆ lr_rx()

◆ lr_rx_isr()

◆ lr_tick_conf()

◆ lr_tick_isr()

◆ lr_tx()