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

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

	GSM 3 MikroBUS Map
	MikroBUS pin mapping of GSM 3 Click driver.

Functions
void	gsm3_cfg_setup (gsm3_cfg_t *cfg)
	GSM 3 configuration object setup function.

err_t	gsm3_init (gsm3_t ctx, gsm3_cfg_t cfg)
	GSM 3 initialization function.

err_t	gsm3_generic_write (gsm3_t ctx, uint8_t data_in, uint16_t len)
	GSM 3 data writing function.

err_t	gsm3_generic_read (gsm3_t ctx, uint8_t data_out, uint16_t len)
	GSM 3 data reading function.

void	gsm3_set_rst_pin (gsm3_t *ctx, uint8_t state)
	GSM 3 set rst pin function.

void	gsm3_set_rts_pin (gsm3_t *ctx, uint8_t state)
	GSM 3 set rts pin function.

void	gsm3_set_pwk_pin (gsm3_t *ctx, uint8_t state)
	GSM 3 set pwk pin function.

uint8_t	gsm3_get_cts_pin (gsm3_t *ctx)
	GSM 3 get cts pin function.

uint8_t	gsm3_get_sta_pin (gsm3_t *ctx)
	GSM 3 get sta pin function.

void	gsm3_send_cmd (gsm3_t ctx, uint8_t cmd)
	Send command function.

void	gsm3_send_cmd_with_par (gsm3_t ctx, uint8_t at_cmd_buf, uint8_t *param_buf)
	Send command function with parameter.

void	gsm3_send_cmd_check (gsm3_t ctx, uint8_t at_cmd_buf)
	Check the sent command.

void	gsm3_send_cmd_par_check (gsm3_t ctx, uint8_t at_cmd_buf)
	Check the command parameters.

void	gsm3_set_sim_apn (gsm3_t ctx, uint8_t sim_apn)
	Set sim card APN.

void	gsm3_send_sms_text (gsm3_t ctx, uint8_t phone_number, uint8_t *sms_text)
	GSM 3 send SMS in text mode.

err_t	gsm3_send_sms_pdu (gsm3_t ctx, uint8_t service_center_number, uint8_t phone_number, uint8_t sms_text)
	GSM 3 send SMS in PDU mode.

Detailed Description

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

◆ gsm3_cfg_setup()

void gsm3_cfg_setup ( gsm3_cfg_t * cfg )

GSM 3 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ gsm3_generic_read()

err_t gsm3_generic_read	(	gsm3_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

GSM 3 data reading function.

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

Parameters

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

◆ gsm3_generic_write()

err_t gsm3_generic_write	(	gsm3_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

GSM 3 data writing function.

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

Parameters

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

◆ gsm3_get_cts_pin()

uint8_t gsm3_get_cts_pin ( gsm3_t * ctx )

GSM 3 get cts pin function.

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

Parameters

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

Returns: Pin logic state.

Note: None.

◆ gsm3_get_sta_pin()

uint8_t gsm3_get_sta_pin ( gsm3_t * ctx )

GSM 3 get sta pin function.

This function returns the status (STA) pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ gsm3_init()

err_t gsm3_init	(	gsm3_t *	ctx,
		gsm3_cfg_t *	cfg )

GSM 3 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ gsm3_send_cmd()

void gsm3_send_cmd	(	gsm3_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 gsm3_t object definition for detailed explanation.
[in]	cmd	: Command variable.

Returns: Nothing.

Note: None.

◆ gsm3_send_cmd_check()

void gsm3_send_cmd_check	(	gsm3_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 gsm3_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.

Returns: Nothing.

Note: None.

◆ gsm3_send_cmd_par_check()

void gsm3_send_cmd_par_check	(	gsm3_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 gsm3_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.

Returns: Nothing.

Note: None.

◆ gsm3_send_cmd_with_par()

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

Returns: Nothing.

Note: None.

◆ gsm3_send_sms_pdu()

err_t gsm3_send_sms_pdu	(	gsm3_t *	ctx,
		uint8_t *	service_center_number,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

GSM 3 send SMS in PDU mode.

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

Parameters

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

◆ gsm3_send_sms_text()

void gsm3_send_sms_text	(	gsm3_t *	ctx,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

GSM 3 send SMS in text mode.

This function sends text message to a phone number.

Parameters

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

Returns: Nothing.

Note: None.

◆ gsm3_set_pwk_pin()

void gsm3_set_pwk_pin	(	gsm3_t *	ctx,
		uint8_t	state )

GSM 3 set pwk pin function.

This function sets the PWRKEY pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ gsm3_set_rst_pin()

void gsm3_set_rst_pin	(	gsm3_t *	ctx,
		uint8_t	state )

GSM 3 set rst pin function.

This function sets the RESET pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ gsm3_set_rts_pin()

void gsm3_set_rts_pin	(	gsm3_t *	ctx,
		uint8_t	state )

GSM 3 set rts pin function.

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

Parameters

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

Returns: None.

Note: None.

◆ gsm3_set_sim_apn()

void gsm3_set_sim_apn	(	gsm3_t *	ctx,
		uint8_t *	sim_apn )

Set sim card APN.

This function sets APN for sim card.

Parameters

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

Returns: Nothing.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ gsm3_cfg_setup()

◆ gsm3_generic_read()

◆ gsm3_generic_write()

◆ gsm3_get_cts_pin()

◆ gsm3_get_sta_pin()

◆ gsm3_init()

◆ gsm3_send_cmd()

◆ gsm3_send_cmd_check()

◆ gsm3_send_cmd_par_check()

◆ gsm3_send_cmd_with_par()

◆ gsm3_send_sms_pdu()

◆ gsm3_send_sms_text()

◆ gsm3_set_pwk_pin()

◆ gsm3_set_rst_pin()

◆ gsm3_set_rts_pin()

◆ gsm3_set_sim_apn()