API for configuring and manipulating GSM Click driver. More...

Topics
	GSM Device Settings
	Settings for registers of GSM Click driver.

	GSM MikroBUS Map
	MikroBUS pin mapping of GSM Click driver.

Functions
void	gsm_cfg_setup (gsm_cfg_t *cfg)
	GSM configuration object setup function.

err_t	gsm_init (gsm_t ctx, gsm_cfg_t cfg)
	GSM initialization function.

err_t	gsm_generic_write (gsm_t ctx, uint8_t data_in, uint16_t len)
	GSM data writing function.

err_t	gsm_generic_read (gsm_t ctx, uint8_t data_out, uint16_t len)
	GSM data reading function.

void	gsm_set_rts_pin (gsm_t *ctx, uint8_t state)
	GSM set rts pin function.

void	gsm_set_rst_pin (gsm_t *ctx, uint8_t state)
	GSM set rst pin function.

uint8_t	gsm_get_cts_pin (gsm_t *ctx)
	GSM get cts pin function.

uint8_t	gsm_get_pwr_pin (gsm_t *ctx)
	GSM get pwr pin function.

uint8_t	gsm_get_gp2_pin (gsm_t *ctx)
	GSM get gp2 pin function.

void	gsm_send_cmd (gsm_t ctx, uint8_t cmd)
	Send command function.

void	gsm_send_cmd_with_par (gsm_t ctx, uint8_t at_cmd_buf, uint8_t *param_buf)
	Send command function with parameter.

void	gsm_send_cmd_check (gsm_t ctx, uint8_t at_cmd_buf)
	Check the sent command.

void	gsm_send_cmd_par_check (gsm_t ctx, uint8_t at_cmd_buf)
	Check the command parameters.

void	gsm_set_sim_apn (gsm_t ctx, uint8_t sim_apn)
	Set sim card APN.

void	gsm_send_sms_text (gsm_t ctx, uint8_t phone_number, uint8_t *sms_text)
	GSM send SMS in text mode.

err_t	gsm_send_sms_pdu (gsm_t ctx, uint8_t service_center_number, uint8_t phone_number, uint8_t sms_text)
	GSM send SMS in PDU mode.

Detailed Description

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

◆ gsm_cfg_setup()

void gsm_cfg_setup ( gsm_cfg_t * cfg )

GSM configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ gsm_generic_read()

err_t gsm_generic_read	(	gsm_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

GSM data reading function.

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

Parameters

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

◆ gsm_generic_write()

err_t gsm_generic_write	(	gsm_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

GSM data writing function.

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

Parameters

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

◆ gsm_get_cts_pin()

uint8_t gsm_get_cts_pin ( gsm_t * ctx )

GSM get cts pin function.

This function returns the Clear to Send (CTS) pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ gsm_get_gp2_pin()

uint8_t gsm_get_gp2_pin ( gsm_t * ctx )

GSM get gp2 pin function.

This function returns the GPIO2 pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ gsm_get_pwr_pin()

uint8_t gsm_get_pwr_pin ( gsm_t * ctx )

GSM get pwr pin function.

This function returns the PWR monitor pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ gsm_init()

err_t gsm_init	(	gsm_t *	ctx,
		gsm_cfg_t *	cfg )

GSM initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ gsm_send_cmd()

void gsm_send_cmd	(	gsm_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 gsm_t object definition for detailed explanation.
[in]	cmd	: Command variable.

Returns: Nothing.

Note: None.

◆ gsm_send_cmd_check()

void gsm_send_cmd_check	(	gsm_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 gsm_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.

Returns: Nothing.

Note: None.

◆ gsm_send_cmd_par_check()

void gsm_send_cmd_par_check	(	gsm_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 gsm_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.

Returns: Nothing.

Note: None.

◆ gsm_send_cmd_with_par()

void gsm_send_cmd_with_par	(	gsm_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 gsm_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.
[in]	param_buf	: Parameter buffer.

Returns: Nothing.

Note: None.

◆ gsm_send_sms_pdu()

err_t gsm_send_sms_pdu	(	gsm_t *	ctx,
		uint8_t *	service_center_number,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

GSM send SMS in PDU mode.

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

Parameters

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

◆ gsm_send_sms_text()

void gsm_send_sms_text	(	gsm_t *	ctx,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

GSM send SMS in text mode.

This function sends text message to a phone number.

Parameters

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

Returns: Nothing.

Note: None.

◆ gsm_set_rst_pin()

void gsm_set_rst_pin	(	gsm_t *	ctx,
		uint8_t	state )

GSM set rst pin function.

This function sets the RESET pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ gsm_set_rts_pin()

void gsm_set_rts_pin	(	gsm_t *	ctx,
		uint8_t	state )

GSM set rts pin function.

This function sets the Request to Send (RTS) pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ gsm_set_sim_apn()

void gsm_set_sim_apn	(	gsm_t *	ctx,
		uint8_t *	sim_apn )

Set sim card APN.

This function sets APN for sim card.

Parameters

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

Returns: Nothing.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ gsm_cfg_setup()

◆ gsm_generic_read()

◆ gsm_generic_write()

◆ gsm_get_cts_pin()

◆ gsm_get_gp2_pin()

◆ gsm_get_pwr_pin()

◆ gsm_init()

◆ gsm_send_cmd()

◆ gsm_send_cmd_check()

◆ gsm_send_cmd_par_check()

◆ gsm_send_cmd_with_par()

◆ gsm_send_sms_pdu()

◆ gsm_send_sms_text()

◆ gsm_set_rst_pin()

◆ gsm_set_rts_pin()

◆ gsm_set_sim_apn()