Skip to content

Commit

Permalink
89 docs charge task (#99)
Browse files Browse the repository at this point in the history
Fix: Added variables and function documentation
  • Loading branch information
ntlhui authored Nov 11, 2024
2 parents fcb09e1 + d84d407 commit 2ae35b2
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion src/chargeTask.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 2ae35b2

Please sign in to comment.