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

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

Data Structures
struct	gsm3_t
	GSM 3 Click context object. More...

struct	gsm3_cfg_t
	GSM 3 Click configuration object. More...

Macros
#define	GSM3_CMD_AT "AT"
	GSM 3 control commands.

#define	GSM3_CMD_CFUN "AT+CFUN"

#define	GSM3_CMD_CREG "AT+CREG"

#define	GSM3_CMD_CGDCONT "AT+CGDCONT"

#define	GSM3_CMD_CSQ "AT+CSQ"

#define	GSM3_CMD_COPS "AT+COPS"

#define	GSM3_CMD_CMGS "AT+CMGS"

#define	GSM3_CMD_CMGF "AT+CMGF"

#define	GSM3_CMD_CIPMUX "AT+CIPMUX"

#define	GSM3_CMD_CIPSTART "AT+CIPSTART"

#define	GSM3_CMD_CIPCLOSE "AT+CIPCLOSE"

#define	GSM3_CMD_CIPSEND "AT+CIPSEND"

#define	GSM3_CMD_CIPHEAD "AT+CIPHEAD"

#define	GSM3_RSP_OK "OK"
	GSM 3 device response for AT commands.

#define	GSM3_RSP_ERROR "ERROR"

#define	GSM3_RX_DRV_BUFFER_SIZE 256
	GSM 3 driver buffer size.

#define	GSM3_TX_DRV_BUFFER_SIZE 256

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

Enumerations
enum	gsm3_return_value_t { GSM3_OK = 0 , GSM3_ERROR = -1 , GSM3_ERROR_TIMEOUT = -2 , GSM3_ERROR_CMD = -3 , GSM3_ERROR_UNKNOWN = -4 }
	GSM 3 Click return value data. More...

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

This file contains API for GSM 3 Click Driver.

Enumeration Type Documentation

GSM 3 Click return value data.

Predefined enum values for driver return values.