diff --git a/src/chargeTask.hpp b/src/chargeTask.hpp index df6b562..cac0491 100644 --- a/src/chargeTask.hpp +++ b/src/chargeTask.hpp @@ -26,13 +26,32 @@ class ChargeTask : public Task{ void init(void); /** * @brief Charges the device, and exits to CLI on command - */ + * + * @return STATE_CLI when CLI pattern entered or + * STATE_DEEP_SLEEP when device not charging + */ STATES_e run(void); void exit(void); private: + /** + * @brief Buffer for storing command-line input + * + * Character array holds input from CLI with a maxiumum size of 'CLI_BUFFER_LEN' + */ char inputBuffer[CLI_BUFFER_LEN]; + /** + * @brief LED status indicator for charging task + * + * Object defines visual status of device's charging state + */ LEDStatus ledStatus; + /** + * @brief Timestamp for tracking start of charging process + * + * startTime = 0 indicates the device charging since + * the powering on of the device + */ system_tick_t startTime; }; #endif