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

Topics
	GNSS 7 Device Settings
	Settings for registers of GNSS 7 Click driver.

	GNSS 7 MikroBUS Map
	MikroBUS pin mapping of GNSS 7 Click driver.

Functions
void	gnss7_cfg_setup (gnss7_cfg_t *cfg)
	GNSS 7 configuration object setup function.

err_t	gnss7_init (gnss7_t ctx, gnss7_cfg_t cfg)
	GNSS 7 initialization function.

err_t	gnss7_generic_write (gnss7_t ctx, char data_in, uint16_t len)
	GNSS 7 data writing function.

err_t	gnss7_generic_read (gnss7_t ctx, char data_out, uint16_t len)
	GNSS 7 data reading function.

void	gnss7_clear_ring_buffers (gnss7_t *ctx)
	GNSS 7 clear ring buffers function.

void	gnss7_set_sel_pin (gnss7_t *ctx, uint8_t state)
	GNSS 7 set SEL pin function.

void	gnss7_set_rst_pin (gnss7_t *ctx, uint8_t state)
	GNSS 7 set RST pin function.

uint8_t	gnss7_get_exi_pin (gnss7_t *ctx)
	GNSS 7 get EXI pin function.

uint8_t	gnss7_get_pls_pin (gnss7_t *ctx)
	GNSS 7 get PLS pin function.

err_t	gnss7_parse_gngga (char rsp_buf, uint8_t gngga_element, char element_data)
	GNSS 7 parse GNGGA function.

Detailed Description

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

◆ gnss7_cfg_setup()

void gnss7_cfg_setup ( gnss7_cfg_t * cfg )

GNSS 7 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ gnss7_clear_ring_buffers()

void gnss7_clear_ring_buffers ( gnss7_t * ctx )

GNSS 7 clear ring buffers function.

This function clears UART tx and rx ring buffers.

Parameters

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

Returns: None.

Note: None.

◆ gnss7_generic_read()

err_t gnss7_generic_read	(	gnss7_t *	ctx,
		char *	data_out,
		uint16_t	len )

GNSS 7 data reading function.

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

Parameters

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

◆ gnss7_generic_write()

err_t gnss7_generic_write	(	gnss7_t *	ctx,
		char *	data_in,
		uint16_t	len )

GNSS 7 data writing function.

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

Parameters

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

◆ gnss7_get_exi_pin()

uint8_t gnss7_get_exi_pin ( gnss7_t * ctx )

GNSS 7 get EXI pin function.

This function returns the EXI pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ gnss7_get_pls_pin()

uint8_t gnss7_get_pls_pin ( gnss7_t * ctx )

GNSS 7 get PLS pin function.

This function returns the PLS pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ gnss7_init()

err_t gnss7_init	(	gnss7_t *	ctx,
		gnss7_cfg_t *	cfg )

GNSS 7 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ gnss7_parse_gngga()

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

GNSS 7 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.

◆ gnss7_set_rst_pin()

void gnss7_set_rst_pin	(	gnss7_t *	ctx,
		uint8_t	state )

GNSS 7 set RST pin function.

This function sets the RST pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ gnss7_set_sel_pin()

void gnss7_set_sel_pin	(	gnss7_t *	ctx,
		uint8_t	state )

GNSS 7 set SEL pin function.

This function sets the SEL pin logic state.

Parameters

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

Returns: None.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ gnss7_cfg_setup()

◆ gnss7_clear_ring_buffers()

◆ gnss7_generic_read()

◆ gnss7_generic_write()

◆ gnss7_get_exi_pin()

◆ gnss7_get_pls_pin()

◆ gnss7_init()

◆ gnss7_parse_gngga()

◆ gnss7_set_rst_pin()

◆ gnss7_set_sel_pin()