From 9055bbb69041651585d7fcde2a88255105faf625 Mon Sep 17 00:00:00 2001 From: Phat Nguyen Date: Sun, 31 Mar 2024 09:37:45 +0700 Subject: [PATCH] add comment --- examples/OneOpenAir/LocalConfig.cpp | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/examples/OneOpenAir/LocalConfig.cpp b/examples/OneOpenAir/LocalConfig.cpp index ede12ee..c565743 100644 --- a/examples/OneOpenAir/LocalConfig.cpp +++ b/examples/OneOpenAir/LocalConfig.cpp @@ -376,12 +376,24 @@ bool LocalConfig::isPostDataToAirGradient(void) { bool LocalConfig::isLocallyControlled(void) { return config.locallyControlled; } +/** + * @brief CO2 manual calib request, the request flag will clear after get. Must call this after parse success + * + * @return true Requested + * @return false Not requested + */ bool LocalConfig::isCo2CalibrationRequested(void) { bool requested = co2CalibrationRequested; co2CalibrationRequested = false; // clear requested return requested; } +/** + * @brief LED bar test request, the request flag will clear after get. Must call this function after parse success + * + * @return true Requested + * @return false Not requested + */ bool LocalConfig::isLedBarTestRequested(void) { bool requested = ledBarTestRequested; ledBarTestRequested = false; @@ -397,4 +409,9 @@ void LocalConfig::reset(void) { printConfig(); } +/** + * @brief Get model name, it's usage for offline mode + * + * @return String + */ String LocalConfig::getModel(void) { return String(config.model); }