Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: in DataUpload, commented unused function & added docs #132

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
15 changes: 15 additions & 0 deletions src/cellular/dataUpload.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,24 @@ class DataUpload : public Task{
void exit(void);

private:
/**
* @brief Stores if data upload state successfully initializes.
* Variable storing 1 if system successfully enters data upload state, or 0 if system times out
* before entering data upload state.
*/
int initSuccess;
system_tick_t lastConnectTime;
/**
* @brief Exits data upload state.
* Function ends data upload process then enters deep sleep state.
*/
Tylody marked this conversation as resolved.
Show resolved Hide resolved
STATES_e exitState(void);
Tylody marked this conversation as resolved.
Show resolved Hide resolved
/**
* @brief Identifies if data upload is possible.
* Returns that the data upload is possible if: the recorder has data, is connected to a cloud
* service, is not in water, and the battery has enough voltage for an upload. Otherwise,
* changes current state from upload state to deep sleep, or deployed if currently in water.
Tylody marked this conversation as resolved.
Show resolved Hide resolved
*/
STATES_e can_upload(void);
Tylody marked this conversation as resolved.
Show resolved Hide resolved
};
#endif
Loading