RTK Rover Click Driver

API for configuring and manipulating RTK Rover Click driver. More...

Topics
	RTK Rover Device Settings
	Settings for registers of RTK Rover Click driver.
	RTK Rover MikroBUS Map
	MikroBUS pin mapping of RTK Rover Click driver.

Functions
void	rtkrover_cfg_setup (rtkrover_cfg_t *cfg)
	RTK Rover configuration object setup function.
err_t	rtkrover_init (rtkrover_t *ctx, rtkrover_cfg_t *cfg)
	RTK Rover initialization function.
err_t	rtkrover_generic_write (rtkrover_t *ctx, char *data_in, uint16_t len)
	RTK Rover data writing function.
err_t	rtkrover_generic_read (rtkrover_t *ctx, char *data_out, uint16_t len)
	RTK Rover data reading function.
void	rtkrover_clear_ring_buffers (rtkrover_t *ctx)
	RTK Rover clear ring buffers function.
void	rtkrover_set_rst_pin (rtkrover_t *ctx, uint8_t state)
	RTK Rover set RST pin function.
void	rtkrover_set_wup_pin (rtkrover_t *ctx, uint8_t state)
	RTK Rover set WUP pin function.
void	rtkrover_set_boot_pin (rtkrover_t *ctx, uint8_t state)
	RTK Rover set BOOT pin function.
void	rtkrover_set_shd_pin (rtkrover_t *ctx, uint8_t state)
	RTK Rover set SHD pin function.
uint8_t	rtkrover_get_int_pin (rtkrover_t *ctx)
	RTK Rover get INT pin function.
err_t	rtkrover_parse_gngga (char *rsp_buf, uint8_t gngga_element, char *element_data)
	RTK Rover parse GNGGA function.

Detailed Description

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

rtkrover_cfg_setup()

void rtkrover_cfg_setup

(

rtkrover_cfg_t *

cfg

)

RTK Rover configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See rtkrover_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

rtkrover_clear_ring_buffers()

void rtkrover_clear_ring_buffers

(

rtkrover_t *

ctx

)

RTK Rover clear ring buffers function.

This function clears UART tx and rx ring buffers.

Parameters

[in]

ctx

: Click context object. See rtkrover_t object definition for detailed explanation.

Returns

None.

Note

None.

rtkrover_generic_read()

err_t rtkrover_generic_read	(	rtkrover_t *	ctx,
		char *	data_out,
		uint16_t	len )

RTK Rover data reading function.

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

Parameters

[in]	ctx	: Click context object. See rtkrover_t object definition for detailed explanation.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

• >0 - Number of data bytes read,
• <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.

Note

None.

rtkrover_generic_write()

err_t rtkrover_generic_write	(	rtkrover_t *	ctx,
		char *	data_in,
		uint16_t	len )

RTK Rover data writing function.

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

Parameters

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

Returns

• >=0 - Success,
• <0 - Error. See #err_t definition for detailed explanation.

Note

None.

rtkrover_get_int_pin()

uint8_t rtkrover_get_int_pin

(

rtkrover_t *

ctx

)

RTK Rover get INT pin function.

This function returns the INT pin logic state.

Parameters

[in]

ctx

: Click context object. See rtkrover_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

rtkrover_init()

err_t rtkrover_init	(	rtkrover_t *	ctx,
		rtkrover_cfg_t *	cfg )

RTK Rover initialization function.

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

Parameters

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

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

rtkrover_parse_gngga()

err_t rtkrover_parse_gngga	(	char *	rsp_buf,
		uint8_t	gngga_element,
		char *	element_data )

RTK Rover parse GNGGA function.

This function parses the GNGGA data from the read response buffer.

Parameters

[in]	rsp_buf	: Response buffer.
[in]	gngga_element	: GNGGA element position [1-14].
[out]	element_data	: Element data parsed.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

rtkrover_set_boot_pin()

void rtkrover_set_boot_pin	(	rtkrover_t *	ctx,
		uint8_t	state )

RTK Rover set BOOT pin function.

This function sets the BOOT pin logic state.

Parameters

[in]	ctx	: Click context object. See rtkrover_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns

None.

Note

None.

rtkrover_set_rst_pin()

void rtkrover_set_rst_pin	(	rtkrover_t *	ctx,
		uint8_t	state )

RTK Rover set RST pin function.

This function sets the RST pin logic state.

Parameters

[in]	ctx	: Click context object. See rtkrover_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns

None.

Note

None.

rtkrover_set_shd_pin()

void rtkrover_set_shd_pin	(	rtkrover_t *	ctx,
		uint8_t	state )

RTK Rover set SHD pin function.

This function sets the SHD pin logic state.

Parameters

[in]	ctx	: Click context object. See rtkrover_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns

None.

Note

None.

rtkrover_set_wup_pin()

void rtkrover_set_wup_pin	(	rtkrover_t *	ctx,
		uint8_t	state )

RTK Rover set WUP pin function.

This function sets the WUP pin logic state.

Parameters

[in]	ctx	: Click context object. See rtkrover_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns

None.

Note

None.