GNSS 14 Click Driver

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

Topics
	GNSS 14 Device Settings
	Settings for registers of GNSS 14 Click driver.
	GNSS 14 MikroBUS Map
	MikroBUS pin mapping of GNSS 14 Click driver.

Functions
void	gnss14_cfg_setup (gnss14_cfg_t *cfg)
	GNSS 14 configuration object setup function.
err_t	gnss14_init (gnss14_t *ctx, gnss14_cfg_t *cfg)
	GNSS 14 initialization function.
err_t	gnss14_generic_write (gnss14_t *ctx, uint8_t *data_in, uint16_t len)
	GNSS 14 data writing function.
err_t	gnss14_generic_read (gnss14_t *ctx, uint8_t *data_out, uint16_t len)
	GNSS 14 data reading function.
void	gnss14_set_io6_pin (gnss14_t *ctx, uint8_t state)
	GNSS 14 set IO6 pin function.
void	gnss14_set_rst_pin (gnss14_t *ctx, uint8_t state)
	GNSS 14 set RST pin function.
uint8_t	gnss14_get_eit_pin (gnss14_t *ctx)
	GNSS 14 get external interrupt pin state function.
uint8_t	gnss14_get_tp_pin (gnss14_t *ctx)
	GNSS 14 get time pulse signal pin state function.
void	gnss14_reset_device (gnss14_t *ctx)
	GNSS 14 reset device function.
err_t	gnss14_parse_gngga (char *rsp_buf, uint8_t gngga_element, char *element_data)
	GNSS 14 parse GNGGA function.

Detailed Description

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

gnss14_cfg_setup()

void gnss14_cfg_setup

(

gnss14_cfg_t *

cfg

)

GNSS 14 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

gnss14_generic_read()

err_t gnss14_generic_read	(	gnss14_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

GNSS 14 data reading function.

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

Parameters

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

gnss14_generic_write()

err_t gnss14_generic_write	(	gnss14_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

GNSS 14 data writing function.

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

Parameters

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

gnss14_get_eit_pin()

uint8_t gnss14_get_eit_pin

(

gnss14_t *

ctx

)

GNSS 14 get external interrupt pin state function.

This function returns the EIT pin logic state.

Parameters

[in]

ctx

: Click context object. See gnss14_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

gnss14_get_tp_pin()

uint8_t gnss14_get_tp_pin

(

gnss14_t *

ctx

)

GNSS 14 get time pulse signal pin state function.

This function returns the TP pin logic state.

Parameters

[in]

ctx

: Click context object. See gnss14_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

gnss14_init()

err_t gnss14_init	(	gnss14_t *	ctx,
		gnss14_cfg_t *	cfg )

GNSS 14 initialization function.

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

Parameters

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

Returns

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

Note

None.

gnss14_parse_gngga()

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

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

gnss14_reset_device()

void gnss14_reset_device

(

gnss14_t *

ctx

)

GNSS 14 reset device function.

This function resets the device by toggling the RST pin.

Parameters

[in]

ctx

: Click context object. See gnss14_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

gnss14_set_io6_pin()

void gnss14_set_io6_pin	(	gnss14_t *	ctx,
		uint8_t	state )

GNSS 14 set IO6 pin function.

This function ets the IO6 (AN) pin logic state.

Parameters

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

Note

None.

gnss14_set_rst_pin()

void gnss14_set_rst_pin	(	gnss14_t *	ctx,
		uint8_t	state )

GNSS 14 set RST pin function.

This function ets the RST pin logic state.

Parameters

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

Note

None.