API for configuring and manipulating 4G LTE GNSS Click driver. More...

Topics
	4G LTE GNSS Device Settings
	Settings for registers of 4G LTE GNSS Click driver.

	4G LTE GNSS MikroBUS Map
	MikroBUS pin mapping of 4G LTE GNSS Click driver.

Functions
void	c4gltegnss_cfg_setup (c4gltegnss_cfg_t *cfg)
	4G LTE GNSS configuration object setup function.

err_t	c4gltegnss_init (c4gltegnss_t ctx, c4gltegnss_cfg_t cfg)
	4G LTE GNSS initialization function.

err_t	c4gltegnss_generic_write (c4gltegnss_t ctx, uint8_t data_in, uint16_t len)
	4G LTE GNSS data writing function.

err_t	c4gltegnss_generic_read (c4gltegnss_t ctx, uint8_t data_out, uint16_t len)
	4G LTE GNSS data reading function.

void	c4gltegnss_set_pwr_pin (c4gltegnss_t *ctx, uint8_t state)
	4G LTE GNSS set PWR pin function.

void	c4gltegnss_set_rts_pin (c4gltegnss_t *ctx, uint8_t state)
	4G LTE GNSS set rts pin function.

uint8_t	c4gltegnss_get_ri_pin (c4gltegnss_t *ctx)
	4G LTE GNSS get RI pin function.

uint8_t	c4gltegnss_get_cts_pin (c4gltegnss_t *ctx)
	4G LTE GNSS get cts pin function.

void	c4gltegnss_set_power_state (c4gltegnss_t *ctx, uint8_t state)
	4G LTE GNSS set power state function.

void	c4gltegnss_send_cmd (c4gltegnss_t ctx, uint8_t cmd)
	Send command function.

void	c4gltegnss_send_cmd_with_par (c4gltegnss_t ctx, uint8_t at_cmd_buf, uint8_t *param_buf)
	Send command function with parameter.

void	c4gltegnss_send_cmd_check (c4gltegnss_t ctx, uint8_t at_cmd_buf)
	Check the sent command.

void	c4gltegnss_send_cmd_par_check (c4gltegnss_t ctx, uint8_t at_cmd_buf)
	Check the command parameters.

void	c4gltegnss_set_sim_apn (c4gltegnss_t ctx, uint8_t sim_apn)
	Set sim card APN.

void	c4gltegnss_send_sms_text (c4gltegnss_t ctx, uint8_t phone_number, uint8_t *sms_text)
	4G LTE GNSS send SMS in text mode.

err_t	c4gltegnss_send_sms_pdu (c4gltegnss_t ctx, uint8_t service_center_number, uint8_t phone_number, uint8_t sms_text)
	4G LTE GNSS send SMS in PDU mode.

err_t	c4gltegnss_parse_gga (uint8_t rsp_buf, uint8_t gga_element, uint8_t element_data)
	4G LTE GNSS parse GGA function.

Detailed Description

API for configuring and manipulating 4G LTE GNSS 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

◆ c4gltegnss_cfg_setup()

void c4gltegnss_cfg_setup ( c4gltegnss_cfg_t * cfg )

4G LTE GNSS configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ c4gltegnss_generic_read()

err_t c4gltegnss_generic_read	(	c4gltegnss_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

4G LTE GNSS data reading function.

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

Parameters

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

◆ c4gltegnss_generic_write()

err_t c4gltegnss_generic_write	(	c4gltegnss_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

4G LTE GNSS data writing function.

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

Parameters

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

◆ c4gltegnss_get_cts_pin()

uint8_t c4gltegnss_get_cts_pin ( c4gltegnss_t * ctx )

4G LTE GNSS get cts pin function.

This function returns the clear to send (CTS) pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ c4gltegnss_get_ri_pin()

uint8_t c4gltegnss_get_ri_pin ( c4gltegnss_t * ctx )

4G LTE GNSS get RI pin function.

This function returns the ring indication (RI) pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ c4gltegnss_init()

err_t c4gltegnss_init	(	c4gltegnss_t *	ctx,
		c4gltegnss_cfg_t *	cfg )

4G LTE GNSS initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ c4gltegnss_parse_gga()

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

4G LTE GNSS 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.

◆ c4gltegnss_send_cmd()

void c4gltegnss_send_cmd	(	c4gltegnss_t *	ctx,
		uint8_t *	cmd )

Send command function.

This function sends a specified command to the click module.

Parameters

[in]	ctx	: Click context object. See c4gltegnss_t object definition for detailed explanation.
[in]	cmd	: Command variable.

Returns: Nothing.

Note: None.

◆ c4gltegnss_send_cmd_check()

void c4gltegnss_send_cmd_check	(	c4gltegnss_t *	ctx,
		uint8_t *	at_cmd_buf )

Check the sent command.

This function checks the command that is sent.

Parameters

[in]	ctx	: Click context object. See c4gltegnss_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.

Returns: Nothing.

Note: None.

◆ c4gltegnss_send_cmd_par_check()

void c4gltegnss_send_cmd_par_check	(	c4gltegnss_t *	ctx,
		uint8_t *	at_cmd_buf )

Check the command parameters.

This function checks the command that is sent.

Parameters

[in]	ctx	: Click context object. See c4gltegnss_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.

Returns: Nothing.

Note: None.

◆ c4gltegnss_send_cmd_with_par()

void c4gltegnss_send_cmd_with_par	(	c4gltegnss_t *	ctx,
		uint8_t *	at_cmd_buf,
		uint8_t *	param_buf )

Send command function with parameter.

This function sends a command with specified parameter to the click module.

Parameters

[in]	ctx	: Click context object. See c4gltegnss_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.
[in]	param_buf	: Parameter buffer.

Returns: Nothing.

Note: None.

◆ c4gltegnss_send_sms_pdu()

err_t c4gltegnss_send_sms_pdu	(	c4gltegnss_t *	ctx,
		uint8_t *	service_center_number,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

4G LTE GNSS send SMS in PDU mode.

This function sends text message to a phone number in PDU mode.

Parameters

[in]	ctx	: Click context object. See c4gltegnss_t object definition for detailed explanation.
[in]	service_center_number	: SMSC of the SIM card.
[in]	phone_number	: Phone number to message.
[in]	sms_text	: Message to be sent.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ c4gltegnss_send_sms_text()

void c4gltegnss_send_sms_text	(	c4gltegnss_t *	ctx,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

4G LTE GNSS send SMS in text mode.

This function sends text message to a phone number.

Parameters

[in]	ctx	: Click context object. See c4gltegnss_t object definition for detailed explanation.
[in]	phone_number	: Phone number to message.
[in]	sms_text	: Message to be sent.

Returns: Nothing.

Note: None.

◆ c4gltegnss_set_power_state()

void c4gltegnss_set_power_state	(	c4gltegnss_t *	ctx,
		uint8_t	state )

4G LTE GNSS set power state function.

This function sets a desired power state by toggling PWR pin with a specific time for high state.

Parameters

[in]	ctx	: Click context object. See c4gltegnss_t object definition for detailed explanation.
[in]	state	: `0` - Power OFF, `1` - Power ON.

Returns: None.

Note: None.

◆ c4gltegnss_set_pwr_pin()

void c4gltegnss_set_pwr_pin	(	c4gltegnss_t *	ctx,
		uint8_t	state )

4G LTE GNSS set PWR pin function.

This function sets the PWR pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ c4gltegnss_set_rts_pin()

void c4gltegnss_set_rts_pin	(	c4gltegnss_t *	ctx,
		uint8_t	state )

4G LTE GNSS set rts pin function.

This function sets the RTS pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ c4gltegnss_set_sim_apn()

void c4gltegnss_set_sim_apn	(	c4gltegnss_t *	ctx,
		uint8_t *	sim_apn )

Set sim card APN.

This function sets APN for sim card.

Parameters

[in]	ctx	: Click context object. See c4gltegnss_t object definition for detailed explanation.
[in]	sim_apn	: SIM card APN.

Returns: Nothing.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ c4gltegnss_cfg_setup()

◆ c4gltegnss_generic_read()

◆ c4gltegnss_generic_write()

◆ c4gltegnss_get_cts_pin()

◆ c4gltegnss_get_ri_pin()

◆ c4gltegnss_init()

◆ c4gltegnss_parse_gga()

◆ c4gltegnss_send_cmd()

◆ c4gltegnss_send_cmd_check()

◆ c4gltegnss_send_cmd_par_check()

◆ c4gltegnss_send_cmd_with_par()

◆ c4gltegnss_send_sms_pdu()

◆ c4gltegnss_send_sms_text()

◆ c4gltegnss_set_power_state()

◆ c4gltegnss_set_pwr_pin()

◆ c4gltegnss_set_rts_pin()

◆ c4gltegnss_set_sim_apn()