GPS 3 Click Driver

API for configuring and manipulating GPS 3 Click driver. More...

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

Functions
void	gps3_cfg_setup (gps3_cfg_t *cfg)
	GPS 3 configuration object setup function.
err_t	gps3_init (gps3_t *ctx, gps3_cfg_t *cfg)
	GPS 3 initialization function.
err_t	gps3_generic_write (gps3_t *ctx, char *data_in, uint16_t len)
	GPS 3 data writing function.
err_t	gps3_generic_read (gps3_t *ctx, char *data_out, uint16_t len)
	GPS 3 data reading function.
void	gps3_clear_ring_buffers (gps3_t *ctx)
	GPS 3 clear ring buffers function.
void	gps3_set_rst_pin (gps3_t *ctx, uint8_t state)
	GPS 3 set RST pin function.
err_t	gps3_parse_gpgga (char *rsp_buf, uint8_t gpgga_element, char *element_data)
	GPS 3 parse GPGGA function.

Detailed Description

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

gps3_cfg_setup()

void gps3_cfg_setup

(

gps3_cfg_t *

cfg

)

GPS 3 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

gps3_clear_ring_buffers()

void gps3_clear_ring_buffers

(

gps3_t *

ctx

)

GPS 3 clear ring buffers function.

This function clears UART tx and rx ring buffers.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

gps3_generic_read()

err_t gps3_generic_read	(	gps3_t *	ctx,
		char *	data_out,
		uint16_t	len )

GPS 3 data reading function.

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

Parameters

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

gps3_generic_write()

err_t gps3_generic_write	(	gps3_t *	ctx,
		char *	data_in,
		uint16_t	len )

GPS 3 data writing function.

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

Parameters

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

gps3_init()

err_t gps3_init	(	gps3_t *	ctx,
		gps3_cfg_t *	cfg )

GPS 3 initialization function.

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

Parameters

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

Returns

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

Note

None.

gps3_parse_gpgga()

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

GPS 3 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.

gps3_set_rst_pin()

void gps3_set_rst_pin	(	gps3_t *	ctx,
		uint8_t	state )

GPS 3 set RST pin function.

This function sets the RST pin logic state.

Parameters

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

Returns

None.

Note

None.