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

Topics
	Nano GPS 3 Registers List
	List of registers of Nano GPS 3 Click driver.

	Nano GPS 3 Registers Settings
	Nano GPS 3 description register.

	Nano GPS 3 MikroBUS Map
	MikroBUS pin mapping of Nano GPS 3 Click driver.

Functions
void	nanogps3_cfg_setup (nanogps3_cfg_t *cfg)
	Nano GPS 3 configuration object setup function.

err_t	nanogps3_init (nanogps3_t ctx, nanogps3_cfg_t cfg)
	Nano GPS 3 initialization function.

void	nanogps3_default_cfg (nanogps3_t *ctx)
	Nano GPS 3 default configuration function.

err_t	nanogps3_generic_write (nanogps3_t ctx, uint8_t data_in, uint8_t len)
	Nano GPS 3 data writing function.

err_t	nanogps3_generic_read (nanogps3_t ctx, uint8_t data_out, uint8_t len)
	Nano GPS 3 data reading function.

void	nanogps3_request_to_send (nanogps3_t *ctx, uint8_t rts)
	Nano GPS 3 request to send function.

uint8_t	nanogps3_clear_to_send (nanogps3_t *ctx)
	Nano GPS 3 clear to send function.

void	nanogps3_set_reset_state (nanogps3_t *ctx, uint8_t rst_state)
	Nano GPS 3 set reset state function.

void	nanogps3_set_force_on_state (nanogps3_t *ctx, uint8_t pwr_state)
	Nano GPS 3 set force on state function.

uint8_t	nanogps3_get_wup_pin (nanogps3_t *ctx)
	Nano GPS 3 get wakeup pin function.

err_t	nanogps3_parse_gngga (char rsp_buf, uint8_t gngga_element, char element_data)
	Nano GPS 3 parse GNGGA function.

Detailed Description

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

◆ nanogps3_cfg_setup()

void nanogps3_cfg_setup ( nanogps3_cfg_t * cfg )

Nano GPS 3 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ nanogps3_clear_to_send()

uint8_t nanogps3_clear_to_send ( nanogps3_t * ctx )

Nano GPS 3 clear to send function.

This function is flow control and uses to get the clear to send logic state of the Nano GPS 3 click board™.

Parameters

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

Returns: Status of the clear to send.

Note: None.

◆ nanogps3_default_cfg()

void nanogps3_default_cfg ( nanogps3_t * ctx )

Nano GPS 3 default configuration function.

This function executes a default configuration of Nano GPS 3 click board.

Parameters

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

Returns: Nothing.

Note: This function can consist any necessary configuration or setting to put device into operating mode.

◆ nanogps3_generic_read()

err_t nanogps3_generic_read	(	nanogps3_t *	ctx,
		uint8_t *	data_out,
		uint8_t	len )

Nano GPS 3 data reading function.

This function reads a desired number of data bytes from the module.

Parameters

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

Returns

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

Note: None.

◆ nanogps3_generic_write()

err_t nanogps3_generic_write	(	nanogps3_t *	ctx,
		uint8_t *	data_in,
		uint8_t	len )

Nano GPS 3 data writing function.

This function writes a desired number of data to the module.

Parameters

[in]	ctx	: Click context object. See nanogps3_t object definition for detailed explanation.
[in]	data_in	: Data to be written.
[in]	len	: Number of bytes to be written.

Returns

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

Note: None.

◆ nanogps3_get_wup_pin()

uint8_t nanogps3_get_wup_pin ( nanogps3_t * ctx )

Nano GPS 3 get wakeup pin function.

This function get logic states of the WUP pin of the Nano GPS 3 click board™.

Parameters

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

Returns: WUP pin logic state.

Note: None.

◆ nanogps3_init()

err_t nanogps3_init	(	nanogps3_t *	ctx,
		nanogps3_cfg_t *	cfg )

Nano GPS 3 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ nanogps3_parse_gngga()

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

Nano GPS 3 parse GNGGA function.

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

Parameters

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

Returns

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

Note: None.

◆ nanogps3_request_to_send()

void nanogps3_request_to_send	(	nanogps3_t *	ctx,
		uint8_t	rts )

Nano GPS 3 request to send function.

This function is flow control and uses to sets the request to send logic state of the Nano GPS 3 click board™.

Parameters

[in]	ctx	: Click context object. See nanogps3_t object definition for detailed explanation.
[in]	cts	: Request to send state.

Returns: Nothing.

Note: None.

◆ nanogps3_set_force_on_state()

void nanogps3_set_force_on_state	(	nanogps3_t *	ctx,
		uint8_t	pwr_state )

Nano GPS 3 set force on state function.

This function controls the power states of the Nano GPS 3 click board™.

Parameters

[in]	ctx	: Click context object. See nanogps3_t object definition for detailed explanation.
[in]	pwr_state	: Power pin states.

Returns: Nothing.

Note: None.

◆ nanogps3_set_reset_state()

void nanogps3_set_reset_state	(	nanogps3_t *	ctx,
		uint8_t	rst_state )

Nano GPS 3 set reset state function.

This function sets RST pin logic state of the Nano GPS 3 click board™.

Parameters

[in]	ctx	: Click context object. See nanogps3_t object definition for detailed explanation.
[in]	rst_state	: Reset pin states.

Returns: Nothing.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ nanogps3_cfg_setup()

◆ nanogps3_clear_to_send()

◆ nanogps3_default_cfg()

◆ nanogps3_generic_read()

◆ nanogps3_generic_write()

◆ nanogps3_get_wup_pin()

◆ nanogps3_init()

◆ nanogps3_parse_gngga()

◆ nanogps3_request_to_send()

◆ nanogps3_set_force_on_state()

◆ nanogps3_set_reset_state()