Releases: Ahsoka/beskar
Beskar v2.0.1 - Bug Fixes
Bug Fixes
- Fixed bug where the
Save
button would be enabled before a scan had completed, see e56e124. - Fixed bug where the
Start
Button would not be enabled immediately after a scan completed, see 6d28894. - Fixed bug where code could not be run on any other OS than Windows, see 0f9d58e.
UPDATE: Please note this binary has not been tested on Windows 11 and you may run into issues when running on Windows 11! See #18 for more information.
SHA256 Hash: b7837b8b15a8858444bc4c8d5ad6af16f16a8de3add77522a20a7a6a5188880c
If you want to use the SEAL kit you must for install the NI-DAQmx drivers, specifically version 20.1 You can install these drivers from here: https://www.ni.com/en-us/support/downloads/drivers/download.ni-daqmx.html#348669
However, if you do not have access to a SEAL kit, then you do not need to install the drivers.
Beskar v2.0.0 - Complete UI/UX Overhaul
Completely Changed the UI/UX
The user-interface (UI) and user-experience (UX) is now completed changed. The app theme is now a dark theme, changed from the default light theme. This closes #7.
Startup Popup
Instead of having many different popups the user has to complete there is now a single popup that the user interacts at the beginning of the app. This popup handles the selecting the SEAL kit, selecting the offset voltage, and applying the main voltage. The Apply Voltage page no longer exists. This startup popup has a "step progress bar" at the top to indicate how many steps are remaining left for the user to complete (see f7befcb).
See the following commits:
- faed185
- 2e56df4 (typo in commit name should read "Create
NoSEALKitPopup
") - ef407fe
- fe76610
- 9c06d40
- add6d53
Main Window
The main window is now only comprised of the the Dark Current page and the Scan page.
Bug Fixes
Final Note
This page does not really do justice to the expansive changes in this version. The best way to see the changes is to install the application.
SHA256 Hash: 495e1a7aeb86704265cfcb70f6010df1943064615162b6f47aa6ed178ee79a2c
If you want to use the SEAL kit you must for install the NI-DAQmx drivers, specifically version 20.1 You can install these drivers from here: https://www.ni.com/en-us/support/downloads/drivers/download.ni-daqmx.html#348669
However, if you do not have access to a SEAL kit, then you do not need to install the drivers.
Beskar v1.1.1 - Automatic Update Bug Fix
Automatic Update Bug Fix
Fixed bug where the automatic updating wouldn't run unless the setup exe file was already installed. In other words, the automatic updates didn't work. See 4172c3d.
SHA256 Hash: 739081c4112f86799e45e4e7f10636d0d41e5ffde1782a578f46d0ac8a6a22c7
If you want to use the SEAL kit you must for install the NI-DAQmx drivers, specifically version 20.1 You can install these drivers from here: https://www.ni.com/en-us/support/downloads/drivers/download.ni-daqmx.html#348669
However, if you do not have access to a SEAL kit, then you do not need to install the drivers.
Beskar v1.1.0 - Automatic Updating
Automatic Updating
This version introduces automatic updating. This means that whenever a new update is released the user will be notified via a toaster message. See the image below for reference:
This design was inspired by the toaster notifications from the PowerToys app.
This change should not break compatibility for Linux/macOS, see 63ef075, however I have not personally tested this.
See these commits for implementation of this change: f211d59 and ea4070c
Updated Descriptions in Pages
The descriptions in each of the pages were reviewed for by Caltech graduate student, Zachary Ifkovits, for accuracy. The follow commits are the changes he recommended:
Logging
All logs are now created in folders based on the application version, see e2110e2.
Error Reporting
App version is now sent with error log, see 90aef50.
Window Titles
The following popups will now have there own names (name is no longer inherited from the main window):
-
MultipleSEALKitsPopup
, see 6286b2d. -
NoSEALKitPopup
, see f72047b. -
EnterVoltsPopup
, see 3040ec3. -
The main window title will now indicate when mocked mode is enabled, see 59fd6fc.
ErrorPopup
The ErrorPopup
is no longer a child of the main window, see 76c3933. It now has it's own new icon (which can be seen here), see b10ab1b.
Also the ErrorPopup
will attempt get focus when it is created, see c3b58fd.
Minor changes to setup-exe-script.iss
Note about sha256-hashes
folder
Every version after v1.0.0
will now have a SHA256 hash in the sha256-hashes
folder to help the app verify that installed setup exe used for updating app is in fact the correct copy and is not corrupted.
SHA256 hash: f4a9cdda0f3e3a8d593fcb88c4301a00cb5293bde95e8ff9eca0128c540b3f8f
Beskar v1.0.0 - Officially Out of Beta!
UI Changes
- Added descriptions for:
- Resized Save button to a "normally sized" button in the Scan page, see 3af63f2.
- Renamed "Do another scan" button to "Do another scan(s)", see d376360.
- Resized "Do another scan(s)" button to a "normally sized" button, 3af63f2.
- Added "Go back to scans" button, which allows the user to go back the scans screen if they accidentally click the "Do another scan(s)" button, see 9bb83dd.
- Removed the ability to close the
NoSEALKitPopup
, see here. - Added a quit button to the
NoSEALKitPopup
, see 69b62da. - Added quit button to the
MultipleSEALKitPopup
, see c591cea. NoSEALKitPopup
is now a fixed size, see 911ad37.MultipleSEALKitPopup
now has a fixed height, see e50f119.- Created popup for the when the program crashes, see 96a2aae.
- Removed console from app, see 9f5e48e.
- Added a notice for when the user is trying to detect the SEAL kit (via the refresh button), but does not have the NI-DAQmx drivers installed on their computer, see 81f10d2.
Automatic Crash Reports
The app now includes automatic crash reports, thanks to Sentry.io. Everytime the app crashes an automatic crash report will be sent to me unless the user opts out of sending the crash report. The app is designed to collect only relevant information. Specifically, I am collecting information about operating system name (Windows, Linux, macOS, etc), the operating system version, whether or not dark mode is enabled, and how the user interacted with app prior to the crash (you can see the specifics of this information by seeing the logging calls in the app).
See 96a2aae and 9f77128 for more information.
Bug Fixes
- Fixed bug where when the user requested that the
MockedModePopup
shouldn't show up again it would still show if the user closes the window any other way than clicking the 'OK' button, see 43229fc. - Fixed bug where right clicking a tab in the Scan page would cause the program to think that a bar chart on a different was now being displayed see 0d86b48.,
- Fixed a bug where if a user clicked away from the last tab in the Scan page into another tab and clicked back into the last tab the Save button would be disabled even if the scanning was finished, see d73937d.
- Fixed bug where users could use the Escape key to bypass the
NoSEALKitPopup
, see 38e9099. - Fixed incorrect program exiting, now using
QtCore.QCoreApplication.quit()
instead ofsys.exit()
Final Note
The app is now a "minimum viable product." It has all of the core features needed to make it useable to by the wider public. However, there are two concerns that I still have. First the scanning implementation has not been tested thoroughly enough and has never been tested with a real plate. I have tried my best to mimic the legacy code provided by Dr. Winkler, however, this an area I need to keep my eye on. Second is that aesthetic is undesirable to say the least. If possible I would like to update the aesthetic of the app. Additionally, I would like to have the descriptions reviewed by the SEAL kit mentors.
If you want to use the SEAL kit you must for install the NI-DAQmx drivers, specifically version 20.1 You can install these drivers from here: https://www.ni.com/en-us/support/downloads/drivers/download.ni-daqmx.html#348669
However, if you do not have access to a SEAL kit, then you do not need to install the drivers.
Note: If you are planning on building/running on macOS, there is currently a bug which I have not determined the cause of yet, which causes a segmentation fault upon exiting the program, see this link for more information: https://www.riverbankcomputing.com/static/Docs/PyQt6/gotchas.html#crashes-on-exit.
Beskar v0.8.0 Beta - Save Scans
Saving Scans
This version now adds the ability for you to save scans. Scans can either be saved as a .csv
file or a .png
file; please note that the .png
files (which is just a screenshot of the 3D bar chart) is buggy and does not work all the time. If requested I can also add the ability to save as an Excel .xlsx
file.
Updated Setup Exe
- Now have the option to choose whether to do a user install or an admin install, see 5d080d6.
- Installs in
C:\Program Files
instead ofC:\Program Files (x86)
, see 49980c7. - Created setup exe with Inno Setup version 6.2.0 instead of version 6.1.2 meaning there are now new icons in the setup exe.
New Icon
There is a new icon for dark mode, called the beskar-icon-white.png
. Used in the file dialog popup when the OS dark mode is enabled, see c6fbb2c and 8c01235.
Bug Fixes
- Created a better fix for the slider in the apply voltage page, see f2c4fd7.
- Fixed bug where screen resolution was detected incorrectly, see 119bfd7.
Compiling from Source
- Changed
setup-exe-script.iss
to not look for specific files. This should make it easier to create a setupexe
file. See 2c7a554 for the rationale behind this change.
Code Restructure
- All the pages classes now have a base class
BasePage
, 078adb3 and e9bda78. - All the popup classes now have a base class
BasePopup
, 4c3960d and 2fbefba. - Both all the popup and pages classes now have a base class
BaseInteractable
. - Removed really long lines in
pages.py
, see c8c0182. - New dependency,
darkdetect
.
Binaries are included with this version
If you want to use the SEAL kit you must for install the NI-DAQmx drivers, specifically version 20.1 You can install these drivers from here: https://www.ni.com/en-us/support/downloads/drivers/download.ni-daqmx.html#348669
However, if you do not have access to a SEAL kit, then you do not need to install the drivers.
Note: If you are planning on building/running on macOS, there is currently a bug which I have not determined the cause of yet, which causes a segmentation fault upon exiting the program, see this link for more information: https://www.riverbankcomputing.com/static/Docs/PyQt6/gotchas.html#crashes-on-exit.
Beskar v0.7.1 Beta - Bug Fixes
Bug Fixes
- Fixed issue in
settings.py
which prevented the app from working on any operating system other than Windows, see f2e65d9. - Fixed issue with slider in Apply Voltage page for aspect ratios less than 21:9, see 1c98a10.
UI Changes
- Centered header in
MockedModePopup
, see 04fa61f.
Compiling from Source
- Fixed absolute paths in
setup-exe-script.iss
, see 8e080c5. - Created
convert-to-exe.py
to replaceconvert-to-exe.bat
to make it easier for other people to compile from source, see 5efae92. - Added new
DLL
s and removed oldDLL
s fromsetup-exe-script.iss
.
Binaries are included with this version
If you want to use the SEAL kit you must for install the NI-DAQmx drivers, specifically version 20.1 You can install these drivers from here: https://www.ni.com/en-us/support/downloads/drivers/download.ni-daqmx.html#348669
However, if you do not have access to a SEAL kit, then you do not need to install the drivers.
The installer is only for 64 bit Windows. Despite what the previous releases state, there are no plans to release a 32 bit version unless it is explicitly requested. Make an issue if you would like a 32 bit installer.
Additionally, I will not be building a Linux version. As of this version the program works with Linux so feel free to build a Linux version yourself. If you need help or run into any problems make an issue.
Note: If you are planning on building/running on macOS, there is currently a bug which I have not determined the cause of yet, which causes a segmentation fault upon exiting the program, check back later for a link to an issue.
Beskar v0.7.0 Beta - Settings File
Settings
This version introduces a basic settings file which can store various user options.
The specific options are:
- The voltage used in the
EnterVoltsPopup
- The voltage used in the
ApplyVoltagePage
- Whether or not to display the
MockedModePopup
- The number of scans in the
ScanPage
The program will read the values in the settings file and automatically adjust the sliders and/or spin boxes, accordingly.
Bug Fixes
- Fixed issue where the
MockedModePopup
would be really long horizontally, see 57f99d2 - Fixed issue where mocked mode wouldn't work in Linux, see 2321608
Binaries are included with this version
If you want to use the SEAL kit you must for install the NI-DAQmx drivers, specifically version 20.1 You can install these drivers from here: https://www.ni.com/en-us/support/downloads/drivers/download.ni-daqmx.html#348669
However, if you do not have access to a SEAL kit, then you do not need to install the drivers.
The installer is only for 64 bit Windows. Despite what the previous releases state, there are no plans to release a 32 bit version unless it is explicitly requested. Make an issue if you would like a 32 bit installer.
Additionally, I will not be building a Linux version. As of this version the program works with Linux so feel free to build a Linux version yourself. If you need help or run into any problems make an issue. See v0.7.1-beta
for Linux compatibility.
Beskar v0.6.0 Beta - Mocked Mode!
Mocked Mode
Mocked mode enables people to use the software without a SEAL kit connected to their computer. This mode is mainly for anyone who wants to try out the software for themselves and does not have access to a SEAL kit.
Bug Fixes
- Fixed bug where the data from
EnterVoltsPopup
wouldn't be read properly if the user activated this popup from either theNoSEALKitPopup
or theMultipleSEALKitsPopup
popups, see 00848e0. - Fixed issue where the icon would not display correctly when compiled to an
exe
, see ad5f730
Binaries are included with this version
If you want to use the SEAL kit you must for install the NI-DAQmx drivers, specifically version 20.1 You can install these drivers from here: https://www.ni.com/en-us/support/downloads/drivers/download.ni-daqmx.html#348669
However, if you do not have access to a SEAL kit, then you do not need to install the drivers.
The installer is only for 64 bit Windows. Despite what the previous releases state, there are no plans to release a 32 bit version unless it is explicitly requested. Make an issue if you would like a 32 bit installer.
Later on this version will include a Linux binary. Check back soon!
Beskar v0.5.1 Beta - More Accurate Flashing Timing
More Accurate Flashing Timing
This version introduces much better synchronization with the LEDs flashing. See this wiki page for more information on this. This mostly fixes the issue mentioned in #2.
Bug Fix
Fixed bug where the LEDs position would be incorrect after the first set of flashing, see e2f5637.
Misc
- Created license file: 0f8ef05
- Changed how the first and second cycle are distinguished: b363f3a
- Adding typing (PEP484) for
start_at_zero
parameter in theLED_position_gen
function; see ec8797d
Binaries are included with this version
In order to use the program you must for install the NI-DAQmx drivers, specifically version 20.1. You can install these drivers from here: https://www.ni.com/en-us/support/downloads/drivers/download.ni-daqmx.html#348669
The installer is only for 64 bit Windows. Future versions will hopefully have 32 bit support.