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

Topics
	GNSS 10 Registers Settings
	Settings for registers of GNSS 10 Click driver.

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

Functions
void	gnss10_cfg_setup (gnss10_cfg_t *cfg)
	GNSS 10 configuration object setup function.

void	gnss10_drv_interface_selection (gnss10_cfg_t *cfg, gnss10_drv_t drv_sel)
	GNSS 10 driver interface setup function.

err_t	gnss10_init (gnss10_t ctx, gnss10_cfg_t cfg)
	GNSS 10 initialization function.

err_t	gnss10_generic_write (gnss10_t ctx, uint8_t data_in, uint8_t len)
	GNSS 10 data writing function.

err_t	gnss10_generic_read (gnss10_t ctx, uint8_t data_out, uint8_t len)
	GNSS 10 data reading function.

void	gnss10_set_rst_pin (gnss10_t *ctx, uint8_t state)
	GNSS 10 set RST pin function.

uint8_t	gnss10_get_eint_1_pin (gnss10_t *ctx)
	GNSS 10 get Ext INT 1 pin function.

uint8_t	gnss10_get_int_pin (gnss10_t *ctx)
	GNSS 10 get INT pin function.

void	gnss10_reset_device (gnss10_t *ctx)
	GNSS 10 reset device function.

err_t	gnss10_parse_gngga (char rsp_buf, uint8_t gngga_element, char element_data)
	GNSS 10 parse GNGGA function.

Detailed Description

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

◆ gnss10_cfg_setup()

void gnss10_cfg_setup ( gnss10_cfg_t * cfg )

GNSS 10 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ gnss10_drv_interface_selection()

void gnss10_drv_interface_selection	(	gnss10_cfg_t *	cfg,
		gnss10_drv_t	drv_sel )

GNSS 10 driver interface setup function.

This function sets a serial driver interface which will be used further in the click driver.

Parameters

[out]	cfg	: Click configuration structure. See gnss10_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See gnss10_drv_t object definition for detailed explanation.

Returns: Nothing.

Note: This driver selection should be call before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

◆ gnss10_generic_read()

err_t gnss10_generic_read	(	gnss10_t *	ctx,
		uint8_t *	data_out,
		uint8_t	len )

GNSS 10 data reading function.

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

Parameters

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

Returns

>=0 - Success, or number of data bytes read in the case of UART,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ gnss10_generic_write()

err_t gnss10_generic_write	(	gnss10_t *	ctx,
		uint8_t *	data_in,
		uint8_t	len )

GNSS 10 data writing function.

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

Parameters

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

Returns

>=0 - Success, or number of data bytes written in the case of UART,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ gnss10_get_eint_1_pin()

uint8_t gnss10_get_eint_1_pin ( gnss10_t * ctx )

GNSS 10 get Ext INT 1 pin function.

This function returns the Ext INT 1 pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ gnss10_get_int_pin()

uint8_t gnss10_get_int_pin ( gnss10_t * ctx )

GNSS 10 get INT pin function.

This function returns the INT pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ gnss10_init()

err_t gnss10_init	(	gnss10_t *	ctx,
		gnss10_cfg_t *	cfg )

GNSS 10 initialization function.

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

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ gnss10_parse_gngga()

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

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

◆ gnss10_reset_device()

void gnss10_reset_device ( gnss10_t * ctx )

GNSS 10 reset device function.

This function resets the device by toggling the RST pin.

Parameters

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

Returns: None.

Note: None.

◆ gnss10_set_rst_pin()

void gnss10_set_rst_pin	(	gnss10_t *	ctx,
		uint8_t	state )

GNSS 10 set RST pin function.

This function sets the RST pin logic state.

Parameters

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

Returns: None.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ gnss10_cfg_setup()

◆ gnss10_drv_interface_selection()

◆ gnss10_generic_read()

◆ gnss10_generic_write()

◆ gnss10_get_eint_1_pin()

◆ gnss10_get_int_pin()

◆ gnss10_init()

◆ gnss10_parse_gngga()

◆ gnss10_reset_device()

◆ gnss10_set_rst_pin()