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

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

Data Structures
struct	gsm5_t
	GSM 5 Click context object. More...

struct	gsm5_cfg_t
	GSM 5 Click configuration object. More...

Macros
#define	GSM5_CMD_AT "AT"
	GSM 5 control commands.

#define	GSM5_CMD_ATI "ATI"

#define	GSM5_CMD_CGMR "AT+CGMR"

#define	GSM5_CMD_CFUN "AT+CFUN"

#define	GSM5_CMD_CREG "AT+CREG"

#define	GSM5_CMD_CGREG "AT+CGREG"

#define	GSM5_CMD_CGDCONT "AT+CGDCONT"

#define	GSM5_CMD_CIMI "AT+CIMI"

#define	GSM5_CMD_CMEE "AT+CMEE"

#define	GSM5_CMD_CGATT "AT+CGATT"

#define	GSM5_CMD_CSQ "AT+CSQ"

#define	GSM5_CMD_COPS "AT+COPS"

#define	GSM5_CMD_CMGS "AT+CMGS"

#define	GSM5_CMD_CMGF "AT+CMGF"

#define	GSM5_CMD_CGACT "AT+CGACT"

#define	GSM5_CMD_UPSDA "AT+UPSDA"

#define	GSM5_CMD_USOCR "AT+USOCR"

#define	GSM5_CMD_USOCO "AT+USOCO"

#define	GSM5_CMD_USOWR "AT+USOWR"

#define	GSM5_CMD_USORD "AT+USORD"

#define	GSM5_CMD_USORF "AT+USORF"

#define	GSM5_CMD_USOCL "AT+USOCL"

#define	GSM5_RSP_OK "OK"
	GSM 5 device response for AT commands.

#define	GSM5_RSP_ERROR "ERROR"

#define	DRV_BUFFER_SIZE 256
	GSM 5 driver buffer size.

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

Enumerations
enum	gsm5_return_value_t { GSM5_OK = 0 , GSM5_ERROR = -1 , GSM5_ERROR_TIMEOUT = -2 , GSM5_ERROR_CMD = -3 , GSM5_ERROR_UNKNOWN = -4 }
	GSM 5 Click return value data. More...

Functions
void	gsm5_cfg_setup (gsm5_cfg_t *cfg)
	GSM 5 configuration object setup function.

err_t	gsm5_init (gsm5_t ctx, gsm5_cfg_t cfg)
	GSM 5 initialization function.

err_t	gsm5_generic_write (gsm5_t ctx, char data_buf, uint16_t len)
	GSM 5 data writing function.

err_t	gsm5_generic_read (gsm5_t ctx, char data_buf, uint16_t len)
	GSM 5 data reading function.

void	gsm5_set_on_pin (gsm5_t *ctx, uint8_t state)
	Sets state of the ON pin.

void	gsm5_set_off_pin (gsm5_t *ctx, uint8_t state)
	Sets state of the OFF pin.

void	gsm5_set_rts_pin (gsm5_t *ctx, uint8_t state)
	Sets state of the RTS pin.

uint8_t	gsm5_get_ring_pin (gsm5_t *ctx)
	RING Pin Get function.

uint8_t	gsm5_get_cts_pin (gsm5_t *ctx)
	CTS Pin Get function.

void	gsm5_module_power_on (gsm5_t *ctx)
	Power ON the module function.

void	gsm5_send_cmd (gsm5_t ctx, char cmd)
	Send command function.

void	gsm5_send_cmd_with_parameter (gsm5_t ctx, char at_cmd_buf, char *param_buf)
	Send command function with parameter.

void	gsm5_send_cmd_check (gsm5_t ctx, char at_cmd_buf)
	Check the sent command.

void	gsm5_send_cmd_parameter_check (gsm5_t ctx, char at_cmd_buf)
	Check the command parameters.

void	gsm5_set_sim_apn (gsm5_t ctx, char sim_apn)
	Set sim card APN.

void	gsm5_send_sms_text (gsm5_t ctx, char phone_number, char *sms_text)
	GSM 5 send SMS in text mode.

err_t	gsm5_send_sms_pdu (gsm5_t ctx, char service_center_number, char phone_number, char sms_text)
	GSM 5 send SMS in PDU mode.

Detailed Description

This file contains API for GSM 5 Click Driver.

Enumeration Type Documentation

GSM 5 Click return value data.

Predefined enum values for driver return values.