GPS 5 Click Driver

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

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

Functions
void	gps5_cfg_setup (gps5_cfg_t *cfg)
	GPS 5 configuration object setup function.
err_t	gps5_init (gps5_t *ctx, gps5_cfg_t *cfg)
	GPS 5 initialization function.
err_t	gps5_generic_write (gps5_t *ctx, char *data_buf, uint16_t len)
	GPS 5 data writing function.
err_t	gps5_generic_read (gps5_t *ctx, char *data_buf, uint16_t max_len)
	GPS 5 data reading function.
void	gps5_set_rst_pin (gps5_t *ctx, uint8_t state)
	GPS 5 set RST pin function.
void	gps5_set_stb_pin (gps5_t *ctx, uint8_t state)
	GPS 5 set STB pin function.
void	gps5_set_en_pin (gps5_t *ctx, uint8_t state)
	GPS 5 set EN pin function.
err_t	gps5_parse_gngga (char *rsp_buf, uint8_t gngga_element, char *element_data)
	GPS 5 parse GNGGA function.

Detailed Description

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

gps5_cfg_setup()

void gps5_cfg_setup

(

gps5_cfg_t *

cfg

)

GPS 5 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

gps5_generic_read()

err_t gps5_generic_read	(	gps5_t *	ctx,
		char *	data_buf,
		uint16_t	max_len )

GPS 5 data reading function.

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

Parameters

[in]	ctx	: Click context object. See gps5_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. See #err_t definition for detailed explanation.

Note

None.

gps5_generic_write()

err_t gps5_generic_write	(	gps5_t *	ctx,
		char *	data_buf,
		uint16_t	len )

GPS 5 data writing function.

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

Parameters

[in]	ctx	: Click context object. See gps5_t object definition for detailed explanation.
[in]	data_buf	: 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.

gps5_init()

err_t gps5_init	(	gps5_t *	ctx,
		gps5_cfg_t *	cfg )

GPS 5 initialization function.

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

Parameters

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

Returns

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

Note

None.

gps5_parse_gngga()

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

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

gps5_set_en_pin()

void gps5_set_en_pin	(	gps5_t *	ctx,
		uint8_t	state )

GPS 5 set EN pin function.

This function sets the EN pin logic state.

Parameters

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

Returns

None.

Note

None.

gps5_set_rst_pin()

void gps5_set_rst_pin	(	gps5_t *	ctx,
		uint8_t	state )

GPS 5 set RST pin function.

This function sets the RST pin logic state.

Parameters

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

Returns

None.

Note

None.

gps5_set_stb_pin()

void gps5_set_stb_pin	(	gps5_t *	ctx,
		uint8_t	state )

GPS 5 set STB pin function.

This function sets the STB pin logic state.

Parameters

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

Returns

None.

Note

None.