From 42d384984b2f760bc8f7a69c7ea3464c73f4d892 Mon Sep 17 00:00:00 2001 From: Serhii Kostiuk Date: Tue, 2 Jun 2020 17:19:03 +0300 Subject: [GP-651] LNA7: Allow to start the OMA DM procedure when it is required This commits adds support for the Quectel-specific OMA DM commands. This allows to trigger OMA DM procedure om Verizon to fetch the corrent APN values and other settings from the network. Expected radio output on success: ``` +QODM: "DME",0,DM Start +QODM: "DME",0,DM End ``` Other +QODM URC codes are also possible according to information from Quectel forum: https://forums.quectel.com/t/what-is-the-meaning-of-qodm-fumo-report-failed/2444/5. But only "DM Start" and "DM End" responses are expected, supported and treated as correct in the libmts-io. --- include/mts/MTS_IO_CellularRadio.h | 1 + include/mts/MTS_IO_ICellularRadio.h | 3 ++ include/mts/MTS_IO_QuectelRadio.h | 1 + src/MTS_IO_CellularRadio.cpp | 6 ++++ src/MTS_IO_QuectelRadio.cpp | 72 +++++++++++++++++++++++++++++++++++++ 5 files changed, 83 insertions(+) diff --git a/include/mts/MTS_IO_CellularRadio.h b/include/mts/MTS_IO_CellularRadio.h index 56506af..7f4ed2b 100644 --- a/include/mts/MTS_IO_CellularRadio.h +++ b/include/mts/MTS_IO_CellularRadio.h @@ -100,6 +100,7 @@ namespace MTS { CODE updateFumo(const Json::Value& jArgs, UpdateCb& stepCb) override; CODE resetHfa(const Json::Value& jArgs, UpdateCb& stepCb) override; CODE activate(const Json::Value& jArgs, UpdateCb& stepCb) override; + CODE startOmaDm(UpdateCb& stepCb) override; CODE setActiveFirmware(const Json::Value& jArgs) override; CODE getActiveFirmware(std::string& sFwId) override; CODE getEcho(bool& bEnabled) override; diff --git a/include/mts/MTS_IO_ICellularRadio.h b/include/mts/MTS_IO_ICellularRadio.h index 58d5076..c301191 100644 --- a/include/mts/MTS_IO_ICellularRadio.h +++ b/include/mts/MTS_IO_ICellularRadio.h @@ -431,6 +431,9 @@ namespace MTS { * "fwid" : "Firmware Image To Be Enabled: STRING" * } */ + + virtual CODE startOmaDm(UpdateCb& stepCb) = 0; + virtual CODE setActiveFirmware(const Json::Value& jArgs) = 0; virtual CODE getActiveFirmware(std::string& sFwId) = 0; diff --git a/include/mts/MTS_IO_QuectelRadio.h b/include/mts/MTS_IO_QuectelRadio.h index df3b5b5..1dc45cd 100644 --- a/include/mts/MTS_IO_QuectelRadio.h +++ b/include/mts/MTS_IO_QuectelRadio.h @@ -41,6 +41,7 @@ namespace MTS { CODE convertdBmToSignalStrength(const int32_t& dBm, int32_t& iRssi) override; CODE setMdn(const Json::Value& jArgs) override; + CODE startOmaDm(ICellularRadio::UpdateCb& stepCb) override; protected: QuectelRadio(const std::string& sName, const std::string& sRadioPort); diff --git a/src/MTS_IO_CellularRadio.cpp b/src/MTS_IO_CellularRadio.cpp index 50fdf5c..648894f 100644 --- a/src/MTS_IO_CellularRadio.cpp +++ b/src/MTS_IO_CellularRadio.cpp @@ -1020,6 +1020,12 @@ ICellularRadio::CODE CellularRadio::activate(const Json::Value&, UpdateCb&) { return NOT_APPLICABLE; } +ICellularRadio::CODE CellularRadio::startOmaDm(ICellularRadio::UpdateCb&) { + printTrace("%s| Start OMA DM procedure: not applicable", m_sName.c_str()); + + return NOT_APPLICABLE; +} + ICellularRadio::CODE CellularRadio::setActiveFirmware(const Json::Value&) { printTrace("%s| Set Active Firmware Image Number: not applicable", m_sName.c_str()); diff --git a/src/MTS_IO_QuectelRadio.cpp b/src/MTS_IO_QuectelRadio.cpp index c4bdc56..b750bd6 100644 --- a/src/MTS_IO_QuectelRadio.cpp +++ b/src/MTS_IO_QuectelRadio.cpp @@ -436,6 +436,78 @@ ICellularRadio::CODE QuectelRadio::setMdn(const Json::Value& jArgs) { return NOT_APPLICABLE; } +ICellularRadio::CODE QuectelRadio::startOmaDm(ICellularRadio::UpdateCb& stepCb) { + printTrace("%s| Start OMA DM procedure", getName().c_str()); + + const int32_t iTimeoutOk = 3 * 1000; // 3 seconds + const int32_t iTimeoutStart = 5 * 1000; // 5 seconds + const int32_t iTimeoutEnd = 1 * 60 * 1000; // 1 minute + + const std::string sOdmStarted = "DM Start"; + const std::string sOdmFinished = "DM End"; + + const std::vector vOdmStartedStrings{ sOdmStarted }; + const std::vector vOdmFinishedStrings{ sOdmFinished }; + + CODE eCode; + + do { + + // Send command and expect "OK" in iTimeoutOk milliseconds + eCode = sendBasicCommand("AT+QODM=\"DME\",2,\"UI\"", iTimeoutOk); + if (eCode != SUCCESS) { + printError("%s| OMA DM procedure can not be started", getName().c_str()); + if (stepCb) { + stepCb(Json::Value("OMA DM Error: OMA DM can not be started")); + } + break; + } + + // Wait for the "Start" response + std::string sResponse = sendCommand("", vOdmStartedStrings, iTimeoutStart, 0x00); + printDebug("%s| Radio returned: [%s]", getName().c_str(), sResponse.c_str()); + + if (sResponse.find(sOdmStarted) == std::string::npos) { + printError("%s| OMA DM procedure failed due to timeout", getName().c_str()); + if (stepCb) { + stepCb(Json::Value("OMA DM Error: OMA DM failed due to timeout")); + } + eCode = FAILURE; + break; + } + + // Got "DM Started" message from the radio + printTrace("%s| OMA DM started", getName().c_str()); + if (stepCb) { + stepCb(Json::Value("OMA DM Info: OMA DM started")); + } + + // Wait for the "End" response + sResponse = sendCommand("", vOdmFinishedStrings, iTimeoutEnd, 0x00); + printDebug("%s| Radio returned: [%s]", getName().c_str(), sResponse.c_str()); + + if (sResponse.find(sOdmFinished) == std::string::npos) { + printError("%s| OMA DM procedure failed due to timeout", getName().c_str()); + if (stepCb) { + stepCb(Json::Value("OMA DM Error: OMA DM failed due to timeout")); + } + eCode = FAILURE; + break; + } + + // Got "DM End" message from the radio + printTrace("%s| OMA DM finished", getName().c_str()); + if (stepCb) { + stepCb(Json::Value("OMA DM Info: OMA DM finished")); + } + + eCode = SUCCESS; + + } while (false); + + return eCode; +} + ICellularRadio::CODE QuectelRadio::getServiceDomain(ICellularRadio::SERVICEDOMAIN& sd) { printTrace("%s| Get Service Domain", getName().c_str()); -- cgit v1.2.3 From 406cce9d517465698bd6f60c788b01c0e9f8e32e Mon Sep 17 00:00:00 2001 From: Serhii Kostiuk Date: Wed, 3 Jun 2020 11:16:37 +0300 Subject: [GP-651] LNA7: Allow to start the OMA DM procedure when it is required Fixed AT+QODM parameters. AT+QODM parameters are case-sensitive. --- src/MTS_IO_QuectelRadio.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/MTS_IO_QuectelRadio.cpp b/src/MTS_IO_QuectelRadio.cpp index b750bd6..5d29be7 100644 --- a/src/MTS_IO_QuectelRadio.cpp +++ b/src/MTS_IO_QuectelRadio.cpp @@ -454,7 +454,7 @@ ICellularRadio::CODE QuectelRadio::startOmaDm(ICellularRadio::UpdateCb& stepCb) do { // Send command and expect "OK" in iTimeoutOk milliseconds - eCode = sendBasicCommand("AT+QODM=\"DME\",2,\"UI\"", iTimeoutOk); + eCode = sendBasicCommand("AT+QODM=\"dme\",2,\"ui\"", iTimeoutOk); if (eCode != SUCCESS) { printError("%s| OMA DM procedure can not be started", getName().c_str()); if (stepCb) { -- cgit v1.2.3 From 73a5dc4711da4d21a7f650aec4534ecb3691ca15 Mon Sep 17 00:00:00 2001 From: Serhii Kostiuk Date: Fri, 5 Jun 2020 12:18:58 +0300 Subject: [GP-651] LNA7: Allow to start the OMA DM procedure when it is required Fixes after a code review: - increased timeout from 60 to 160 seconds for "Abnormal" cases; - added hanlding for the "DME Abnormal" URC; - added "kill OMA DM" logic for the timeout case. --- src/MTS_IO_QuectelRadio.cpp | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/src/MTS_IO_QuectelRadio.cpp b/src/MTS_IO_QuectelRadio.cpp index 5d29be7..360d988 100644 --- a/src/MTS_IO_QuectelRadio.cpp +++ b/src/MTS_IO_QuectelRadio.cpp @@ -439,22 +439,29 @@ ICellularRadio::CODE QuectelRadio::setMdn(const Json::Value& jArgs) { ICellularRadio::CODE QuectelRadio::startOmaDm(ICellularRadio::UpdateCb& stepCb) { printTrace("%s| Start OMA DM procedure", getName().c_str()); + // TODO: All the timeout values below are empirically defined. + // Feel free to update them if you get any verified information. const int32_t iTimeoutOk = 3 * 1000; // 3 seconds const int32_t iTimeoutStart = 5 * 1000; // 5 seconds - const int32_t iTimeoutEnd = 1 * 60 * 1000; // 1 minute + const int32_t iTimeoutEnd = 160 * 1000; // 2 minutes 40 seconds + const int32_t iTimeoutAbort = 3 * 1000; // 3 seconds + + const std::string sCmdOdmStart = "AT+QODM=\"dme\",2,\"ui\""; + const std::string sCmdOdmAbort = "AT+QODM=\"dme\",2,\"kill\""; const std::string sOdmStarted = "DM Start"; const std::string sOdmFinished = "DM End"; + const std::string sOdmAbnormal = "DME Abnormal"; const std::vector vOdmStartedStrings{ sOdmStarted }; - const std::vector vOdmFinishedStrings{ sOdmFinished }; + const std::vector vOdmFinishedStrings{ sOdmFinished, sOdmAbnormal }; CODE eCode; do { // Send command and expect "OK" in iTimeoutOk milliseconds - eCode = sendBasicCommand("AT+QODM=\"dme\",2,\"ui\"", iTimeoutOk); + eCode = sendBasicCommand(sCmdOdmStart, iTimeoutOk); if (eCode != SUCCESS) { printError("%s| OMA DM procedure can not be started", getName().c_str()); if (stepCb) { @@ -467,6 +474,7 @@ ICellularRadio::CODE QuectelRadio::startOmaDm(ICellularRadio::UpdateCb& stepCb) std::string sResponse = sendCommand("", vOdmStartedStrings, iTimeoutStart, 0x00); printDebug("%s| Radio returned: [%s]", getName().c_str(), sResponse.c_str()); + // Received something unexpected or nothing at all? if (sResponse.find(sOdmStarted) == std::string::npos) { printError("%s| OMA DM procedure failed due to timeout", getName().c_str()); if (stepCb) { @@ -482,15 +490,27 @@ ICellularRadio::CODE QuectelRadio::startOmaDm(ICellularRadio::UpdateCb& stepCb) stepCb(Json::Value("OMA DM Info: OMA DM started")); } - // Wait for the "End" response + // Wait for the "End" or "Abnormal" response sResponse = sendCommand("", vOdmFinishedStrings, iTimeoutEnd, 0x00); printDebug("%s| Radio returned: [%s]", getName().c_str(), sResponse.c_str()); + // Received "Abnormal"? + if (sResponse.find(sOdmAbnormal) != std::string::npos) { + printError("%s| OMA DM procedure failed due to internal error: [%s]", getName().c_str(), sResponse.c_str()); + if (stepCb) { + stepCb(Json::Value("OMA DM Error: OMA DM failed due to internal error: [%s]", sOdmAbnormal.c_str())); + } + eCode = FAILURE; + break; + } + + // Received something unexpected or nothing at all? if (sResponse.find(sOdmFinished) == std::string::npos) { printError("%s| OMA DM procedure failed due to timeout", getName().c_str()); if (stepCb) { stepCb(Json::Value("OMA DM Error: OMA DM failed due to timeout")); } + sendBasicCommand(sCmdOdmAbort, iTimeoutAbort); // abort the procedure eCode = FAILURE; break; } -- cgit v1.2.3 From c9b6389ac4e53315e7d543091c821ea4b9771ed3 Mon Sep 17 00:00:00 2001 From: Serhii Kostiuk Date: Fri, 5 Jun 2020 13:55:04 +0300 Subject: [GP-651] LNA7: Allow to start the OMA DM procedure when it is required Fixed totally invalid string formatting for the stepCb argument. The previous implementation caused Json::Value to select the following constructor: ```Value(const char* begin, const char* end); ///< Copy all, incl zeroes.``` Which, of course, resulted in OOM violations. Oops. --- src/MTS_IO_QuectelRadio.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/MTS_IO_QuectelRadio.cpp b/src/MTS_IO_QuectelRadio.cpp index 360d988..4498919 100644 --- a/src/MTS_IO_QuectelRadio.cpp +++ b/src/MTS_IO_QuectelRadio.cpp @@ -498,7 +498,7 @@ ICellularRadio::CODE QuectelRadio::startOmaDm(ICellularRadio::UpdateCb& stepCb) if (sResponse.find(sOdmAbnormal) != std::string::npos) { printError("%s| OMA DM procedure failed due to internal error: [%s]", getName().c_str(), sResponse.c_str()); if (stepCb) { - stepCb(Json::Value("OMA DM Error: OMA DM failed due to internal error: [%s]", sOdmAbnormal.c_str())); + stepCb(Json::Value("OMA DM Error: OMA DM failed due to internal error")); } eCode = FAILURE; break; -- cgit v1.2.3