File content as of revision 1:bdb1c9f07d06:

/* WIZnet IoT Shield Cat.M1 Sample code for Arm MBED
 * Copyright (c) 2019 WIZnet Co., Ltd.
 * SPDX-License-Identifier: Apache-2.0
 */
 
 /* 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */


#include <string>
#include "mbed.h"

#define RET_OK                      1
#define RET_NOK                     -1
#define DEBUG_ENABLE                1
#define DEBUG_DISABLE               0
#define ON                          1
#define OFF                         0

#define MAX_BUF_SIZE                1024

#define BG96_APN_PROTOCOL_IPv4      1
#define BG96_APN_PROTOCOL_IPv6      2
#define BG96_DEFAULT_TIMEOUT        1000
#define BG96_CONNECT_TIMEOUT        15000
#define BG96_SEND_TIMEOUT           500
#define BG96_RECV_TIMEOUT           500

#define BG96_APN_PROTOCOL           BG96_APN_PROTOCOL_IPv6
#define BG96_DEFAULT_BAUD_RATE      115200
#define BG96_PARSER_DELIMITER       "\r\n"

#define CATM1_APN_SKT               "lte-internet.sktelecom.com"

#define CATM1_DEVICE_NAME_BG96      "BG96"
#define DEVNAME                     CATM1_DEVICE_NAME_BG96

#define devlog(f_, ...)             if(CATM1_DEVICE_DEBUG == DEBUG_ENABLE) { pc.printf("\r\n[%s] ", DEVNAME);  pc.printf((f_), ##__VA_ARGS__); }
#define myprintf(f_, ...)           {pc.printf("\r\n[MAIN] ");  pc.printf((f_), ##__VA_ARGS__);}

/* Pin configuraiton */
// Cat.M1
#define MBED_CONF_IOTSHIELD_CATM1_TX                D8
#define MBED_CONF_IOTSHIELD_CATM1_RX                D2
#define MBED_CONF_IOTSHIELD_CATM1_RESET             D7
#define MBED_CONF_IOTSHIELD_CATM1_PWRKEY            D9

// Sensors
#define MBED_CONF_IOTSHIELD_SENSOR_CDS              A0
#define MBED_CONF_IOTSHIELD_SENSOR_TEMP             A1

/* Debug message settings */
#define BG96_PARSER_DEBUG           DEBUG_DISABLE
#define CATM1_DEVICE_DEBUG          DEBUG_ENABLE 

/* SMS */
#define SMS_EOF                                     0x1A
#define MAX_SMS_SIZE                                100

char phone_number[] = "010xxxxxxxx";
char send_message[] = "WIZnet Cat.M1 IoT shield is powered on";


// Functions: Module Status
void waitCatM1Ready(void);
int8_t setEchoStatus_BG96(bool onoff);
int8_t getUsimStatus_BG96(void);
int8_t getNetworkStatus_BG96(void);
int8_t checknSetApn_BG96(const char * apn);
int8_t getFirmwareVersion_BG96(char * version);

// Functions: SMS
int8_t initSMS_BG96(void);
int8_t sendSMS_BG96(char * da, char * msg, int len);
int checkRecvSMS_BG96(void);
int8_t recvSMS_BG96(int msg_idx, char * msg, char * da, char * datetime);
int8_t deleteSMS_BG96(int msg_idx);
int8_t deleteAllSMS_BG96(int delflag);


Serial pc(USBTX, USBRX);    // USB debug

UARTSerial *_serial;        // Cat.M1 module    
ATCmdParser *_parser;

DigitalOut _RESET_BG96(MBED_CONF_IOTSHIELD_CATM1_RESET);
DigitalOut _PWRKEY_BG96(MBED_CONF_IOTSHIELD_CATM1_PWRKEY);

void serialPcInit(void)
{
    pc.baud(115200);
    pc.format(8, Serial::None, 1);
}

void serialDeviceInit(PinName tx, PinName rx, int baudrate) 
{        
    _serial = new UARTSerial(tx, rx, baudrate);    
}

void serialAtParserInit(const char *delimiter, bool debug_en)
{
    _parser = new ATCmdParser(_serial);    
    _parser->debug_on(debug_en);
    _parser->set_delimiter(delimiter);    
    _parser->set_timeout(BG96_DEFAULT_TIMEOUT);
}

void catm1DeviceInit(void)
{
    serialDeviceInit(   MBED_CONF_IOTSHIELD_CATM1_TX, 
                        MBED_CONF_IOTSHIELD_CATM1_RX, 
                        BG96_DEFAULT_BAUD_RATE);
                        
    serialAtParserInit( BG96_PARSER_DELIMITER, 
                        BG96_PARSER_DEBUG);
}

void catm1DeviceReset_BG96(void)
{
    _RESET_BG96 = 1;
    _PWRKEY_BG96 = 1;
    wait_ms(300);
    
    _RESET_BG96 = 0;
    _PWRKEY_BG96 = 0;
    wait_ms(400);
    
    _RESET_BG96 = 1;    
    wait_ms(1000);
}


// ----------------------------------------------------------------
// Main routine
// ----------------------------------------------------------------

int main()
{
    serialPcInit();    
    catm1DeviceInit();
    
    myprintf("Waiting for Cat.M1 Module Ready...\r\n");
    
    catm1DeviceReset_BG96();
    
    waitCatM1Ready();
    
    wait_ms(5000);
            
    myprintf("System Init Complete\r\n");
        
    myprintf("WIZnet IoT Shield for Arm MBED");
    myprintf("LTE Cat.M1 Version");
    myprintf("=================================================");
    myprintf(">> Target Board: WIoT-QC01 (Quectel BG96)");
    myprintf(">> Sample Code: SMS Send & Recv");
    myprintf("=================================================\r\n");
    
    setEchoStatus_BG96(OFF);
   
    getUsimStatus_BG96();
    
    getNetworkStatus_BG96();
    
    checknSetApn_BG96(CATM1_APN_SKT);
    
    // SMS configuration
    if(initSMS_BG96() != RET_OK) {   
        myprintf("[SMS Init] failed\r\n");
        while(1){;}
    }
    
    // Send a message 
    if(sendSMS_BG96(phone_number, send_message, strlen(send_message)) == RET_OK) {
        myprintf("[SMS Send] to %s, \"%s\"\r\n", phone_number, send_message);
    }
    
#if 0    
    // Delete messages
    deleteAllSMS_BG96(3);
#endif
    
    int msg_idx;
    char recv_message[MAX_SMS_SIZE] = {0, };
    char dest_addr[20] = {0, };
    char date_time[25] = {0, };
    
    _parser->debug_on(DEBUG_DISABLE);
    
    while(1)
    {        
        // SMS receive check
        msg_idx = checkRecvSMS_BG96();
        
        if(msg_idx > RET_NOK) { // SMS received
            _parser->debug_on(BG96_PARSER_DEBUG);
            
            // Receive a message
            if(recvSMS_BG96(msg_idx, recv_message, dest_addr, date_time) == RET_OK) {
                myprintf("[SMS Recv] from %s, %s, \"%s\"\r\n", dest_addr, date_time, recv_message);
            }
                        
            _parser->debug_on(DEBUG_DISABLE);
        }     
    }
}


// ----------------------------------------------------------------
// Functions: Cat.M1 Status
// ----------------------------------------------------------------

void waitCatM1Ready(void)
{
    while(1) 
    {   
        if(_parser->recv("RDY")) 
        {
            myprintf("BG96 ready\r\n");
            return ;
        }
        else if(_parser->send("AT") && _parser->recv("OK"))
        {
            myprintf("BG96 already available\r\n");
            return ;
        }        
    }        
}

int8_t setEchoStatus_BG96(bool onoff)
{
    int8_t ret = RET_NOK;
    char _buf[10];        
    
    sprintf((char *)_buf, "ATE%d", onoff);    
    
    if(_parser->send(_buf) && _parser->recv("OK")) {        
        devlog("Turn Echo %s success\r\n", onoff?"ON":"OFF");
        ret = RET_OK;
    } else { 
        devlog("Turn Echo %s failed\r\n", onoff?"ON":"OFF");
    }    
    return ret;
}
 
int8_t getUsimStatus_BG96(void)
{
    int8_t ret = RET_NOK;
    
    _parser->send("AT+CPIN?");    
    if(_parser->recv("+CPIN: READY") && _parser->recv("OK")) {
        devlog("USIM Status: READY\r\n");
        ret = RET_OK;
    } else { 
        devlog("Retrieving USIM Status failed\r\n");        
    }
    return ret;
}

int8_t getNetworkStatus_BG96(void)
{
    int8_t ret = RET_NOK;    
    
    if(_parser->send("AT+QCDS") && _parser->recv("+QCDS: \"SRV\"") && _parser->recv("OK")) {
        devlog("Network Status: attached\r\n");
        ret = RET_OK;
    } else if (_parser->send("AT+QCDS") && _parser->recv("+QCDS: \"LIMITED\"") && _parser->recv("OK")) {
        devlog("Network Status: limited\r\n");
        ret = RET_OK;    
    } else { 
        devlog("Network Status: Error\r\n");        
    }
    return ret;
}

int8_t checknSetApn_BG96(const char * apn) // Configure Parameters of a TCP/IP Context
{       
    char resp_str[100];
    
    uint16_t i = 0;
    char * search_pt;
    
    memset(resp_str, 0, sizeof(resp_str));
    
    devlog("Checking APN...\r\n");
    
    _parser->send("AT+QICSGP=1");
    
    while(1)
    {
        _parser->read(&resp_str[i++], 1);        
        search_pt = strstr(resp_str, "OK\r\n");
        if (search_pt != 0)
        {
            break;
        }
    }
    
    search_pt = strstr(resp_str, apn);
    if (search_pt == 0)
    {
        devlog("Mismatched APN: %s\r\n", resp_str);
        devlog("Storing APN %s...\r\n", apn);
        if(!(_parser->send("AT+QICSGP=1,%d,\"%s\",\"\",\"\",0", BG96_APN_PROTOCOL, apn) && _parser->recv("OK")))
        {
            return RET_NOK; // failed
        }
    }    
    devlog("APN Check Done\r\n");
        
    return RET_OK;
}

int8_t getFirmwareVersion_BG96(char * version)
{
    int8_t ret = RET_NOK;
    
    if(_parser->send("AT+QGMR") && _parser->recv("%s\n", version) && _parser->recv("OK"))
    {           
        ret = RET_OK;
    } 
    return ret;
}

int8_t getImeiNumber_BG96(char * imei)
{
    int8_t ret = RET_NOK;    
    
    if(_parser->send("AT+CGSN") && _parser->recv("%s\n", imei) && _parser->recv("OK"))
    { 
        ret = RET_OK;
    } 
    return ret;
}

// ----------------------------------------------------------------
// Functions: Cat.M1 DNS
// ----------------------------------------------------------------


int8_t getIpAddressByName_BG96(const char * name, char * ipstr)
{
    char buf2[50];
    bool ok;
    int  err, ipcount, dnsttl;

    int8_t ret = RET_NOK;

    ok = ( _parser->send("AT+QIDNSGIP=1,\"%s\"", name)
            && _parser->recv("OK") 
            && _parser->recv("+QIURC: \"dnsgip\",%d,%d,%d", &err, &ipcount, &dnsttl) 
            && err==0 
            && ipcount > 0
        ); 

    if( ok ) {        
        _parser->recv("+QIURC: \"dnsgip\",\"%[^\"]\"", ipstr);       //use the first DNS value
        for( int i=0; i<ipcount-1; i++ )
            _parser->recv("+QIURC: \"dnsgip\",\"%[^\"]\"", buf2);   //and discrard the rest  if >1 
            
        ret = RET_OK;    
    }        
    return ret;           
}


// ----------------------------------------------------------------
// Functions: Cat.M1 SMS
// ----------------------------------------------------------------

int8_t initSMS_BG96(void)
{
    int8_t ret = RET_NOK;
    bool msgformat = false, charset = false;
    
    // 0 = PDU mode / 1 = Text mode
    if(_parser->send("AT+CMGF=1") && _parser->recv("OK")) {         // Set SMS message format as text mode
        devlog("SMS message format: Text mode\r\n");
        msgformat = true;
    }    
    
    // "GSM" / "IRA" / "USC2"
    if(_parser->send("AT+CSCS=\"GSM\"") && _parser->recv("OK")) {   // Set character set as GSM
        devlog("SMS character set: GSM\r\n");
        charset = true;
    }
    
    if(msgformat && charset) {
        ret = RET_OK;
    }
    
    return ret;    
}

int8_t sendSMS_BG96(char * da, char * msg, int len)
{
    int8_t ret = RET_NOK;
    int msg_idx = 0;    
    bool done = false;
    
    _parser->set_timeout(BG96_CONNECT_TIMEOUT);
    
    _parser->send("AT+CMGS=\"%s\"", da); // DA(Destination address, Phone number)
    if( !done && _parser->recv(">") )
        done = (_parser->write(msg, len) <= 0) & _parser->send("%c", SMS_EOF);
    
    if( !done ) {        
        done = (_parser->recv("+CMGS: %d", &msg_idx) && _parser->recv("OK"));        
        if(done) {
            devlog(">> SMS send success: index %d\r\n", msg_idx);
            ret = RET_OK;
        }
    }
    _parser->set_timeout(BG96_DEFAULT_TIMEOUT);
    
    return ret;
}

int checkRecvSMS_BG96(void)
{    
    int ret = RET_NOK;
    int msg_idx = 0;    
    
    bool received = false;
    
    _parser->set_timeout(1);
    received = _parser->recv("+CMTI: \"ME\",%d", &msg_idx);    
    _parser->set_timeout(BG96_DEFAULT_TIMEOUT);
    
    if(received) {        
        ret = msg_idx; 
        devlog("<< SMS received: index %d\r\n", msg_idx);
    }
    return ret;
}

int8_t recvSMS_BG96(int msg_idx, char * msg, char * da, char * datetime)
{
    int8_t ret = RET_NOK;    
    char type[15] = {0, };
    
    int i = 0;
    bool done = false;    
    char recv_msg[MAX_SMS_SIZE] = {0, };
    char * search_pt;    
    Timer t;
    
    memset(recv_msg, 0x00, MAX_SMS_SIZE);
        
    _parser->set_timeout(BG96_RECV_TIMEOUT);   
    
    if( _parser->send("AT+CMGR=%d", msg_idx)        
        && _parser->recv("+CMGR: \"%[^\"]\",\"%[^\"]\",,\"%[^\"]\"", type, da, datetime))
    {        
        // timer start
        t.start();
        
        while( !done && (t.read_ms() < BG96_DEFAULT_TIMEOUT)) {        
            _parser->read(&recv_msg[i++], 1);        
            search_pt = strstr(recv_msg, "OK");
            if (search_pt != 0) {
                done = true; // break;
            }
        }        
        if(i > 8) {
            memcpy(msg, recv_msg+2, i-8);            
            devlog("<< SMS receive success: index %d\r\n", msg_idx);        
            ret = RET_OK;
        }
    }    
    _parser->set_timeout(BG96_DEFAULT_TIMEOUT);    
    _parser->flush();
            
    return ret;
}

int8_t deleteSMS_BG96(int msg_idx)
{
    int8_t ret = RET_NOK;
    
    if(_parser->send("AT+CMGD=%d", msg_idx) && _parser->recv("OK"))
    {
        devlog("Message index[%d] has been deleted\r\n", msg_idx);           
        ret = RET_OK;
    } 
    return ret;
}

int8_t deleteAllSMS_BG96(int delflag)
{
    int8_t ret = RET_NOK;    
    
    //delflag == 1; // Delete all read messages from storage
    //delflag == 2; // Delete all read messages from storage and sent mobile originated messages
    //delflag == 3; // Delete all read messages from storage, sent and unsent mobile originated messages
    //delflag == 4; // Delete all messages from storage
    
    if(_parser->send("AT+CMGD=0,%d", delflag) && _parser->recv("OK"))
    {
        devlog("All messages has been deleted (delflag: %d)\r\n", delflag);           
        ret = RET_OK;
    } 
    return ret;
}