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.
A PR for FOXSI-4's GSE 🦊
First and foremost, thank you so much for opening a PR for this repository. Any contribution is greatly appreciated.
Note
To make this process as easy as possible to follow when looking over and discussing the PR, please respond to each field below.
The fields below should inform the reader of the purpose(s) for the PR without having to infer things from the code itself.
What is reason for this PR
Describe why the PR is needed
For example, what problem is being tackled? What new behaviour is needed?
This PR is to introduce the changes in th GSE code proposed by the CdTe instrument team. Notes for these proposals can be found here.
Please provide a description of the changes/additions being made to the package
Although the changes in the code can be clear, try to describe the conceptial changes being made to the repository.
The first change is to change the Unix time display in the GUI to only show the last 6 digits of the Unix time and not the whole value (see commit
0a5f76e
).Another change is to come that will help indicate ring buffer space/read/write between the canister and DE. More to follow...
Are there any dangers in this change
In a perfect, flawless, ideal, faultless world all changes would be without danger and never have any knock-on effects; however, sadly, our world is not perfect, flawless, ideal, or faultless. 😔
The PR could be introducing breaking changes which may seem to be resolved by the time of this PR. However, here is a good space to lay out what those breaking changes were and how they were resolved, as well as to highlight any change for future alterations/tests/features.
No adverse effects expected. The Unix time change, at least, only involves one line that casts the unix value (
int
) to a string (str
) then indexing 6 entries from the end. If the string is not long enough for some reason tenth indexing returns as far back as it can go without issue.