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

Update cdte #73

Merged
merged 4 commits into from
Apr 2, 2024
Merged

Update cdte #73

merged 4 commits into from
Apr 2, 2024

Conversation

KriSun95
Copy link
Collaborator

@KriSun95 KriSun95 commented Apr 1, 2024

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

  • Bug fix
  • New feature
  • Behavioural change
  • Other
    • ...

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.

Kristopher Cooper and others added 4 commits April 1, 2024 15:20
@KriSun95 KriSun95 merged commit b7609d8 into foxsi:main Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant