File content as of revision 38:4739e039421a:

#ifndef CELLULAR_CPP
#define CELLULAR_CPP

#include "Cellular.h"
#include "MTSText.h"
#include "MTSSerial.h"

Cellular* Cellular::instance = NULL;

Cellular* Cellular::getInstance() {
    if(instance == NULL) {
        instance = new Cellular(NULL);
    }
    return instance;
}


Cellular* Cellular::getInstance(MTSBufferedIO* io) {
    if(instance == NULL) {
        instance = new Cellular(io);
    }
    instance->io = io;
    return instance;
}

Cellular::Cellular(MTSBufferedIO* io) 
: io(io)
, echoMode(true)
, pppConnected(false)
, mode(TCP)
, socketOpened(false)
, socketCloseable(false)
, local_port(0)
, host_port(0)
{
    // the radio's DCD signal is mapped to PTA4
    // the radio will raise and lower this line
    dcd = new DigitalIn(PTA4);
    // the DTR line to the radio is mapped PTC9
    // this line should be lowered when we want to talk to the radio and raised when we're done
    // for now we will lower it in the constructor and raise it in the destructor
    dtr = new DigitalOut(PTC9);
    dtr->write(0);
}

Cellular::~Cellular()
{
    dtr->write(1);
}

bool Cellular::connect() {
    //Check if socket is open
    if(socketOpened) {
        return true;   
    }
    
    //Run Test first to validate a good state
    if(isConnected()) {
        return true;
    }
    
    //Check RSSI: AT+CSQ    
    int rssi = getSignalStrength();
    printf("[DEBUG] Signal strength: %d\r\n", rssi);
    
    //Check Registration: AT+CREG? == 0,1
    Registration registration = getRegistration();
    if(registration != REGISTERED) {
        printf("[WARNING] Not Registered [%d]\r\n", (int)registration);    
    }
    
    //AT#CONNECTIONSTART: Make a PPP connection
    printf("[DEBUG] Making PPP Connection Attempt. APN[%s]\r\n", apn.c_str());
    std::string pppResult = sendCommand("AT#CONNECTIONSTART", 120000);
    std::vector<std::string> parts = Text::split(pppResult, "\r\n");
    
    //printf("[DEBUG] PPP CONNECT RESULT [%s]\r\n", pppResult.c_str());
//    for(uint32_t i = 0; i < parts.size(); i++) {
//        printf("[%d] [%s]\r\n", i, parts[i].c_str());   
//    }
           
    if(pppResult.find("Ok_Info_GprsActivation") != std::string::npos) {
        if(parts.size() >= 2) {
            local_address = parts[1];   
        }
        printf("[INFO] PPP Connection Established: IP[%s]\r\n", local_address.c_str());
        pppConnected = true;
        
    } else {
        pppConnected = false;   
    }
    
    return pppConnected;
}

void Cellular::disconnect() {
    //AT#CONNECTIONSTOP: Close a PPP connection
    printf("[DEBUG] Closing PPP Connection\r\n");
    
    if(socketOpened) { 
        close();   
    }
    
    Code code = sendBasicCommand("AT#CONNECTIONSTOP", 10000);
    if(code == OK) {
        printf("[DEBUG] Successfully closed PPP Connection\r\n");
    } else {
        printf("[ERROR] Closing PPP Connection [%d].  Continuing ...\r\n", (int)code);   
    }
    
    pppConnected = false;
}

bool Cellular::isConnected() {
    //1) Check if APN was set
    if(apn.size() == 0) {
        printf("[DEBUG] APN is not set\r\n");
        return false;
    }
    
    //1) Check that we do not have a live connection up
    if(socketOpened) {
        printf("[DEBUG] Socket is opened\r\n");
        return true;
    }
    //2) Query the radio
    pppConnected = false;
    std::string result = sendCommand("AT#VSTATE", 1000);
    if(result.find("CONNECTED") != std::string::npos) {
        pppConnected = true;
    }
    
    return pppConnected;
}

bool Cellular::bind(unsigned int port) {
    return false;
}

bool Cellular::open(const std::string& address, unsigned int port, Mode mode) {
    char buffer[256] = {0};
    Code portCode, addressCode;
    printf("[DEBUG] Attempting to Open Socket\r\n");
    
    //1) Check that we do not have a live connection up
    if(socketOpened) {
        printf("[DEBUG] Socket already opened\r\n");
        return true;
    }
    
    //2) Check PPP connection
    if(!isConnected()) {
        printf("[ERROR] PPP not established.  Attempting to connect\r\n");
        if(!connect()) {
            printf("[ERROR] PPP connection failed\r\n");
            return false;
        } else {
            printf("[DEBUG] PPP connection established\r\n");
        }
    }
    
    ////Setup IP Connection
    if(mode == TCP) {
        if(socketCloseable) {
            Code code = sendBasicCommand("AT#DLEMODE=1,0", 1000);
            if(code != OK) {
                printf("[WARNING] Unable to set socket closeable [%d]\r\n", (int) code);       
            }
        }
        sprintf(buffer, "AT#TCPPORT=1,%d", port);
        portCode = sendBasicCommand(buffer, 1000);
        addressCode = sendBasicCommand("AT#TCPSERV=1,\"" + address + "\"", 1000);
    } else {
        if(socketCloseable) {
            Code code = sendBasicCommand("AT#UDPDLEMODE=1", 1000);
            if(code != OK) {
                printf("[WARNING] Unable to set socket closeable [%d]\r\n", (int) code);       
            }
        }
        sprintf(buffer, "AT#UDPPORT=1,%d", port);
        portCode = sendBasicCommand(buffer, 1000);
        addressCode = sendBasicCommand("AT#UDPSERV=1,\"" + address + "\"", 1000);
    }
    
    if(portCode == OK) {
        host_port = port;
    } else {
        printf("[ERROR] Host port could not be set\r\n");
    }
    
    if(addressCode == OK) {
        host_address = address;
    } else {
        printf("[ERROR] Host address could not be set\r\n");
    }
    
    // Try and Connect
    string response = sendCommand("AT#OTCP=1", 30000);
    if (response.find("Ok_Info_WaitingForData") != string::npos) {
        printf("[INFO] Opened TCP Socket [%s:%d]\r\n", address.c_str(), port);
        socketOpened = true;
    } else {
        printf("[WARNING] Unable to open TCP Socket [%s:%d]\r\n", address.c_str(), port);
        socketOpened = false;
    }
        
    return socketOpened;
}

bool Cellular::isOpen() {
    return socketOpened;
}

bool Cellular::close() {
    if(io == NULL) {
        printf("[ERROR] MTSBufferedIO not set\r\n");
        return false;
    }

    if(!socketOpened) {
        printf("[WARNING] Socket close() called, but socket was not open\r\n");
        return true;
    }

    if(!socketCloseable) {
        printf("[ERROR] Socket is not closeable\r\n");
        return false;
    }
    
    Timer tmr;
    int timeout = 1000;
    int written = 0;
    tmr.start();
    do {
        written = io->write(ETX);
        if(written < 0) {
            printf("[ERROR] Failed to write to MTSBufferedIO\r\n");
            return false;   
        }
        wait(0.05);
    } while(tmr.read_ms() <= timeout && written != 1);

    if(written != 1) {
        printf("[ERROR] Timed out attempting to close socket\r\n");
        return false;
    }
    
    socketOpened = false;
    return true;
}

int Cellular::read(char* data, int max, int timeout) {
    if(io == NULL) {
        printf("[ERROR] MTSBufferedIO not set\r\n");
        return -1;
    }
    
    if(!socketOpened) {
        printf("[ERROR] Socket is not open\r\n");
        return -1;
    }
    int bytesRead = 0;
    
    if(timeout >= 0) {
        Timer tmr;
        tmr.start();
        do {
            int available = io->readable();
            if (available > 0) {
                int size = MIN(available, max - bytesRead);
                bytesRead += io->read(&data[bytesRead], size);
            } else {
                wait(0.05);   
            }
        } while (tmr.read_ms() <= timeout && bytesRead < max);
    } else {
        bytesRead = io->read(data, max);
    }
    
    if(bytesRead > 0 && socketCloseable) {
        //Remove escape characters   
        int index = 0;
        bool escapeFlag = false;
        for(int i = 0; i < bytesRead; i++) {
           if(data[i] == DLE || data[i] == ETX) {
               if(escapeFlag == true) {
                    //This character has been escaped
                    escapeFlag = false;
                } else if(data[bytesRead] == DLE) {
                    //Found escape character
                    escapeFlag = true;
                    continue;
                } else {
                    //ETX sent without escape -> Socket closed 
                    printf("[INFO] Read ETX character without DLE escape. Socket closed\r\n"); 
                    socketOpened = false;
                    continue;
                }
            }

            if(index != i) {
                data[index] = data[i];
            }
            index++;
        }
        bytesRead = index;
    }
    
    printf("[DEBUG] Scanning received data for socket closed message\r\n");
    //Scan for socket closed message
    for(size_t i = 0; i < bytesRead; i++) {
        if(data[i] == 'O') {
            if(strstr(&data[i], "Ok_Info_SocketClosed")) {
                printf("[INFO] Found socket closed message. Socket closed\r\n"); 
                //Close socket and Cut Off End of Message
                socketOpened = false;
                data[i] = '\0';
                bytesRead = i;
                break;
            }
        }
    }
    return bytesRead;
}

int Cellular::write(char* data, int length, int timeout) {
    if(io == NULL) {
        printf("[ERROR] MTSBufferedIO not set\r\n");
        return -1;
    }
    
    if(!socketOpened) {
        printf("[ERROR] Socket is not open\r\n");
        return -1;
    }
    
    //In order to avoid allocating another buffer, capture indices of
    //characters to escape during write
    int specialWritten = 0;
    std::vector<int> vSpecial;
    if(socketCloseable) {
        for(int i = 0; i < length; i++) {
            if(data[i] == ETX || data[i] == DLE) {
                //Push back index of special characters
                vSpecial.push_back(i);
            }                   
        }
    }
    
    int bytesWritten = 0;
    if(timeout >= 0) {
        Timer tmr;
        tmr.start();
        do {
            int capacity = io->writeable();
            if (capacity > 0) {
                if(specialWritten < vSpecial.size()) {
                    //Check if current index is at a special character
                    if(bytesWritten == vSpecial[specialWritten]) {
                        if(capacity < 2) {
                            //Requires at least two bytes of space
                            wait(0.05);
                            continue;   
                        }
                        //Ready to write special character    
                        if(io->write(DLE)) {
                            specialWritten++;
                            if(io->write(data[bytesWritten])) {
                                bytesWritten++;
                            }
                        } else {
                            //Unable to write escape character, try again next round
                            wait(0.05);
                        }
                    } else {
                        //We want to write all the way up to the next special character    
                        int relativeIndex = vSpecial[specialWritten] - bytesWritten;
                        int size = MIN(capacity, relativeIndex);
                        bytesWritten += io->write(&data[bytesWritten], size);
                    }                    
                } else {                
                    int size = MIN(capacity, length - bytesWritten);
                    bytesWritten += io->write(&data[bytesWritten], size);
                }
            } else {
                wait(0.05);   
            }
        } while (tmr.read_ms() <= timeout && bytesWritten < length);
    } else {
        for(int i = 0; i < vSpecial.size(); i++) {
            //Write up to the special character, then write the special character
            int size = vSpecial[i] - bytesWritten;
            int currentWritten = io->write(&data[bytesWritten], size);
            bytesWritten += currentWritten;
            if(currentWritten != size) {
                //Failed to write up to the special character.
                return bytesWritten;
            }
            if(io->write(DLE) && io->write(data[bytesWritten])) {
                bytesWritten++;
            } else {
                //Failed to write the special character.
                return bytesWritten;
            }
        }
    
        bytesWritten = io->write(&data[bytesWritten], length - bytesWritten);
    }
    
    return bytesWritten;
}

unsigned int Cellular::readable() {
    if(io == NULL) {
        printf("[ERROR] MTSBufferedIO not set\r\n");
        return 0;
    }
    if(!socketOpened) {
        printf("[ERROR] Socket is not open\r\n");
        return 0;
    }
    return io->readable();
}

unsigned int Cellular::writeable() {
    if(io == NULL) {
        printf("[ERROR] MTSBufferedIO not set\r\n");
        return 0;
    }
    if(!socketOpened) {
        printf("[ERROR] Socket is not open\r\n");
        return 0;
    }
    
    return io->writeable();
}

void Cellular::reset() {
    disconnect();
    Code code = sendBasicCommand("AT#RESET=0", 10000);
    if(code != OK) {
        printf("[ERROR] Socket Modem did not accept RESET command\n\r");
    } else {
        printf("[WARNING] Socket Modem is resetting, allow 30 seconds for it to come back\n\r");
    }
}

Cellular::Code Cellular::test()
{
    Code code = sendBasicCommand("AT", 1000);
    
    if(code != OK) {
        printf("[Error] Failed basic AT command");
        return code;
    }

    //AT#VSTATE != "CHECKING"
    
    //AT#GPRSMODE == 
    return OK;
}

Cellular::Code Cellular::echo(bool state)
{
    Code code;
    if (state) {
        code = sendBasicCommand("ATE0", 1000);
        echoMode = (code == OK) ? false : echoMode;
    } else {
        code = sendBasicCommand("ATE1", 1000);
        echoMode = (code == OK) ? true : echoMode;
    }
    return code;
}

int Cellular::getSignalStrength()
{
    string response = sendCommand("AT+CSQ", 1000);
    if (response.find("OK") == string::npos) {
        return -1;
    }
    int start = response.find(':');
    int stop = response.find(',', start);
    string signal = response.substr(start + 2, stop - start - 2);
    int value;
    sscanf(signal.c_str(), "%d", &value);
    return value;
}

std::string Cellular::getPhoneNumber() {
    return "unknown";
}

Cellular::Registration Cellular::getRegistration()
{
    string response = sendCommand("AT+CREG?", 1000);
    if (response.find("OK") == string::npos) {
        return UNKNOWN;
    }
    int start = response.find(',');
    int stop = response.find(' ', start);
    string regStat = response.substr(start + 1, stop - start - 1);
    int value;
    sscanf(regStat.c_str(), "%d", &value);
    switch (value) {
        case 0:
            return NOT_REGISTERED;
        case 1:
            return REGISTERED;
        case 2:
            return SEARCHING;
        case 3:
            return DENIED;
        case 4:
            return UNKNOWN;
        case 5:
            return ROAMING;
    }
    return UNKNOWN;
}

Cellular::Code Cellular::sendBasicCommand(string command, int timeoutMillis, ESC_CHAR esc)
{
    if(socketOpened) {
        printf("[ERROR] socket is open. Can not send AT commands\r\n");    
        return ERROR;
    }

    string response = sendCommand(command, timeoutMillis, esc);
    if (response.size() == 0) {
        return NO_RESPONSE;
    } else if (response.find("OK") != string::npos) {
        return OK;
    } else if (response.find("ERROR") != string::npos) {
        return ERROR;
    } else {
        return FAILURE;
    }
}

Cellular::Code Cellular::setApn(const std::string& apn) {
    Code code = sendBasicCommand("AT#APNSERV=\"" + apn + "\"", 1000);
    if (code != OK) {
        return code;
    }
    this->apn = apn;
    return code;
}

Cellular::Code Cellular::setDns(const std::string& address) {
    return FAILURE;   
}

bool Cellular::ping(const std::string& address) {
    char buffer[256] = {0};
    Code code;
    
    code = sendBasicCommand("AT#PINGREMOTE=\"" + address + "\"", 1000);
    if (code != OK) {
        return false;
    }
    
    sprintf(buffer, "AT#PINGNUM=%d", 1);
    code = sendBasicCommand(buffer , 1000);
    if (code != OK) {
        return false;
    }
    
    sprintf(buffer, "AT#PINGDELAY=%d", PINGDELAY);
    code = sendBasicCommand(buffer , 1000);
    if (code != OK) {
        return false;
    }
    
    std::string response;
    for (int i = 0; i < PINGNUM; i++) {
        response = sendCommand("AT#PING", PINGDELAY * 1000);
        if (response.find("alive") != std::string::npos) {
            return true;
        }
    }
    return false;
}

Cellular::Code Cellular::setSocketCloseable(bool enabled) {
    if(socketCloseable == enabled) {
        return OK;    
    }
    
    if(socketOpened) {
        printf("[ERROR] socket is already opened. Can not set closeable\r\n");    
        return ERROR;
    }
    
    socketCloseable = enabled;
    
    return OK;
}

Cellular::Code Cellular::sendSMS(const Sms& sms) {
    return sendSMS(sms.phoneNumber, sms.message);
}

Cellular::Code Cellular::sendSMS(const std::string& phoneNumber, const std::string& message)
{    
    Code code = sendBasicCommand("AT+CMGF=1", 1000);
    if (code != OK) {
        return code;
    }
    string cmd = "AT+CMGS=\"+";
    cmd.append(phoneNumber);
    cmd.append("\"");
    string response1 = sendCommand(cmd, 1000);
    if (response1.find('>') == string::npos) {
        return NO_RESPONSE;
    }
    wait(.2);
    string  response2 = sendCommand(message, 4000, CTRL_Z);
    printf("SMS Response: %s\r\n", response2.c_str());
    if (response2.find("+CMGS:") == string::npos) {
        return FAILURE;
    }
    return OK;
}

std::vector<Cellular::Sms> Cellular::getReceivedSms() {
    int smsNumber = 0;
    std::vector<Sms> vSms;
    std::string received = sendCommand("AT+CMGL=\"ALL\"", 4000);
    size_t pos = received.find("+CMGL: ");
    
    while (pos != std::string::npos) {
        Cellular::Sms sms;
        std::string line(Text::getLine(received, pos, pos));
        //printf("[DEBUG] Top of SMS Parse Loop. LINE[%s]\r\n", line.c_str());
        if(line.find("+CMGL: ") == std::string::npos) {           
            continue;
        }
        
        //Start of SMS message
        std::vector<std::string> vSmsParts = Text::split(line, ',');
        if(vSmsParts.size() != 6) {
            printf("[WARNING] Expected 6 commas. SMS[%d] DATA[%s]. Continuing ...\r\n", smsNumber, line.c_str());
            continue;
        }
        
        sms.phoneNumber = vSmsParts[2];
        sms.timestamp = vSmsParts[4] + ", " + vSmsParts[5];
        
        if(pos == std::string::npos) {
            printf("[WARNING] Expected SMS body. SMS[%d]. Leaving ...\r\n", smsNumber);
            break;
        }
        //Check for the start of the next SMS message
        size_t bodyEnd = received.find("\r\n+CMGL: ", pos);
        if(bodyEnd == std::string::npos) {
            //printf("[DEBUG] Parsing Last SMS. SMS[%d]\r\n", smsNumber);
            //This must be the last SMS message
            bodyEnd = received.find("\r\n\r\nOK", pos);
        }
        
        //Safety check that we found the boundary of this current SMS message
        if(bodyEnd != std::string::npos) {
            sms.message = received.substr(pos, bodyEnd - pos);
        } else {
            sms.message = received.substr(pos);
            printf("[WARNING] Expected to find end of SMS list. SMS[%d] DATA[%s].\r\n", smsNumber, sms.message.c_str());
        }
        vSms.push_back(sms);
        pos = bodyEnd;
        //printf("[DEBUG] Parsed SMS[%d].  Starting Next at position [%d]\r\n", smsNumber, pos);
        smsNumber++;
    }
    printf("Received %d SMS\r\n", smsNumber);
    return vSms;
}

Cellular::Code Cellular::deleteOnlyReceivedReadSms() {
    return sendBasicCommand("AT+CMGD=1,1", 1000);
}

Cellular::Code Cellular::deleteAllReceivedSms() {
    return sendBasicCommand("AT+CMGD=1,4", 1000);
}


string Cellular::sendCommand(string command, int timeoutMillis, ESC_CHAR esc)
{
    if(io == NULL) {
        printf("[ERROR] MTSBufferedIO not set\r\n");
        return "";
    }
    if(socketOpened) {
        printf("[ERROR] socket is open. Can not send AT commands\r\n");    
        return "";
    }

    int size = command.size() + 1;
    char cmd[size];
    strcpy(cmd, command.c_str());
    if (esc == CR) {
        cmd[size -1] = '\r';
    } else if (esc == CTRL_Z) {
        cmd[size -1] = 0x1A;
    } else if(esc == NONE) {
        cmd[size -1] = '\0';
    }

    io->rxClear();
    io->txClear();
    std::string result;
    int status = io->write(cmd, size);
    int available = io->readable();
    int previous = -1;
    int timer = 0;
    char tmp[256];
    tmp[255] = 0;
    bool started = !echoMode;
    bool done = false;
    do {
        wait(.1);
        timer = timer + 100;
        previous = available;
        available = io->readable();

        int size = io->read(tmp,255);    //1 less than allocated
        if(size > 0) {
            result.append(tmp, size);
        }
        
        if(!started) {
            //In Echo Mode (Command will have echo'd + 2 characters for \r\n)
            if(result.size() > command.size() + 2) {
                started = true;
            }
        } else {
            done =  (available == previous);
        }
        if(timer >= timeoutMillis) {
            printf("[WARNING] sendCommand timed out after %d milliseconds\r\n", timeoutMillis);
            done = true;
        }
    } while (!done);
    
    return result;
}

#endif /* CELLULAR_CPP */