API for configuring and manipulating LTE Cat.1 2 Click driver. More...

Topics
	LTE Cat.1 2 Device Settings
	Settings for registers of LTE Cat.1 2 Click driver.

	LTE Cat.1 2 MikroBUS Map
	MikroBUS pin mapping of LTE Cat.1 2 Click driver.

Functions
void	ltecat12_cfg_setup (ltecat12_cfg_t *cfg)
	LTE Cat.1 2 configuration object setup function.

err_t	ltecat12_init (ltecat12_t ctx, ltecat12_cfg_t cfg)
	LTE Cat.1 2 initialization function.

err_t	ltecat12_generic_write (ltecat12_t ctx, uint8_t data_in, uint16_t len)
	LTE Cat.1 2 data writing function.

err_t	ltecat12_generic_read (ltecat12_t ctx, uint8_t data_out, uint16_t len)
	LTE Cat.1 2 data reading function.

err_t	ltecat12_write_register (ltecat12_t *ctx, uint8_t reg, uint8_t data_in)
	LTE Cat.1 2 MAX9860 writing function.

err_t	ltecat12_read_register (ltecat12_t ctx, uint8_t reg, uint8_t data_out)
	LTE Cat.1 2 MAX9860 reading function.

err_t	ltecat12_max9860_cfg (ltecat12_t *ctx)
	LTE Cat.1 2 MAX9860 configuration function.

void	ltecat12_set_fsd_pin (ltecat12_t *ctx, uint8_t state)
	LTE Cat.1 2 set fsd pin function.

void	ltecat12_set_rts_pin (ltecat12_t *ctx, uint8_t state)
	LTE Cat.1 2 set rts pin function.

uint8_t	ltecat12_get_cts_pin (ltecat12_t *ctx)
	LTE Cat.1 2 get cts pin function.

void	ltecat12_send_cmd (ltecat12_t ctx, uint8_t cmd)
	LTE Cat.1 2 send command function.

void	ltecat12_send_cmd_with_params (ltecat12_t ctx, uint8_t at_cmd_buf, uint8_t *param_buf)
	LTE Cat.1 2 send command function with parameter.

void	ltecat12_send_cmd_check (ltecat12_t ctx, uint8_t at_cmd_buf)
	LTE Cat.1 2 check the sent command.

void	ltecat12_send_cmd_parameter_check (ltecat12_t ctx, uint8_t at_cmd_buf)
	LTE Cat.1 2 check the command parameters.

void	ltecat12_set_sim_apn (ltecat12_t ctx, uint8_t sim_apn)
	LTE Cat.1 2 set sim card APN.

void	ltecat12_send_sms_text (ltecat12_t ctx, uint8_t phone_number, uint8_t *sms_text)
	LTE Cat.1 2 send SMS in text mode.

err_t	ltecat12_send_sms_pdu (ltecat12_t ctx, uint8_t service_center_number, uint8_t phone_number, uint8_t sms_text)
	LTE Cat.1 2 send SMS in PDU mode.

Detailed Description

API for configuring and manipulating LTE Cat.1 2 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

◆ ltecat12_cfg_setup()

void ltecat12_cfg_setup ( ltecat12_cfg_t * cfg )

LTE Cat.1 2 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ ltecat12_generic_read()

err_t ltecat12_generic_read	(	ltecat12_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

LTE Cat.1 2 data reading function.

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

Parameters

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

◆ ltecat12_generic_write()

err_t ltecat12_generic_write	(	ltecat12_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

LTE Cat.1 2 data writing function.

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

Parameters

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

◆ ltecat12_get_cts_pin()

uint8_t ltecat12_get_cts_pin ( ltecat12_t * ctx )

LTE Cat.1 2 get cts pin function.

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

Parameters

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

Returns: Pin logic state.

Note: None.

◆ ltecat12_init()

err_t ltecat12_init	(	ltecat12_t *	ctx,
		ltecat12_cfg_t *	cfg )

LTE Cat.1 2 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ ltecat12_max9860_cfg()

err_t ltecat12_max9860_cfg ( ltecat12_t * ctx )

LTE Cat.1 2 MAX9860 configuration function.

This function is used to set basic config for MAX9860 of LTE Cat.1 2 click board.

Parameters

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

Returns

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

Note: Some gain levels need to be configured for different headphones.

◆ ltecat12_read_register()

err_t ltecat12_read_register	(	ltecat12_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out )

LTE Cat.1 2 MAX9860 reading function.

This function reads a data byte from the selected register address.

Parameters

[in]	ctx	: Click context object. See ltecat12_t object definition for detailed explanation.
[in]	reg	: Register address.
[out]	data_out	: Output read data.

Returns

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

Note: None.

◆ ltecat12_send_cmd()

void ltecat12_send_cmd	(	ltecat12_t *	ctx,
		uint8_t *	cmd )

LTE Cat.1 2 send command function.

This function sends a specified command to the click module.

Parameters

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

Returns: Nothing.

Note: None.

◆ ltecat12_send_cmd_check()

void ltecat12_send_cmd_check	(	ltecat12_t *	ctx,
		uint8_t *	at_cmd_buf )

LTE Cat.1 2 check the sent command.

This function checks the command that is sent.

Parameters

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

Returns: Nothing.

Note: None.

◆ ltecat12_send_cmd_parameter_check()

void ltecat12_send_cmd_parameter_check	(	ltecat12_t *	ctx,
		uint8_t *	at_cmd_buf )

LTE Cat.1 2 check the command parameters.

This function checks the command that is sent.

Parameters

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

Returns: Nothing.

Note: None.

◆ ltecat12_send_cmd_with_params()

void ltecat12_send_cmd_with_params	(	ltecat12_t *	ctx,
		uint8_t *	at_cmd_buf,
		uint8_t *	param_buf )

LTE Cat.1 2 send command function with parameter.

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

Parameters

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

Returns: Nothing.

Note: None.

◆ ltecat12_send_sms_pdu()

err_t ltecat12_send_sms_pdu	(	ltecat12_t *	ctx,
		uint8_t *	service_center_number,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

LTE Cat.1 2 send SMS in PDU mode.

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

Parameters

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

◆ ltecat12_send_sms_text()

void ltecat12_send_sms_text	(	ltecat12_t *	ctx,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

LTE Cat.1 2 send SMS in text mode.

This function sends text message to a phone number.

Parameters

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

Returns: Nothing.

Note: None.

◆ ltecat12_set_fsd_pin()

void ltecat12_set_fsd_pin	(	ltecat12_t *	ctx,
		uint8_t	state )

LTE Cat.1 2 set fsd pin function.

This function sets the FSD pin logic state.

Parameters

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

Returns: None.

Note: In order to use this pin you need to add R27.

◆ ltecat12_set_rts_pin()

void ltecat12_set_rts_pin	(	ltecat12_t *	ctx,
		uint8_t	state )

LTE Cat.1 2 set rts pin function.

This function sets the RTS pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ ltecat12_set_sim_apn()

void ltecat12_set_sim_apn	(	ltecat12_t *	ctx,
		uint8_t *	sim_apn )

LTE Cat.1 2 set sim card APN.

This function sets APN for sim card.

Parameters

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

Returns: Nothing.

Note: None.

◆ ltecat12_write_register()

err_t ltecat12_write_register	(	ltecat12_t *	ctx,
		uint8_t	reg,
		uint8_t	data_in )

LTE Cat.1 2 MAX9860 writing function.

This function writes a data byte into the selected register address.

Parameters

[in]	ctx	: Click context object. See ltecat12_t object definition for detailed explanation.
[in]	reg	: Register address.
[in]	data_in	: Data buffer for sending.

Returns

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

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ ltecat12_cfg_setup()

◆ ltecat12_generic_read()

◆ ltecat12_generic_write()

◆ ltecat12_get_cts_pin()

◆ ltecat12_init()

◆ ltecat12_max9860_cfg()

◆ ltecat12_read_register()

◆ ltecat12_send_cmd()

◆ ltecat12_send_cmd_check()

◆ ltecat12_send_cmd_parameter_check()

◆ ltecat12_send_cmd_with_params()

◆ ltecat12_send_sms_pdu()

◆ ltecat12_send_sms_text()

◆ ltecat12_set_fsd_pin()

◆ ltecat12_set_rts_pin()

◆ ltecat12_set_sim_apn()

◆ ltecat12_write_register()