GNSS 15 Click Driver

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

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

Functions
void	gnss15_cfg_setup (gnss15_cfg_t *cfg)
	GNSS 15 configuration object setup function.
err_t	gnss15_init (gnss15_t *ctx, gnss15_cfg_t *cfg)
	GNSS 15 initialization function.
err_t	gnss15_generic_write (gnss15_t *ctx, uint8_t *data_in, uint16_t len)
	GNSS 15 data writing function.
err_t	gnss15_generic_read (gnss15_t *ctx, uint8_t *data_out, uint16_t len)
	GNSS 15 data reading function.
void	gnss15_set_rst_pin (gnss15_t *ctx, uint8_t state)
	GNSS 15 set RST pin function.
void	gnss15_set_wup_pin (gnss15_t *ctx, uint8_t state)
	GNSS 15 set WUP pin function.
uint8_t	gnss15_get_interrupt (gnss15_t *ctx)
	GNSS 15 get interrupt pin state function.
void	gnss15_reset_device (gnss15_t *ctx)
	GNSS 15 reset device function.
err_t	gnss15_parse_gpgga (uint8_t *rsp_buf, uint8_t gpgga_element, uint8_t *element_data)
	GNSS 15 parse GPGGA function.

Detailed Description

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

gnss15_cfg_setup()

void gnss15_cfg_setup

(

gnss15_cfg_t *

cfg

)

GNSS 15 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

gnss15_generic_read()

err_t gnss15_generic_read	(	gnss15_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

GNSS 15 data reading function.

reads a desired number of data bytes from the module.

Parameters

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

gnss15_generic_write()

err_t gnss15_generic_write	(	gnss15_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

GNSS 15 data writing function.

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

Parameters

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

gnss15_get_interrupt()

uint8_t gnss15_get_interrupt

(

gnss15_t *

ctx

)

GNSS 15 get interrupt pin state function.

This function returns the INT pin logic state.

Parameters

[in]

ctx

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

Returns

Pin logic state.

Note

None.

gnss15_init()

err_t gnss15_init	(	gnss15_t *	ctx,
		gnss15_cfg_t *	cfg )

GNSS 15 initialization function.

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

Parameters

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

Returns

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

Note

None.

gnss15_parse_gpgga()

err_t gnss15_parse_gpgga	(	uint8_t *	rsp_buf,
		uint8_t	gpgga_element,
		uint8_t *	element_data )

GNSS 15 parse GPGGA function.

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

Parameters

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

Returns

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

Note

None.

gnss15_reset_device()

void gnss15_reset_device

(

gnss15_t *

ctx

)

GNSS 15 reset device function.

This function resets the device by toggling the RST pin.

Parameters

[in]

ctx

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

Returns

Pin logic state.

Note

None.

gnss15_set_rst_pin()

void gnss15_set_rst_pin	(	gnss15_t *	ctx,
		uint8_t	state )

GNSS 15 set RST pin function.

This function sets the RST pin logic state.

Parameters

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

Note

None.

gnss15_set_wup_pin()

void gnss15_set_wup_pin	(	gnss15_t *	ctx,
		uint8_t	state )

GNSS 15 set WUP pin function.

This function sets the WUP (RWM) pin logic state.

Parameters

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

Note

None.