fix: in DataUpload, commented unused function & added docs #132
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
documented exitState, can_upload, initSuccess
6 tasks
|
lastConnectTime has no uses outside of this header file. Should I add a commit to remove lastConnectTime, or simply add documentation for it? |
ntlhui
requested changes
Nov 17, 2024
documented initSuccess, and canUpload commented out exitState (unused function)
Tylody
changed the title
ntlhui
requested changes
Nov 22, 2024
dataupload returns if data upload is possible, if we should go to redeployment, or sleep, depending on if the recorder has data, if we are connected to cloud services, if we are in water, and if battery has sufficient voltage. illustrated in the docs via a truth table.
|
This is not ready for review - please resolve merge conflicts before requesting review. |
ntlhui
requested changes
Jan 10, 2025
updated table for DataUpload on return state of smartfin for clarity
ntlhui
requested changes
Jan 13, 2025
Comment on lines
+78
to
+81
| * | | Return State | | | | ||
| * |----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| * | | data upload is possible | smartfin redeploys | smartfin goes to sleep | | ||
| * | required conditions: | All of the following conditions must be met:<br><br>- Recorder has data is TRUE<br>- Connected to cloud is TRUE<br>- In water is FALSE<br>- Sufficient voltage is TRUE | All of the following conditions must be met:<br><br>- Recorder has data is TRUE<br>- Connected to cloud is TRUE<br>- In water is TRUE<br>- Sufficient voltage: TRUE or FALSE | Any one of the conditions are met:<br><br>- Recorder has data is FALSE<br>- Connected to cloud is FALSE<br>- In water is FALSE at the same time sufficient voltage is FALSE | |
There was a problem hiding this comment.
This table might not be the best way to display this information - keep in mind that sometimes we look at this from the IDE.
Consider a list of conditions which must be true for specific outputs to occur.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
documented exitState, can_upload, initSuccess