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 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/cellular/dataUpload.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,10 @@ void DataUpload::exit(void)
}
}

// In smartfin-fw2/src/dataUpload::DataUpload::exitState(void), we return based on the water sensor state. If the system is in the water, we redeploy, otherwise we go to sleep.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Either format as docstring and comment out, or remove documentation comment

/*
STATES_e DataUpload::exitState(void)
{
return STATE_DEEP_SLEEP;
}
}
*/
14 changes: 13 additions & 1 deletion src/cellular/dataUpload.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,21 @@ 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;
STATES_e exitState(void);
//In smartfin-fw2/src/dataUpload::DataUpload::exitState(void), we return based on the water sensor state. If the system is in the water, we redeploy, otherwise we go to sleep.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Either format as docstring and comment out, or remove documentation comment

//STATES_e exitState(void);
/**
* @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. If the system is currently in water, we redeploy, otherwise we go to sleep.
Comment on lines +58 to +59
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make this a table?

* @return Returns state enumeration of STATE_UPLOAD, STATE_DEEP_SLEEP, or STATE_DEPLOYED upon execution.
*/
STATES_e can_upload(void);
};
#endif
Loading