This file contains API for GSM Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Data Structures
struct	gsm_t
	GSM Click context object. More...

struct	gsm_cfg_t
	GSM Click configuration object. More...

Macros
#define	GSM_CMD_AT "AT"
	GSM control commands.

#define	GSM_CMD_ATI "ATI"

#define	GSM_CMD_CFUN "AT+CFUN"

#define	GSM_CMD_CREG "AT+CREG"

#define	GSM_CMD_CGDCONT "AT+CGDCONT"

#define	GSM_CMD_CSQ "AT+CSQ"

#define	GSM_CMD_COPS "AT+COPS"

#define	GSM_CMD_CMGS "AT+CMGS"

#define	GSM_CMD_CMGF "AT+CMGF"

#define	GSM_CMD_SGACT "AT#SGACT"

#define	GSM_CMD_SD "AT#SD"

#define	GSM_CMD_SH "AT#SH"

#define	GSM_CMD_SSEND "AT#SSEND"

#define	GSM_CMD_SRECV "AT#SRECV"

#define	GSM_RSP_OK "OK"
	GSM device response for AT commands.

#define	GSM_RSP_ERROR "ERROR"

#define	GSM_RX_DRV_BUFFER_SIZE 256
	GSM driver buffer size.

#define	GSM_TX_DRV_BUFFER_SIZE 256

#define	GSM_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	gsm_return_value_t { GSM_OK = 0 , GSM_ERROR = -1 , GSM_ERROR_TIMEOUT = -2 , GSM_ERROR_CMD = -3 , GSM_ERROR_UNKNOWN = -4 }
	GSM Click return value data. More...

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

This file contains API for GSM Click Driver.

Enumeration Type Documentation

GSM Click return value data.

Predefined enum values for driver return values.