API for configuring and manipulating GNSS RTK 3 Click driver. More...

Topics
	GNSS RTK 3 Device Settings
	Settings for registers of GNSS RTK 3 Click driver.

	GNSS RTK 3 MikroBUS Map
	MikroBUS pin mapping of GNSS RTK 3 Click driver.

Functions
void	gnssrtk3_cfg_setup (gnssrtk3_cfg_t *cfg)
	GNSS RTK 3 configuration object setup function.

void	gnssrtk3_drv_interface_sel (gnssrtk3_cfg_t *cfg, gnssrtk3_drv_t drv_sel)
	GNSS RTK 3 driver interface setup function.

err_t	gnssrtk3_init (gnssrtk3_t ctx, gnssrtk3_cfg_t cfg)
	GNSS RTK 3 initialization function.

err_t	gnssrtk3_generic_write (gnssrtk3_t ctx, uint8_t data_in, uint16_t len)
	GNSS RTK 3 data writing function.

err_t	gnssrtk3_generic_read (gnssrtk3_t ctx, uint8_t data_out, uint16_t len)
	GNSS RTK 3 data reading function.

void	gnssrtk3_set_rst_pin (gnssrtk3_t *ctx, uint8_t state)
	GNSS RTK 3 set RST pin function.

void	gnssrtk3_set_cen_pin (gnssrtk3_t *ctx, uint8_t state)
	GNSS RTK 3 set CEN pin function.

void	gnssrtk3_set_wup_pin (gnssrtk3_t *ctx, uint8_t state)
	GNSS RTK 3 set WUP pin function.

uint8_t	gnssrtk3_get_pps_pin (gnssrtk3_t *ctx)
	GNSS RTK 3 get PPS pin function.

void	gnssrtk3_enable_device (gnssrtk3_t *ctx)
	GNSS RTK 3 enable device function.

void	gnssrtk3_disable_device (gnssrtk3_t *ctx)
	GNSS RTK 3 disable device function.

void	gnssrtk3_reset_device (gnssrtk3_t *ctx)
	GNSS RTK 3 reset device function.

err_t	gnssrtk3_parse_gga (uint8_t rsp_buf, uint8_t gga_element, uint8_t element_data)
	GNSS RTK 3 parse GGA function.

Detailed Description

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

◆ gnssrtk3_cfg_setup()

void gnssrtk3_cfg_setup ( gnssrtk3_cfg_t * cfg )

GNSS RTK 3 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ gnssrtk3_disable_device()

void gnssrtk3_disable_device ( gnssrtk3_t * ctx )

GNSS RTK 3 disable device function.

This function disables the device by setting the CEN pin to low logic state.

Parameters

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

Returns: None.

Note: None.

◆ gnssrtk3_drv_interface_sel()

void gnssrtk3_drv_interface_sel	(	gnssrtk3_cfg_t *	cfg,
		gnssrtk3_drv_t	drv_sel )

GNSS RTK 3 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 gnssrtk3_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See gnssrtk3_drv_t object definition for detailed explanation.

Returns: Nothing.

Note: This driver selection should be called 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.

◆ gnssrtk3_enable_device()

void gnssrtk3_enable_device ( gnssrtk3_t * ctx )

GNSS RTK 3 enable device function.

This function enables the device by setting the CEN pin to high logic state.

Parameters

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

Returns: None.

Note: None.

◆ gnssrtk3_generic_read()

err_t gnssrtk3_generic_read	(	gnssrtk3_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

GNSS RTK 3 data reading function.

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

Parameters

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

◆ gnssrtk3_generic_write()

err_t gnssrtk3_generic_write	(	gnssrtk3_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

GNSS RTK 3 data writing function.

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

Parameters

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

◆ gnssrtk3_get_pps_pin()

uint8_t gnssrtk3_get_pps_pin ( gnssrtk3_t * ctx )

GNSS RTK 3 get PPS pin function.

This function returns the PPS pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ gnssrtk3_init()

err_t gnssrtk3_init	(	gnssrtk3_t *	ctx,
		gnssrtk3_cfg_t *	cfg )

GNSS RTK 3 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ gnssrtk3_parse_gga()

err_t gnssrtk3_parse_gga	(	uint8_t *	rsp_buf,
		uint8_t	gga_element,
		uint8_t *	element_data )

GNSS RTK 3 parse GGA function.

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

Parameters

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

Returns

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

Note: None.

◆ gnssrtk3_reset_device()

void gnssrtk3_reset_device ( gnssrtk3_t * ctx )

GNSS RTK 3 reset device function.

This function resets the device by toggling the RST pin.

Parameters

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

Returns: None.

Note: None.

◆ gnssrtk3_set_cen_pin()

void gnssrtk3_set_cen_pin	(	gnssrtk3_t *	ctx,
		uint8_t	state )

GNSS RTK 3 set CEN pin function.

This function sets the CEN pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ gnssrtk3_set_rst_pin()

void gnssrtk3_set_rst_pin	(	gnssrtk3_t *	ctx,
		uint8_t	state )

GNSS RTK 3 set RST pin function.

This function sets the RST pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ gnssrtk3_set_wup_pin()

void gnssrtk3_set_wup_pin	(	gnssrtk3_t *	ctx,
		uint8_t	state )

GNSS RTK 3 set WUP pin function.

This function sets the WUP pin logic state.

Parameters

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

Returns: None.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ gnssrtk3_cfg_setup()

◆ gnssrtk3_disable_device()

◆ gnssrtk3_drv_interface_sel()

◆ gnssrtk3_enable_device()

◆ gnssrtk3_generic_read()

◆ gnssrtk3_generic_write()

◆ gnssrtk3_get_pps_pin()

◆ gnssrtk3_init()

◆ gnssrtk3_parse_gga()

◆ gnssrtk3_reset_device()

◆ gnssrtk3_set_cen_pin()

◆ gnssrtk3_set_rst_pin()

◆ gnssrtk3_set_wup_pin()