GNSS Click Driver

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

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

Functions
void	gnss_cfg_setup (gnss_cfg_t *cfg)
	GNSS configuration object setup function.
err_t	gnss_init (gnss_t *ctx, gnss_cfg_t *cfg)
	GNSS initialization function.
err_t	gnss_generic_write (gnss_t *ctx, char *data_in, uint16_t len)
	GNSS data writing function.
err_t	gnss_generic_read (gnss_t *ctx, char *data_out, uint16_t len)
	GNSS data reading function.
void	gnss_clear_ring_buffers (gnss_t *ctx)
	GNSS clear ring buffers function.
void	gnss_set_rst_pin (gnss_t *ctx, uint8_t state)
	GNSS set RST pin function.
void	gnss_set_fon_pin (gnss_t *ctx, uint8_t state)
	GNSS set FON pin function.
err_t	gnss_parse_gpgga (char *rsp_buf, uint8_t gpgga_element, char *element_data)
	GNSS parse GPGGA function.

Detailed Description

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

gnss_cfg_setup()

void gnss_cfg_setup

(

gnss_cfg_t *

cfg

)

GNSS configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

gnss_clear_ring_buffers()

void gnss_clear_ring_buffers

(

gnss_t *

ctx

)

GNSS clear ring buffers function.

This function clears UART tx and rx ring buffers.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

gnss_generic_read()

err_t gnss_generic_read	(	gnss_t *	ctx,
		char *	data_out,
		uint16_t	len )

GNSS data reading function.

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

Parameters

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

gnss_generic_write()

err_t gnss_generic_write	(	gnss_t *	ctx,
		char *	data_in,
		uint16_t	len )

GNSS data writing function.

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

Parameters

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

gnss_init()

err_t gnss_init	(	gnss_t *	ctx,
		gnss_cfg_t *	cfg )

GNSS initialization function.

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

Parameters

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

Returns

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

Note

None.

gnss_parse_gpgga()

err_t gnss_parse_gpgga	(	char *	rsp_buf,
		uint8_t	gpgga_element,
		char *	element_data )

GNSS parse GPGGA function.

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

Parameters

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

Returns

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

Note

None.

gnss_set_fon_pin()

void gnss_set_fon_pin	(	gnss_t *	ctx,
		uint8_t	state )

GNSS set FON pin function.

This function sets the FON pin logic state.

Parameters

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

Returns

None.

Note

None.

gnss_set_rst_pin()

void gnss_set_rst_pin	(	gnss_t *	ctx,
		uint8_t	state )

GNSS set RST pin function.

This function sets the RST pin logic state.

Parameters

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

Returns

None.

Note

None.