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

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

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

Functions
void	gnss12_cfg_setup (gnss12_cfg_t *cfg)
	GNSS 12 configuration object setup function.

void	gnss12_drv_interface_selection (gnss12_cfg_t *cfg, gnss12_drv_t drv_sel)
	GNSS 12 driver interface setup function.

err_t	gnss12_init (gnss12_t ctx, gnss12_cfg_t cfg)
	GNSS 12 initialization function.

err_t	gnss12_generic_write (gnss12_t ctx, uint8_t data_in, uint8_t len)
	GNSS 12 data writing function.

err_t	gnss12_generic_read (gnss12_t ctx, uint8_t data_out, uint8_t len)
	GNSS 12 data reading function.

void	gnss12_set_rst_pin (gnss12_t *ctx, uint8_t state)
	GNSS 12 set RST pin function.

uint8_t	gnss12_get_lna_en_pin (gnss12_t *ctx)
	GNSS 12 get LNA EN pin function.

uint8_t	gnss12_get_eint_pin (gnss12_t *ctx)
	GNSS 12 get Ext INT pin function.

void	gnss12_reset_device (gnss12_t *ctx)
	GNSS 12 reset device function.

err_t	gnss12_parse_gngga (char rsp_buf, uint8_t gngga_element, char element_data)
	GNSS 12 parse GNGGA function.

Detailed Description

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

◆ gnss12_cfg_setup()

void gnss12_cfg_setup ( gnss12_cfg_t * cfg )

GNSS 12 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ gnss12_drv_interface_selection()

void gnss12_drv_interface_selection	(	gnss12_cfg_t *	cfg,
		gnss12_drv_t	drv_sel )

GNSS 12 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 gnss12_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See gnss12_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.

◆ gnss12_generic_read()

err_t gnss12_generic_read	(	gnss12_t *	ctx,
		uint8_t *	data_out,
		uint8_t	len )

GNSS 12 data reading function.

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

Parameters

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

◆ gnss12_generic_write()

err_t gnss12_generic_write	(	gnss12_t *	ctx,
		uint8_t *	data_in,
		uint8_t	len )

GNSS 12 data writing function.

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

Parameters

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

◆ gnss12_get_eint_pin()

uint8_t gnss12_get_eint_pin ( gnss12_t * ctx )

GNSS 12 get Ext INT pin function.

This function returns the Ext INT pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ gnss12_get_lna_en_pin()

uint8_t gnss12_get_lna_en_pin ( gnss12_t * ctx )

GNSS 12 get LNA EN pin function.

This function returns the LNA EN pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ gnss12_init()

err_t gnss12_init	(	gnss12_t *	ctx,
		gnss12_cfg_t *	cfg )

GNSS 12 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ gnss12_parse_gngga()

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

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

◆ gnss12_reset_device()

void gnss12_reset_device ( gnss12_t * ctx )

GNSS 12 reset device function.

This function resets the device by toggling the RST pin.

Parameters

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

Returns: None.

Note: None.

◆ gnss12_set_rst_pin()

void gnss12_set_rst_pin	(	gnss12_t *	ctx,
		uint8_t	state )

GNSS 12 set RST pin function.

This function sets the RST pin logic state.

Parameters

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

Returns: None.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ gnss12_cfg_setup()

◆ gnss12_drv_interface_selection()

◆ gnss12_generic_read()

◆ gnss12_generic_write()

◆ gnss12_get_eint_pin()

◆ gnss12_get_lna_en_pin()

◆ gnss12_init()

◆ gnss12_parse_gngga()

◆ gnss12_reset_device()

◆ gnss12_set_rst_pin()