summaryrefslogtreecommitdiff
path: root/include/mts/MTS_IO_ICellularRadio.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/mts/MTS_IO_ICellularRadio.h')
-rw-r--r--include/mts/MTS_IO_ICellularRadio.h21
1 files changed, 21 insertions, 0 deletions
diff --git a/include/mts/MTS_IO_ICellularRadio.h b/include/mts/MTS_IO_ICellularRadio.h
index 91ab782..0523236 100644
--- a/include/mts/MTS_IO_ICellularRadio.h
+++ b/include/mts/MTS_IO_ICellularRadio.h
@@ -697,6 +697,27 @@ namespace MTS {
*/
virtual CODE setPdpContext(const std::string& sId, const Json::Value& jConfig) = 0;
+ /**
+ * @brief Execute the diagnostics AT commands and capture their output
+ *
+ * NOTE: The list of diagnostic AT commands is radio-specific and changes
+ * depending on the radio model (code).
+ *
+ * NOTE: The method stops its execution if the radio repeatedly ignores
+ * the commands (returns no execution result for several of them). This
+ * is required to limit the maximum execution time of the function and
+ * prevent the process from occupying the radio for too long. In case
+ * of timeout, the report will contain the output of all commands that
+ * it managed to execute before the failure.
+ *
+ * @param sDiagReport - the AT commands execution report.
+ *
+ * @return CODE::SUCCESS when fetched successfully,
+ * CODE::NO_RESPONSE when the radio ignored several of the AT commands,
+ * CODE::FAILURE otherwise.
+ */
+ virtual CODE getDiagnostics(std::string& sDiagReport) = 0;
+
};
}
}