Merge pull request #974 from OpenBCI/gui505-minor-fixes

Gui 5.0.5 minor fixes

Author: retiutut

CHANGELOG.md

@@ -1,10 +1,16 @@
 # v5.0.5
 
 ### Improvements
-* Implement Focus Widget using BrainFlow Metrics
+* Implement Focus Widget using BrainFlow Metrics! #924
+* Throw a popup if users are are running an old version of Windows operating system. GUI v5 supports 64-bit Windows 8, 8.1, and 10. #964
+* Throw a popup if Windows users are using 32-bit Java and Processing. #964
+* Set Networking Widget default baud rate for Serial output to 57600
 
 ### Bug Fixes
 * Fix Y axis Autoscale in TimeSeries when all values are less than zero. Example: Cyton with filters off
+* Gracefully handle cases when Cyton or Cyton+Daisy users want to use 8 or 16 channels #954
+* Update Save Session Settings success message. Session settings are no longer auto-loaded on Session start. #969
+* Session settings are no longer auto-saved when system is halted #969
 
 # v5.0.4
 

OpenBCI_GUI/Extras.pde

@@ -26,6 +26,22 @@ private boolean isMac() {
     return !isWindows() && !isLinux();
 }
 
+//BrainFlow only supports Windows 8 and 10. This will help with OpenBCI support tickets. #964
+private void checkIsOldVersionOfWindowsOS() {
+    boolean isOld = SystemUtils.IS_OS_WINDOWS_7 || SystemUtils.IS_OS_WINDOWS_VISTA || SystemUtils.IS_OS_WINDOWS_XP;
+    if (isOld) {
+        PopupMessage msg = new PopupMessage("Old Windows OS Detected", "OpenBCI GUI v5 and BrainFlow are made for 64-bit Windows 8, 8.1, and 10. Please update your OS, computer, or revert to GUI v4.2.0.");
+    }
+}
+
+//Sanity check for 64-bit Java for Windows users #964
+private void checkIs64BitJava() {
+    boolean is64Bit = System.getProperty("sun.arch.data.model").indexOf("64") >= 0;
+    if (!is64Bit) {
+        PopupMessage msg = new PopupMessage("32-bit Java Detected", "OpenBCI GUI v5 and BrainFlow are made for 64-bit Java (Windows, Linux, and Mac). Please update your OS, computer, Processing IDE, or revert to GUI v4 or earlier.");
+    }
+}
+
 
 //compute the standard deviation
 float std(float[] data) {

OpenBCI_GUI/Info.plist.tmpl

@@ -21,9 +21,9 @@
 
         <!-- Customize this set as you wish -->
         <key>CFBundleShortVersionString</key>
-        <string>4</string>
+        <string>5</string>
         <key>CFBundleVersion</key>
-        <string>5.0.4</string>
+        <string>5.0.5</string>
         <key>CFBundleSignature</key>
         <string>????</string>
         <key>NSHumanReadableCopyright</key>
@@ -32,7 +32,7 @@
 	Copyright © 2021 OpenBCI
 	</string>
         <key>CFBundleGetInfoString</key>
-        <string>March 2021</string>
+        <string>May 2021</string>
         <!-- End of the set that can be customized -->
 
         @@jvm_runtime@@

OpenBCI_GUI/Interactivity.pde

@@ -106,14 +106,14 @@ void parseKey(char val) {
 
         ///////////////////// Save User settings lowercase n
         case 'n':
-            println("Save key pressed!");
+            println("Interactivity: Save key pressed!");
             settings.save(settings.getPath("User", eegDataSource, nchan));
-            outputSuccess("Settings Saved! The GUI will now load with these settings. Click \"Default\" to revert to factory settings.");
+            outputSuccess("Settings Saved! Using Expert Mode, you can load these settings using 'N' key. Click \"Default\" to revert to factory settings.");
             return;
 
         ///////////////////// Load User settings uppercase N
         case 'N':
-            println("Load key pressed!");
+            println("Interactivity: Load key pressed!");
             settings.loadKeyPressed();
             return;
 

OpenBCI_GUI/OpenBCI_GUI.pde

@@ -51,11 +51,6 @@ import oscP5.*; // for OSC
 import hypermedia.net.*; //for UDP
 import java.nio.ByteBuffer; //for UDP
 import edu.ucsd.sccn.LSL; //for LSL
-//These are used by LSL
-//import com.sun.jna.Library;
-//import com.sun.jna.Native;
-//import com.sun.jna.Platform;
-//import com.sun.jna.Pointer;
 import com.fazecast.jSerialComm.*; //Helps distinguish serial ports on Windows
 import org.apache.commons.lang3.time.StopWatch;
 import http.requests.*;
@@ -65,7 +60,7 @@ import http.requests.*;
 //                       Global Variables & Instances
 //------------------------------------------------------------------------
 //Used to check GUI version in TopNav.pde and displayed on the splash screen on startup
-String localGUIVersionString = "v5.0.5-alpha.3";
+String localGUIVersionString = "v5.0.5";
 String localGUIVersionDate = "May 2021";
 String guiLatestVersionGithubAPI = "https://api.github.com/repos/OpenBCI/OpenBCI_GUI/releases/latest";
 String guiLatestReleaseLocation = "https://github.com/OpenBCI/OpenBCI_GUI/releases/latest";
@@ -363,18 +358,22 @@ void setup() {
     System.setOut(outputStream);
     System.setErr(outputStream);
 
-    String osName = "Operating System: ";
+    StringBuilder osName = new StringBuilder("Operating System: ");
     if (isLinux()) {
-        osName += "Linux";
+        osName.append("Linux");
     } else if (isWindows()) {
-        osName += "Windows";
+        osName.append("Windows");
+        //Throw a popup if we detect an incompatible version of Windows. Fixes #964. Found in Extras.pde.
+        checkIsOldVersionOfWindowsOS();
+        //This is an edge case when using 32-bit Processing Java on Windows. Throw a popup if detected.
+        checkIs64BitJava();
     } else if (isMac()) {
-        osName += "Mac";
+        osName.append("Mac");
     }
 
     println("Console Log Started at Local Time: " + directoryManager.getFileNameDateTime());
     println("Screen Resolution: " + displayWidth + " X " + displayHeight);
-    println(osName);
+    println(osName.toString());
     println("Welcome to the Processing-based OpenBCI GUI!"); //Welcome line.
     println("For more information, please visit: https://openbci.github.io/Documentation/docs/06Software/01-OpenBCISoftware/GUIDocs");
 
@@ -571,6 +570,27 @@ void initSystem() {
     // initialize the chosen board
     boolean success = currentBoard.initialize();
     abandonInit = !success; // abandon if init fails
+    
+    //Handle edge cases for Cyton and Cyton+Daisy users immediately after board is initialized. Fixes #954
+    if (eegDataSource == DATASOURCE_CYTON) {
+        println("OpenBCI_GUI: Configuring Cyton Channel Count...");
+        if (currentBoard instanceof BoardCytonSerial) {
+            Pair<Boolean, String> res = ((BoardBrainFlow)currentBoard).sendCommand("c");
+            //println(res.getKey().booleanValue(), res.getValue());
+            if (res.getValue().startsWith("daisy removed")) {
+                println("OpenBCI_GUI: Daisy is physically attached, using Cyton 8 Channels instead.");
+            }
+        } else if (currentBoard instanceof BoardCytonSerialDaisy) {
+            Pair<Boolean, String> res = ((BoardBrainFlow)currentBoard).sendCommand("C");
+            //println(res.getKey().booleanValue(), res.getValue());
+            if (res.getValue().startsWith("no daisy to attach")) {
+                haltSystem();
+                outputError("User selected Cyton+Daisy, but no Daisy is attached. Please change Channel Count to 8 Channels.");
+                controlPanel.open();
+                return;
+            }
+        }
+    }
 
     updateToNChan(currentBoard.getNumEXGChannels());
 
@@ -746,14 +766,6 @@ void haltSystem() {
         topNav.resetStartStopButton();
         topNav.destroySmoothingButton(); //Destroy this button if exists and make null, will be re-init if needed next time session starts
 
-        //Save a snapshot of User's GUI settings if the system is stopped, or halted. This will be loaded on next Start System.
-        //This method establishes default and user settings for all data modes
-        if (systemMode == SYSTEMMODE_POSTINIT && 
-            eegDataSource != DATASOURCE_GALEA && 
-            eegDataSource != DATASOURCE_STREAMING) {
-                settings.save(settings.getPath("User", eegDataSource, nchan));
-        }
-
         //reset connect loadStrings
         openBCI_portName = "N/A";  // Fixes inability to reconnect after halding  JAM 1/2017
         ganglion_portName = "";
@@ -891,7 +903,7 @@ void updateToNChan(int _nchan) {
     nchan = _nchan;
     settings.slnchan = _nchan; //used in SoftwareSettings.pde only
     fftBuff = new FFT[nchan];  //reinitialize the FFT buffer
-    println("Channel count set to " + str(nchan));
+    println("OpenBCI_GUI: Channel count set to " + str(nchan));
 }
 
 void introAnimation() {

OpenBCI_GUI/SessionSettings.pde

@@ -1171,7 +1171,7 @@ void saveConfigFile(File selection) {
         println("SessionSettings: saveConfigFile: User selected " + selection.getAbsolutePath());
         settings.saveDialogName = selection.getAbsolutePath();
         settings.save(settings.saveDialogName); //save current settings to JSON file in SavedData
-        outputSuccess("Settings Saved! The GUI will now load with these settings. Click \"Default\" to revert to factory settings."); //print success message to screen
+        outputSuccess("Settings Saved! Using Expert Mode, you can load these settings using 'N' key. Click \"Default\" to revert to factory settings."); //print success message to screen
         settings.saveDialogName = null; //reset this variable for future use
     }
 }

OpenBCI_GUI/W_Focus.pde

@@ -44,7 +44,7 @@ class W_Focus extends Widget {
     private final int CLASSIFIER_DROPDOWN_W = 80;
 
     private FocusBar focusBar;
-    private float focusBarHardYAxisLimit = 1f;
+    private float focusBarHardYAxisLimit = 1.05f; //Provide slight "breathing room" to avoid GPlot error when metric value == 1.0
     FocusXLim xLimit = FocusXLim.TEN;
     FocusMetric focusMetric = FocusMetric.RELAXATION;
     FocusClassifier focusClassifier = FocusClassifier.REGRESSION;

OpenBCI_GUI/W_Networking.pde

@@ -148,7 +148,7 @@ class W_Networking extends Widget {
         if (eegDataSource != DATASOURCE_CYTON) {
             dataTypes.remove("Pulse");
         }
-        defaultBaud = "115200";
+        defaultBaud = "57600";
         baudRates = Arrays.asList(settings.nwBaudRatesArray);
         protocolMode = "Serial"; //default to Serial
         addDropdown("Protocol", "Protocol", Arrays.asList(settings.nwProtocolArray), protocolIndex);

OpenBCI_GUI/WidgetManager.pde

@@ -36,12 +36,6 @@ void setupWidgets(PApplet _this, ArrayList<Widget> w){
     addWidget(w_timeSeries, w);
     // println("  setupWidgets time series -- " + millis());
 
-    //Cyton Widget_12, Synthetic Widget_9, Ganglion/Playback Widget_10
-    w_focus = new W_Focus(_this);
-    w_focus.setTitle("Focus Widget");
-    addWidget(w_focus, w);
-    // println("  setupWidgets focus widget -- " + millis());
-
     //Widget_1
     w_fft = new W_fft(_this);
     w_fft.setTitle("FFT Plot");
@@ -70,6 +64,12 @@ void setupWidgets(PApplet _this, ArrayList<Widget> w){
         addWidget(w_ganglionImpedance, w);
     }
 
+    //Cyton Widget_12, Synthetic Widget_9, Ganglion/Playback Widget_10
+    w_focus = new W_Focus(_this);
+    w_focus.setTitle("Focus Widget");
+    addWidget(w_focus, w);
+    // println("  setupWidgets focus widget -- " + millis());
+
     //Cyton/Synthetic Widget_3, Ganglion/Playback Widget_4
     w_networking = new W_Networking(_this);
     w_networking.setTitle("Networking");