gsm4  2.0.0.0
Data Structures | Macros | Enumerations | Functions
gsm4.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  gsm4_t
 GSM 4 Click context object. More...
 
struct  gsm4_cfg_t
 GSM 4 Click configuration object. More...
 

Macros

#define GSM4_CMD_AT   "AT"
 GSM 4 control commands. More...
 
#define GSM4_CMD_CFUN   "AT+CFUN"
 
#define GSM4_CMD_CREG   "AT+CREG"
 
#define GSM4_CMD_CGDCONT   "AT+CGDCONT"
 
#define GSM4_CMD_CSQ   "AT+CSQ"
 
#define GSM4_CMD_COPS   "AT+COPS"
 
#define GSM4_CMD_CMGS   "AT+CMGS"
 
#define GSM4_CMD_CMGF   "AT+CMGF"
 
#define GSM4_CMD_CGACT   "AT+CGACT"
 
#define GSM4_CMD_UPSDA   "AT+UPSDA"
 
#define GSM4_CMD_USOCR   "AT+USOCR"
 
#define GSM4_CMD_USOCO   "AT+USOCO"
 
#define GSM4_CMD_USOWR   "AT+USOWR"
 
#define GSM4_CMD_USORD   "AT+USORD"
 
#define GSM4_CMD_USORF   "AT+USORF"
 
#define GSM4_CMD_USOCL   "AT+USOCL"
 
#define GSM4_RSP_OK   "OK"
 GSM 4 device response for AT commands. More...
 
#define GSM4_RSP_ERROR   "ERROR"
 
#define GSM4_RX_DRV_BUFFER_SIZE   256
 GSM 4 driver buffer size. More...
 
#define GSM4_TX_DRV_BUFFER_SIZE   256
 
#define GSM4_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  gsm4_return_value_t {
  GSM4_OK = 0, GSM4_ERROR = -1, GSM4_ERROR_TIMEOUT = -2, GSM4_ERROR_CMD = -3,
  GSM4_ERROR_UNKNOWN = -4
}
 GSM 4 Click return value data. More...
 

Functions

void gsm4_cfg_setup (gsm4_cfg_t *cfg)
 GSM 4 configuration object setup function. More...
 
err_t gsm4_init (gsm4_t *ctx, gsm4_cfg_t *cfg)
 GSM 4 initialization function. More...
 
err_t gsm4_generic_write (gsm4_t *ctx, uint8_t *data_in, uint16_t len)
 GSM 4 data writing function. More...
 
err_t gsm4_generic_read (gsm4_t *ctx, uint8_t *data_out, uint16_t len)
 GSM 4 data reading function. More...
 
void gsm4_set_rts_pin (gsm4_t *ctx, uint8_t state)
 GSM 4 set rts pin function. More...
 
void gsm4_set_pwr_pin (gsm4_t *ctx, uint8_t state)
 GSM 4 set pwr pin function. More...
 
uint8_t gsm4_get_cts_pin (gsm4_t *ctx)
 GSM 4 get cts pin function. More...
 
uint8_t gsm4_get_sta_pin (gsm4_t *ctx)
 GSM 4 get sta pin function. More...
 
uint8_t gsm4_get_ring_pin (gsm4_t *ctx)
 GSM 4 get ring pin function. More...
 
void gsm4_send_cmd (gsm4_t *ctx, uint8_t *cmd)
 Send command function. More...
 
void gsm4_send_cmd_with_par (gsm4_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
 Send command function with parameter. More...
 
void gsm4_send_cmd_check (gsm4_t *ctx, uint8_t *at_cmd_buf)
 Check the sent command. More...
 
void gsm4_send_cmd_par_check (gsm4_t *ctx, uint8_t *at_cmd_buf)
 Check the command parameters. More...
 
void gsm4_set_sim_apn (gsm4_t *ctx, uint8_t *sim_apn)
 Set sim card APN. More...
 
void gsm4_send_sms_text (gsm4_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
 GSM 4 send SMS in text mode. More...
 
err_t gsm4_send_sms_pdu (gsm4_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
 GSM 4 send SMS in PDU mode. More...
 

Detailed Description

This file contains API for GSM 4 Click Driver.

Enumeration Type Documentation

◆ gsm4_return_value_t

GSM 4 Click return value data.

Predefined enum values for driver return values.

Enumerator
GSM4_OK 
GSM4_ERROR 
GSM4_ERROR_TIMEOUT 
GSM4_ERROR_CMD 
GSM4_ERROR_UNKNOWN