esp-protocols/esp_modem/src/esp_modem_command_library.cpp

// Copyright 2021 Espressif Systems (Shanghai) PTE LTD
//
// 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 "cxx_include/esp_modem_dte.hpp"
#include "cxx_include/esp_modem_dce_module.hpp"
#include "cxx_include/esp_modem_command_library.hpp"
#include <cstring>

// TODO: Remove iostream
#include <iostream>

namespace esp_modem::dce_commands {

static inline command_result generic_command(CommandableIf* t, const std::string& command,
                                                                   const std::string& pass_phrase,
                                                                   const std::string& fail_phrase, uint32_t timeout_ms)
{
    std::cout << command << std::endl;
    return t->command(command, [&](uint8_t *data, size_t len) {
        std::string response((char*)data, len);
        std::cout << response << std::endl;

        if (response.find(pass_phrase) != std::string::npos) {
            return command_result::OK;
        } else if (response.find(fail_phrase) != std::string::npos) {
            return command_result::FAIL;
        }
        return command_result::TIMEOUT;
    }, timeout_ms);
}

static inline command_result generic_get_string(CommandableIf* t, const std::string& command, std::string& output, uint32_t timeout_ms = 500)
{
    return t->command(command, [&](uint8_t *data, size_t len) {
        size_t pos = 0;
        std::string response((char*)data, len);
        while ((pos = response.find('\n')) != std::string::npos) {
            std::string token = response.substr(0, pos);
            for (auto i = 0; i<2; ++i)  // trip trailing \n\r of last two chars
                if (pos >= 1 && (token[pos-1] == '\r' || token[pos-1] == '\n'))
                    token.pop_back();

            if (token.find("OK") != std::string::npos) {
                return command_result::OK;
            } else if (token.find("ERROR") != std::string::npos) {
                return command_result::FAIL;
            } else if (token.length() > 2) {
                output = token;
            }
            response = response.substr(pos+1);
        }
        return command_result::TIMEOUT;
    }, timeout_ms);
}

static inline command_result generic_command_common(CommandableIf* t, std::string command, uint32_t timeout = 500)
{
    return generic_command(t, command, "OK", "ERROR", timeout);
}

command_result sync(CommandableIf* t)
{
    return generic_command_common(t, "AT\r");
}

command_result store_profile(CommandableIf* t)
{
    return generic_command_common(t, "AT&W\r");
}

command_result power_down(CommandableIf* t)
{
    return generic_command(t, "AT+QPOWD=1\r", "POWERED DOWN", "ERROR", 1000);
}

command_result power_down_sim7xxx(CommandableIf* t)
{
    return generic_command_common(t, "AT+CPOF\r", 1000);
}

command_result power_down_sim8xx(CommandableIf* t)
{
    return generic_command(t, "AT+CPOWD=1\r", "POWER DOWN", "ERROR", 1000);
}

command_result reset(CommandableIf* t)
{
    return generic_command(t,  "AT+CRESET\r", "PB DONE", "ERROR", 60000);
}

command_result set_baud(CommandableIf* t, int baud)
{
    return generic_command_common(t,  "AT+IPR=" + std::to_string(baud) + "\r");
}

command_result hang_up(CommandableIf* t)
{
    return generic_command_common(t, "ATH\r", 90000);
}

command_result get_battery_status(CommandableIf* t, int& voltage, int &bcs, int &bcl)
{
    std::string out;
    auto ret = generic_get_string(t, "AT+CBC\r", out);
    if (ret != command_result::OK)
        return ret;
    if (out.find("+CBC") == std::string::npos)
        return command_result::FAIL;
    // Parsing +CBC: <bcs>,<bcl>,<voltage>
    sscanf(out.c_str(), "%*s%d,%d,%d", &bcs, &bcl, &voltage);
    return command_result::OK;
}

command_result get_battery_status_sim7xxx(CommandableIf* t, int& voltage, int &bcs, int &bcl)
{
    std::string out;
    auto ret = generic_get_string(t, "AT+CBC\r", out);
    if (ret != command_result::OK)
        return ret;
    if (out.find("+CBC") == std::string::npos)
        return command_result::FAIL;
    // Parsing +CBC: <voltage in Volts> V
    int volt, fraction;
    sscanf(out.c_str(), "+CBC: %d.%dV", &volt, &fraction);
    bcl = bcs = -1; // not available for these models
    voltage = 1000*volt + fraction;
    return command_result::OK;
}

command_result set_flow_control(CommandableIf* t, int dce_flow, int dte_flow)
{
    return generic_command_common(t, "AT+IFC=" + std::to_string(dce_flow) + ", " + std::to_string(dte_flow) + "\r");
}

command_result get_operator_name(CommandableIf* t, std::string& operator_name)
{
    std::string out;
    auto ret = generic_get_string(t, "AT+COPS?\r", out, 75000);
    if (ret != command_result::OK)
        return ret;
    auto pos = out.find("+COPS");
    auto property = 0;
    while (pos != std::string::npos) {
        // Looking for: +COPS: <mode>[, <format>[, <oper>]]
        if (property++ == 2) {  // operator name is after second comma (as a 3rd property of COPS string)
            operator_name = out.substr(++pos);
            return command_result::OK;
        }
        pos = out.find(',', ++pos);
    }
    return command_result::FAIL;
}

command_result set_echo(CommandableIf* t, bool on)
{
    if (on)
        return generic_command_common(t, "ATE1\r");
    return generic_command_common(t, "ATE0\r");
}

command_result set_pdp_context(CommandableIf* t, PdpContext& pdp)
{
    std::string pdp_command = "AT+CGDCONT=" + std::to_string(pdp.context_id) +
                              ",\"" + pdp.protocol_type + "\",\"" + pdp.apn + "\"\r";
    return generic_command_common(t, pdp_command);
}

command_result set_data_mode(CommandableIf* t)
{
    return generic_command(t, "ATD*99##\r", "CONNECT", "ERROR", 5000);
}

command_result set_data_mode_sim8xx(CommandableIf* t)
{
    return generic_command(t, "ATD*99##\r", "CONNECT", "ERROR", 5000);
}

command_result resume_data_mode(CommandableIf* t)
{
    return generic_command(t, "ATO\r", "CONNECT", "ERROR", 5000);
}

command_result set_command_mode(CommandableIf* t)
{
    std::cout << "Sending +++" << std::endl;
    return t->command("+++", [&](uint8_t *data, size_t len) {
        std::string response((char*)data, len);
        std::cout << response << std::endl;
        if (response.find("OK") != std::string::npos) {
            return command_result::OK;
        } else if (response.find("NO CARRIER") != std::string::npos) {
            return command_result::OK;
        } else if (response.find("ERROR") != std::string::npos) {
            return command_result::FAIL;
        }
        return command_result::TIMEOUT;
    }, 5000);
}

command_result get_imsi(CommandableIf* t, std::string& imsi_number)
{
    return generic_get_string(t, "AT+CIMI\r", imsi_number, 5000);
}

command_result get_imei(CommandableIf* t, std::string& out)
{
    return generic_get_string(t, "AT+CGSN\r", out, 5000);
}

command_result get_module_name(CommandableIf* t, std::string& out)
{
    return generic_get_string(t, "AT+CGMM\r", out, 5000);
}

command_result sms_txt_mode(CommandableIf* t, bool txt = true)
{
    if (txt)
        return generic_command_common(t, "AT+CMGF=1\r"); // Text mode (default)
    return generic_command_common(t, "AT+CMGF=0\r");     // PDU mode
}

command_result sms_character_set(CommandableIf* t)
{
    // Sets the default GSM character set
    return generic_command_common(t, "AT+CSCS=\"GSM\"\r");
}

command_result send_sms(CommandableIf* t, const std::string& number, const std::string& message)
{
    auto ret = t->command("AT+CMGS=\"" + number + "\"\r", [&](uint8_t *data, size_t len) {
        std::string response((char*)data, len);
        std::cout << response << std::endl;
        if (response.find('>') != std::string::npos) {
            return command_result::OK;
        }
        return command_result::TIMEOUT;
    }, 5000, ' ');
    if (ret != command_result::OK)
        return ret;
    return generic_command_common(t, message +"\x1A", 120000);
}


command_result set_cmux(CommandableIf* t)
{
    return generic_command_common(t, "AT+CMUX=0\r");
}

command_result read_pin(CommandableIf* t, bool& pin_ok)
{
    std::cout << "Sending read_pin" << std::endl;
    return t->command("AT+CPIN?\r", [&](uint8_t *data, size_t len) {
        std::string response((char*)data, len);
        std::cout << response << std::endl;
        if (response.find("READY") != std::string::npos) {
            pin_ok = true;
            return command_result::OK;
        } else if (response.find("PIN") != std::string::npos || response.find("PUK") != std::string::npos ) {
            pin_ok = false;
            return command_result::OK;
        } else if (response.find("ERROR") != std::string::npos) {
            return command_result::FAIL;
        }
        return command_result::TIMEOUT;
    }, 5000);
}

command_result set_pin(CommandableIf* t, const std::string& pin)
{
    std::cout << "Sending set_pin" << std::endl;
    std::string set_pin_command = "AT+CPIN=" + pin + "\r";
    return generic_command_common(t, set_pin_command);
}

command_result get_signal_quality(CommandableIf* t, int &rssi, int &ber)
{
    std::cout << "get_signal_quality" << std::endl;
    return t->command("AT+CSQ\r", [&](uint8_t *data, size_t len) {
            size_t pos = 0;
            std::string response((char*)data, len);
            while ((pos = response.find('\n')) != std::string::npos) {
                std::string token = response.substr(0, pos);
                for (auto i = 0; i<2; ++i)  // trip trailing \n\r of last two chars
                    if (pos >= 1 && (token[pos-1] == '\r' || token[pos-1] == '\n'))
                        token.pop_back();

                if (token.find("OK") != std::string::npos) {
                    return command_result::OK;
                } else if (token.find("ERROR") != std::string::npos) {
                    return command_result::FAIL;
                } else if (token.find("+CSQ") != std::string::npos) {
                    sscanf(token.c_str(), "%*s%d,%d", &rssi, &ber);
                }
                response = response.substr(pos+1);
            }
            return command_result::TIMEOUT;
        }, 500);
}

} // esp_modem::dce_commands