Non-volatile memory counter and flag refactor with unit tests #93
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
nateinaction
changed the title
… into hardware-abstraction-registers
Merged
Co-authored-by: Nate Gay <[email protected]>
… into hardware-abstraction-registers
nateinaction
commented
Jan 25, 2025
Comment on lines
-542
to
-557
| @property | ||
| def burnarm(self) -> bitFlag: | ||
| return self.f_burnarm | ||
|
|
||
| @burnarm.setter | ||
| def burnarm(self, value: bitFlag) -> None: | ||
| self.f_burnarm: bitFlag = value | ||
|
|
||
| @property | ||
| def burned(self) -> bitFlag: | ||
| return self.f_burned | ||
|
|
||
| @burned.setter | ||
| def burned(self, value: bitFlag) -> None: | ||
| self.f_burned: bitFlag = value | ||
|
|
There was a problem hiding this comment.
Note to reviewers, these fns were unused. Instead of updating the flag implementations, we removed them.
There was a problem hiding this comment.
Note: All but nvm registers _BOOTCNT, _ERRORCNT, and _FLAG were removed due to not being able to find any further usage of them across the repo.
nateinaction
changed the title
TaylorGilg
approved these changes
Jan 25, 2025
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.
Summary
This PR replaces the
bitflagsmodule with annvmmodule that is designed to help with interactions with non-volatile memory (nvm) on the microcontroller. This change started with making a hardware abstraction layer for NVM interactions so we could write unit tests for thebitflagsmodule. Most of thebitflags.multibitflagpackage was tested and working in e576ae8After getting that far, we worked to reduce the features implemented by the
multiBitFlagclass to only what the current version of the flight software uses. We ended up with a simpleCounterclass with two methodsget()andincrement().Also we built a stub for
ByteArraywhich is the interface definition used to back CircuitPython's NVM implementation. I have attempted to contribute this upstream: adafruit/Adafruit_CircuitPython_Typing#46Next @TaylorGilg converted the
bitFlagclass to a class namedFlagwhich offers two methodsget()andtoggle()and added tests.Testing
Added unit tests
Tested on board