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

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

#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
 Click ctx object definition. More...
 
struct  gsm4_cfg_t
 Click configuration structure definition. More...
 

Macros

#define GSM4_MAP_MIKROBUS(cfg, mikrobus)
 
#define GSM4_RETVAL   uint8_t
 
#define GSM4_OK   0x00
 
#define GSM4_INIT_ERROR   0xFF
 
#define GSM4_PARSER_NO_ERROR   0x00
 
#define GSM4_PARSER_ERROR_REF   0x01
 
#define GSM4_PARSER_ERROR_CMD   0x02
 
#define GSM4_PARSER_ERROR_DATA   0x04
 
#define GSM4_STATUS_DEVICE_READY   1
 
#define GSM4_STATUS_ACT_NETWORK_AND_BROKER   4
 
#define GSM4_STATUS_ACT_NETWORK   2
 
#define GSM4_STATUS_ACT_BROKER   3
 
#define GSM4_STATUS_DEVICE_BUSY   0
 
#define GSM4_MODULE_POWER_ON   1
 
#define GSM4_MODULE_POWER_OFF   0
 
#define GSM4_SINGLE_CMD_AT   "AT"
 
#define GSM4_SINGLE_CMD_AT_W   "AT+W"
 
#define GSM4_SINGLE_CMD_AT_R   "AT+R"
 
#define GSM4_SINGLE_CMD_ATE0   "ATE0"
 
#define GSM4_SINGLE_CMD_ATE1   "ATE1"
 
#define GSM4_SINGLE_CMD_AT_RST   "AT+RST"
 
#define GSM4_SINGLE_CMD_AT_CRST   "AT+CRST"
 
#define GSM4_SINGLE_CMD_AT_GMR   "AT+GMR"
 
#define GSM4_SINGLE_CMD_AT_GMSTA   "AT+GMSTA"
 
#define GSM4_SINGLE_CMD_AT_PUB   "AT+PUB"
 
#define GSM4_SINGLE_CMD_SET_AT_LRSP_1   "AT+LRSP=1"
 
#define GSM4_SINGLE_CMD_SET_AT_LRSP_0   "AT+LRSP=0"
 
#define GSM4_SINGLE_CMD_SET_AT_CEN_1   "AT+CEN=1"
 
#define GSM4_SINGLE_CMD_SET_AT_CEN_0   "AT+CEN=0"
 
#define GSM4_SINGLE_CMD_SET_AT_NWC_1   "AT+NWC=1"
 
#define GSM4_SINGLE_CMD_SET_AT_NWC_0   "AT+NWC=0"
 
#define GSM4_SINGLE_CMD_SET_AT_BRC_1   "AT+BRC=1"
 
#define GSM4_SINGLE_CMD_SET_AT_BRC_0   "AT+BRC=0"
 
#define GSM4_SINGLE_CMD_SET_AT_GPEN_0   "AT+GPEN=0"
 
#define GSM4_SINGLE_CMD_SET_AT_GPEN_1   "AT+GPEN=1"
 
#define GSM4_SINGLE_CMD_GET_AT_LRSP   "AT+LRSP?"
 
#define GSM4_SINGLE_CMD_GET_AT_CEN   "AT+CEN?"
 
#define GSM4_SINGLE_CMD_GET_AT_NWC   "AT+NWC?"
 
#define GSM4_SINGLE_CMD_GET_AT_BRC   "AT+BRC?"
 
#define GSM4_SINGLE_CMD_GET_AT_GPEN   "AT+GPEN?"
 
#define GSM4_SINGLE_CMD_GET_AT_NWCR   "AT+NWCR?"
 
#define GSM4_SINGLE_CMD_GET_AT_BRCR   "AT+BRCR?"
 
#define GSM4_SINGLE_CMD_GET_AT_DSET   "AT+DSET?"
 
#define GSM4_SINGLE_CMD_TEST_AT_LRSP   "AT+LRSP=?"
 
#define GSM4_SINGLE_CMD_TEST_AT_CEN   "AT+CEN=?"
 
#define GSM4_SINGLE_CMD_TEST_AT_NWC   "AT+NWC=?"
 
#define GSM4_SINGLE_CMD_TEST_AT_BRC   "AT+BRC=?"
 
#define GSM4_SINGLE_CMD_TEST_AT_GPEN   "AT+GPEN=?"
 
#define GSM4_SINGLE_CMD_TEST_AT_NWCR   "AT+NWCR=?"
 
#define GSM4_SINGLE_CMD_TEST_AT_BRCR   "AT+BRCR=?"
 
#define GSM4_SINGLE_CMD_TEST_AT_DSET   "AT+DSET=?"
 
#define GSM4_MULTI_CMD_AT_DSET   "AT+DSET"
 
#define GSM4_MULTI_CMD_AT_BRCR   "AT+BRCR"
 
#define GSM4_MULTI_CMD_AT_NWCR   "AT+NWCR"
 
#define DRV_RX_BUFFER_SIZE   500
 

Typedefs

typedef uint8_t gsm4_actuator_sw_t
 Error type. More...
 
typedef int16_t gsm4_actuator_cnt_t
 
typedef char gsm4_actuator_str_t
 
typedef uint8_t gsm4_error_t
 

Functions

void gsm4_cfg_setup (gsm4_cfg_t *cfg)
 Config Object Initialization function. More...
 
GSM4_RETVAL gsm4_init (gsm4_t *ctx, gsm4_cfg_t *cfg)
 Initialization function. More...
 
void gsm4_module_power (gsm4_t *ctx)
 Enables or disables module power. More...
 
void gsm4_reset (gsm4_t *ctx)
 Reset module. More...
 
void gsm4_generic_write (gsm4_t *ctx, char *data_buf, uint16_t len)
 Generic write function. More...
 
int16_t gsm4_generic_read (gsm4_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function. More...
 
void gsm4_send_command (gsm4_t *ctx, char *command)
 Command function. More...
 

Detailed Description

This file contains API for GSM 4 Click driver.