From 576eb04e2d42e3b9c5fa40748d1d190a457fa1f8 Mon Sep 17 00:00:00 2001 From: sdesai Date: Wed, 15 Mar 2023 15:22:04 -0500 Subject: GP-139:Support Portal Case #5086148: use Cellular Radio timeas alternative to GPS or NTP --- src/MTS_IO_CellularRadio.cpp | 353 +++++++++++-------------------------------- 1 file changed, 88 insertions(+), 265 deletions(-) (limited to 'src/MTS_IO_CellularRadio.cpp') diff --git a/src/MTS_IO_CellularRadio.cpp b/src/MTS_IO_CellularRadio.cpp index 7200658..8cdaf44 100644 --- a/src/MTS_IO_CellularRadio.cpp +++ b/src/MTS_IO_CellularRadio.cpp @@ -22,7 +22,6 @@ #include #include -#include #include #include @@ -578,17 +577,25 @@ ICellularRadio::CODE CellularRadio::getTime(std::string& sDate, std::string& sTi sDate = ""; sTime = ""; sTimeZone = ""; + std::vector vTimeParts; + std::string sSign = "+"; + + if(getTimeUTC() == FAILURE) { + printWarning("%s| Unable to set Time Parameters for radio [%s]", m_sName.c_str()); + return FAILURE;; + } std::string sCmd("AT+CCLK?"); std::string sResult = sendCommand(sCmd); size_t end = sResult.find(ICellularRadio::RSP_OK); + if (end == std::string::npos) { printWarning("%s| Unable to get Time from radio using command [%s]", m_sName.c_str(), sCmd.c_str()); return FAILURE; } size_t start = sResult.find("CCLK: "); - if(start != std::string::npos) { + if (start != std::string::npos) { start += sizeof("CCLK: "); std::string sValue = MTS::Text::trim(sResult.substr(start, end - start)); sValue = MTS::Text::strip(sValue, '"'); @@ -599,39 +606,47 @@ ICellularRadio::CODE CellularRadio::getTime(std::string& sDate, std::string& sTi return FAILURE; } - std::vector vDateParts = MTS::Text::split(vParts[0], '/'); if(vDateParts.size() != 3) { - printWarning("%s| Unable to parse Date from response [%s]", m_sName.c_str(), sResult.c_str()); + printWarning("%s| Unable to parse Date parts from response [%s]", m_sName.c_str(), sResult.c_str()); return FAILURE; } - //The Date format is YY/MM/DD -> Change to MM/DD/YY - sDate = vDateParts[1] + "/" + vDateParts[2] + "/" + vDateParts[0]; + // The format is YYYY-MM-DD + sDate = vDateParts[0] + "-" + vDateParts[1] + "-" + vDateParts[2]; - vParts = MTS::Text::split(vParts[1], '-'); - if(vParts.size() != 2) { - printWarning("%s| Unable to parse Time from response [%s]", m_sName.c_str(), sResult.c_str()); - return FAILURE; + sTime = (vParts[1]); + + //E.g. 20:39:34-16. Split time and zone with + or - sign. + size_t psign = sTime.find("+"); + size_t nsign = sTime.find("-"); + + if (psign != std::string::npos) { + vTimeParts = MTS::Text::split(vParts[1], '+'); + } else if (nsign != std::string::npos) { + vTimeParts = MTS::Text::split(vParts[1], '-'); + sSign = "-"; } - sTime = vParts[0]; - int32_t iZoneUnits; //the difference, expressed in quarters of an hour, between the local time and GMT - if(!MTS::Text::parse(iZoneUnits, MTS::Text::strip(vParts[1], '+'))) { - printWarning("%s| Unable to parse Time Zone from response [%s]", m_sName.c_str(), sResult.c_str()); + if(vTimeParts.size() != 2) { + printWarning("%s| Unable to parse Time Zone from response [%s], size %d", m_sName.c_str(), sResult.c_str(),vTimeParts.size()); return FAILURE; } + //Get just the UTC time without zone info + sTime = (vTimeParts[0]); + + int32_t iZoneUnits = stoi(vTimeParts[1]); //the difference, expressed in quarters of an hour, between the local time and GMT int32_t iZone = iZoneUnits/4; //Divide by 4 to get hours difference int32_t iZonePartial = (iZoneUnits % 4) * 15; //Remainder in minutes - std::string sPlusSign = "+"; - if(iZonePartial < 0) { - //Remove negative sign from partial and clear plus sign component + + if (iZonePartial < 0) { + //Remove negative sign from partial and clear sign component iZonePartial *= -1; - sPlusSign = ""; + sSign = ""; } std::stringstream ss; - ss << sPlusSign << iZone; + ss << sSign << iZone; if(iZonePartial != 0) { ss << ":" << iZonePartial; } @@ -640,7 +655,7 @@ ICellularRadio::CODE CellularRadio::getTime(std::string& sDate, std::string& sTi return SUCCESS; } else { - printWarning("%s| Unable to get Time from radio using command [%s]", m_sName.c_str(), sCmd.c_str()); + printWarning("%s| Unable to parse Time from radio using command [%s]", m_sName.c_str(), sCmd.c_str()); } return FAILURE; @@ -1761,81 +1776,27 @@ ICellularRadio::CODE CellularRadio::sendBasicQuery(const std::string& sCmd, cons return SUCCESS; } -ICellularRadio::CODE CellularRadio::isCommandSupported(const std::string& sCmd, bool& bIsSupported) { - CODE rc; - bIsSupported = false; - - rc = sendBasicCommand(sCmd); - - if (SUCCESS == rc) { - bIsSupported = true; - } else if (ERROR == rc) { - // if not applicable - rc = SUCCESS; - } - - return rc; -} - ICellularRadio::CODE CellularRadio::getSelectedBandsRaw(std::string& sRawBands) { printTrace("%s| Acquiring selected bands: not applicable", m_sName.c_str()); return NOT_APPLICABLE; } -ICellularRadio::CODE CellularRadio::convertPdpContextAuthTypeToString(PDP_CONTEXT_AUTH_TYPE eAuthType, std::string& sAuthType) { - CODE rc = FAILURE; - - switch (eAuthType) { - case NONE: sAuthType = VALUE_PDP_CONTEXT_AUTH_TYPE_NONE; rc = SUCCESS; break; - case PAP: sAuthType = VALUE_PDP_CONTEXT_AUTH_TYPE_PAP; rc = SUCCESS; break; - case CHAP: sAuthType = VALUE_PDP_CONTEXT_AUTH_TYPE_CHAP; rc = SUCCESS; break; - case PAP_CHAP: sAuthType = VALUE_PDP_CONTEXT_AUTH_TYPE_PAP_CHAP; rc = SUCCESS; break; - default: sAuthType = ICellularRadio::VALUE_UNKNOWN; break; - } - return rc; -} - -ICellularRadio::CODE MTS::IO::CellularRadio::convertStringToPdpContextAuthType(const std::string& sAuthType, PDP_CONTEXT_AUTH_TYPE& eAuthType) { - CODE rc = FAILURE; - if (VALUE_PDP_CONTEXT_AUTH_TYPE_NONE == sAuthType) { - eAuthType = PDP_CONTEXT_AUTH_TYPE::NONE; - rc = SUCCESS; - } else if (VALUE_PDP_CONTEXT_AUTH_TYPE_PAP == sAuthType) { - eAuthType = PDP_CONTEXT_AUTH_TYPE::PAP; - rc = SUCCESS; - } else if (VALUE_PDP_CONTEXT_AUTH_TYPE_CHAP == sAuthType) { - eAuthType = PDP_CONTEXT_AUTH_TYPE::CHAP; - rc = SUCCESS; - } else if (VALUE_PDP_CONTEXT_AUTH_TYPE_PAP_CHAP == sAuthType) { - eAuthType = PDP_CONTEXT_AUTH_TYPE::PAP_CHAP; - rc = SUCCESS; - } - return rc; -} - -// When there are no defined contexts -// Telit returns: -// OK -// Quectel returns: -// +CGDCONT: -// -// OK -ICellularRadio::CODE CellularRadio::getPdpContextsBase(Json::Value& jData) { +ICellularRadio::CODE CellularRadio::getPdpContexts(Json::Value& jData) { + printTrace("%s| Fetching the list of PDP contexts from the radio", getName().c_str()); CODE rc; const std::string sCommand = "AT+CGDCONT?"; const int dTimeout = 1000; std::string sResult; - jData = Json::objectValue; - rc = sendBasicQuery(sCommand, "", sResult, dTimeout); if (rc != SUCCESS) { return rc; } - std::vector vContexts = MTS::Text::split(sResult, "+CGDCONT:"); + std::vector vContexts = MTS::Text::split(sResult, "+CGDCONT: "); + std::vector vContextParams; for (size_t i = 0; i < vContexts.size(); i++) { vContexts[i] = MTS::Text::trim(vContexts[i]); @@ -1844,7 +1805,7 @@ ICellularRadio::CODE CellularRadio::getPdpContextsBase(Json::Value& jData) { continue; } - std::vector vContextParams = MTS::Text::split(vContexts[i], ",", 4); + vContextParams = MTS::Text::split(vContexts[i], ",", 4); if (vContextParams.size() < 3) { return FAILURE; @@ -1861,216 +1822,78 @@ ICellularRadio::CODE CellularRadio::getPdpContextsBase(Json::Value& jData) { return SUCCESS; } -ICellularRadio::CODE CellularRadio::getPdpContexts(Json::Value& jData) { - printTrace("%s| Fetching the list of PDP contexts from the radio", getName().c_str()); +ICellularRadio::CODE CellularRadio::setPdpContext(const std::string& sId, const Json::Value& jConfig) { + printTrace("%s| Setting context to the radio", getName().c_str()); CODE rc; - bool bPdpAuthSupported; - // check if pdp context authentication is applicable - rc = isPdpContextAuthSupported(bPdpAuthSupported); - if (SUCCESS != rc) { - return rc; + if (sId.empty()) { + printError("%s| PDP Context ID is not specified", getName().c_str()); + return FAILURE; } - rc = getPdpContextsBase(jData); + std::string sCommand = "AT+CGDCONT=" + sId; + const int dTimeout = 1000; - if (SUCCESS != rc) { - printError("%s| Failed to fetch the list of the defined PDP contexts from the radio", getName().c_str()); + Json::Value jAllContexts; + + rc = getPdpContexts(jAllContexts); + if (rc != SUCCESS) { + printError("%s| Failed to retrieve the current PDP context configuration: [%d]", getName().c_str(), rc); return rc; } - if (bPdpAuthSupported) { - rc = fillPdpContextAuthFields(jData); - - if (SUCCESS != rc) { - printError("%s| Failed to fetch the authentication parameters for PDP contexts", getName().c_str()); + // Remove the context if no parameters defined + if (!jConfig.isMember(ICellularRadio::KEY_PDP_CONTEXT_IPMODE) && !jConfig.isMember(ICellularRadio::KEY_PDP_CONTEXT_APN)) { + if (jAllContexts.isMember(sId)) { + rc = sendBasicCommand(sCommand, dTimeout); return rc; + } else { + printError("%s| PDP Context [%s] does not exist", getName().c_str(), sId.c_str()); + return FAILURE; } } - return SUCCESS; -} - -ICellularRadio::CODE CellularRadio::mergePdpContexts(const std::string& sId, const Json::Value& jCurrentContext, const Json::Value& jChanges, Json::Value& jResult) { - jResult[KEY_PDP_CONTEXT_ID] = sId; - - if (jChanges.isMember(KEY_PDP_CONTEXT_IPMODE)) { - jResult[KEY_PDP_CONTEXT_IPMODE] = jChanges[KEY_PDP_CONTEXT_IPMODE].asString(); - } else if (jCurrentContext.isMember(KEY_PDP_CONTEXT_IPMODE)) { - printInfo("%s| Re-using IP Mode [%s] for PDP context [%s]", getName().c_str(), jCurrentContext[KEY_PDP_CONTEXT_IPMODE].asString().c_str(), sId.c_str()); - jResult[KEY_PDP_CONTEXT_IPMODE] = jCurrentContext[KEY_PDP_CONTEXT_IPMODE].asString(); - } - - if (jChanges.isMember(KEY_PDP_CONTEXT_APN)) { - jResult[KEY_PDP_CONTEXT_APN] = jChanges[KEY_PDP_CONTEXT_APN].asString(); - } else if (jCurrentContext.isMember(KEY_PDP_CONTEXT_APN)) { - printInfo("%s| Re-using APN [%s] for PDP context [%s]", getName().c_str(), jCurrentContext[KEY_PDP_CONTEXT_APN].asString().c_str(), sId.c_str()); - jResult[KEY_PDP_CONTEXT_APN] = jCurrentContext[KEY_PDP_CONTEXT_APN].asString(); - } - - if (jChanges.isMember(KEY_PDP_CONTEXT_AUTH_TYPE)) { - jResult[KEY_PDP_CONTEXT_AUTH_TYPE] = jChanges[KEY_PDP_CONTEXT_AUTH_TYPE].asString(); - } - - if (jChanges.isMember(KEY_PDP_CONTEXT_AUTH_USERNAME)) { - jResult[KEY_PDP_CONTEXT_AUTH_USERNAME] = jChanges[KEY_PDP_CONTEXT_AUTH_USERNAME].asString(); - } - - if (jChanges.isMember(KEY_PDP_CONTEXT_AUTH_PASSWORD)) { - jResult[KEY_PDP_CONTEXT_AUTH_PASSWORD] = jChanges[KEY_PDP_CONTEXT_AUTH_PASSWORD].asString(); - } - - return SUCCESS; -} - -ICellularRadio::CODE CellularRadio::initPdpContextInfo(const Json::Value& jConfig, PdpContextInfo& pdpContextResult) { - // validate IP mode - if (jConfig[KEY_PDP_CONTEXT_IPMODE].asString() != VALUE_PDP_CONTEXT_IP_MODE_IP && - jConfig[KEY_PDP_CONTEXT_IPMODE].asString() != VALUE_PDP_CONTEXT_IP_MODE_IPV6 && - jConfig[KEY_PDP_CONTEXT_IPMODE].asString() != VALUE_PDP_CONTEXT_IP_MODE_IPV4V6) { - printError("%s| The PDP context IP mode value is invalid [%s]", getName().c_str(), jConfig[KEY_PDP_CONTEXT_IPMODE].asString().c_str()); - return INVALID_ARGS; - } - - // validate authentication fields only if it is present - if (jConfig.isMember(KEY_PDP_CONTEXT_AUTH_TYPE)) { - - // check if the PDP context authentication is supported by the radio - const auto& sRequested = jConfig[KEY_PDP_CONTEXT_AUTH_TYPE].asString(); - const auto& vSupported = getSupportedPdpContextAuthTypes(); - - auto supportCheck = [sRequested](const std::string& sElement) { - return sRequested == sElement; - }; + std::string sIpMode; - if (std::none_of(vSupported.begin(), vSupported.end(), supportCheck)) { - printError("%s| PDP context parameters: authentication type [%s] is not supported", getName().c_str(), jConfig[KEY_PDP_CONTEXT_AUTH_TYPE].asString().c_str()); - return INVALID_ARGS; + if (jConfig.isMember(ICellularRadio::KEY_PDP_CONTEXT_IPMODE)) { + if (jConfig[ICellularRadio::KEY_PDP_CONTEXT_IPMODE] == "IP" || jConfig[ICellularRadio::KEY_PDP_CONTEXT_IPMODE] == "PPP" || + jConfig[ICellularRadio::KEY_PDP_CONTEXT_IPMODE] == "IPV6" || jConfig[ICellularRadio::KEY_PDP_CONTEXT_IPMODE] == "IPV4V6") { + sIpMode = jConfig[ICellularRadio::KEY_PDP_CONTEXT_IPMODE].asString(); + } else { + printError("%s| Invalid IP Mode defined: [%s]", getName().c_str(), jConfig[ICellularRadio::KEY_PDP_CONTEXT_IPMODE].asString().c_str()); + return FAILURE; } + } else if (jAllContexts.isMember(sId)) { + printInfo("%s| Re-using IP Mode [%s] for PDP context [%s]", getName().c_str(), jAllContexts[sId][ICellularRadio::KEY_PDP_CONTEXT_IPMODE].asString().c_str(), sId.c_str()); + sIpMode = jAllContexts[sId][ICellularRadio::KEY_PDP_CONTEXT_IPMODE].asString(); + } else { + printError("%s| Failed to edit PDP context [%s] - no such context defined", getName().c_str(), sId.c_str()); + return FAILURE; } - if (! jConfig.isMember(KEY_PDP_CONTEXT_AUTH_TYPE) && (jConfig.isMember(KEY_PDP_CONTEXT_AUTH_USERNAME) || jConfig.isMember(KEY_PDP_CONTEXT_AUTH_PASSWORD))) { - printError("%s| PDP context authentication type is not provided, but username or password are given", getName().c_str()); - return INVALID_ARGS; - } - - if (jConfig.isMember(KEY_PDP_CONTEXT_AUTH_TYPE) && jConfig[KEY_PDP_CONTEXT_AUTH_TYPE].asString() != VALUE_PDP_CONTEXT_AUTH_TYPE_NONE && - ! (jConfig.isMember(KEY_PDP_CONTEXT_AUTH_USERNAME) && jConfig.isMember(KEY_PDP_CONTEXT_AUTH_PASSWORD))) { - printError("%s| PDP context authentication type [%s]. The username or password are not provided", getName().c_str(), jConfig[KEY_PDP_CONTEXT_AUTH_TYPE].asString().c_str()); - return INVALID_ARGS; - } - - // fills with empty string if there are no such fields - pdpContextResult.sId = jConfig[KEY_PDP_CONTEXT_ID].asString(); - pdpContextResult.sIpMode = jConfig[KEY_PDP_CONTEXT_IPMODE].asString(); - pdpContextResult.sApn = jConfig[KEY_PDP_CONTEXT_APN].asString(); - pdpContextResult.sAuthType = jConfig[KEY_PDP_CONTEXT_AUTH_TYPE].asString(); - pdpContextResult.sUsername = jConfig[KEY_PDP_CONTEXT_AUTH_USERNAME].asString(); - pdpContextResult.sPassword = jConfig[KEY_PDP_CONTEXT_AUTH_PASSWORD].asString(); - - return SUCCESS; -} - -ICellularRadio::CODE CellularRadio::isPdpContextAuthEditRequired(const Json::Value& jConfig, bool& bIsAuthEditRequired) { - bIsAuthEditRequired = false; - - if (jConfig.isMember(KEY_PDP_CONTEXT_AUTH_TYPE) || - jConfig.isMember(KEY_PDP_CONTEXT_AUTH_PASSWORD) || - jConfig.isMember(KEY_PDP_CONTEXT_AUTH_USERNAME)) { - bIsAuthEditRequired = true; - } - - return SUCCESS; -} - -ICellularRadio::CODE CellularRadio::setPdpContextBase(const PdpContextInfo& pdpContext) { - std::string sCommand = "AT+CGDCONT="; - const int dTimeout = 1000; - - sCommand += pdpContext.sId; sCommand += ",\""; - sCommand += pdpContext.sIpMode; - sCommand += "\",\""; - sCommand += pdpContext.sApn; + sCommand += sIpMode; sCommand += "\""; - return sendBasicCommand(sCommand, dTimeout); -} - -ICellularRadio::CODE CellularRadio::deletePdpContext(const std::string& sId) { - std::string sCommand = "AT+CGDCONT=" + sId; - const int dTimeout = 1000; - - return sendBasicCommand(sCommand, dTimeout); -} - -ICellularRadio::CODE CellularRadio::setPdpContext(const std::string& sId, const Json::Value& jConfig) { - printTrace("%s| Setting PDP context [%s] to the radio", getName().c_str(), sId.c_str()); - - CODE rc; - Json::Value jCurrentContexts; - bool bPdpAuthSupported; - bool bPdpAuthEditRequired; - PdpContextInfo pdpContext; - - if (sId.empty()) { - printError("%s| PDP Context ID is not specified", getName().c_str()); - return INVALID_ARGS; - } - - rc = getPdpContexts(jCurrentContexts); - if (SUCCESS != rc) { - return rc; - } + std::string sApn; - // DELETE context - - if (jConfig.empty()) { - rc = deletePdpContext(sId); - if (SUCCESS != rc) { - printError("%s| Failed to delete PDP context [%s]", getName().c_str(), sId.c_str()); - } - return rc; - } - - // ADD or EDIT context - - // check if PDP context authentication is applicable - - (void) isPdpContextAuthEditRequired(jConfig, bPdpAuthEditRequired); - - rc = isPdpContextAuthSupported(bPdpAuthSupported); - if (SUCCESS != rc) { - return rc; - } - - if (! bPdpAuthSupported && bPdpAuthEditRequired) { - printError("%s| PDP context authentication is not supported by this radio, but arguments are provided", getName().c_str()); - return INVALID_ARGS; - } - - Json::Value jResult; - - // Edit - fetch missing arguments from the current state. - (void) mergePdpContexts(sId, jCurrentContexts[sId], jConfig, jResult); - - // validate fields and create a PDP context structure to use in the commands - rc = initPdpContextInfo(jResult, pdpContext); - if (SUCCESS != rc) { - return rc; + if (jConfig.isMember(ICellularRadio::KEY_PDP_CONTEXT_APN)) { + sApn = jConfig[ICellularRadio::KEY_PDP_CONTEXT_APN].asString(); + } else if (jAllContexts.isMember(sId)) { + printInfo("%s| Re-using APN [%s] for PDP context [%s]", getName().c_str(), jAllContexts[sId][ICellularRadio::KEY_PDP_CONTEXT_APN].asString().c_str(), sId.c_str()); + sApn = jAllContexts[sId][ICellularRadio::KEY_PDP_CONTEXT_APN].asString(); + } else { + printError("%s| Failed to edit PDP context [%s] - no such context defined", getName().c_str(), sId.c_str()); + return FAILURE; } - // setting context - rc = setPdpContextBase(pdpContext); - if (SUCCESS != rc) { - return rc; - } + sCommand += ",\""; + sCommand += sApn; + sCommand += "\""; - if (bPdpAuthSupported && bPdpAuthEditRequired) { - return setPdpContextAuth(pdpContext); - } + rc = sendBasicCommand(sCommand, dTimeout); - return SUCCESS; + return rc; } ICellularRadio::CODE CellularRadio::getDiagnostics(std::string& sReport) { -- cgit v1.2.3