Merge pull request #1002 from OpenBCI/development

retiutut · web-flow · commit 8db90eb1b79a · 2021-09-28T21:12:39.000-05:00
Development 5.0.7
diff --git a/.travis.yml b/.travis.yml
@@ -13,6 +13,7 @@ jobs:
 branches:
   only:
   - master
+  - development
 
 before_install:
 - if [ "$TRAVIS_OS_NAME" = osx ] && [ "$TRAVIS_PULL_REQUEST" == "false" ]; then openssl aes-256-cbc -K $encrypted_2f5d2771e3cb_key -iv $encrypted_2f5d2771e3cb_iv -in release_script/mac_only/Certificates.p12.enc -out release_script/mac_only/Certificates.p12 -d; fi
@@ -68,4 +69,4 @@ after_success:
 notifications:
   email:
     on_success: never
-    on_failure: always
+    on_failure: always
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,15 @@
+# v5.0.7
+
+### Improvements
+* Show info in footer when a new version of the GUI is available #992
+* Further improvements to GUI Update Button logic
+* Add GUI-wide settings class to keep certain settings across sessions and app starts #997
+* Remove 30 second window option from Focus widget
+
+### Bug Fixes
+* Fix GUI not running on some Macs due to high-dpi screen code #987 #990 #1001
+* Fix streaming multiple data types over LSL #971
+
 # v5.0.6
 
 ### Improvements
diff --git a/Networking-Test-Kit/LSL/lslStreamTest.py b/Networking-Test-Kit/LSL/lslStreamTest.py
@@ -9,7 +9,7 @@
 
 # create a new inlet to read from the stream
 inlet = StreamInlet(streams[0])
-duration = 2
+duration = 5
 
 sleep(1)
 
@@ -18,17 +18,18 @@ def testLSLSamplingRate():
     totalNumSamples = 0
     validSamples = 0
     numChunks = 0
+    print( "Testing Sampling Rates..." )
 
     while time.time() <= start + duration:
         # get chunks of samples
-        samples, timestamp = inlet.pull_chunk()
-        if samples:
+        chunk, timestamp = inlet.pull_chunk()
+        if chunk:
             numChunks += 1
-            print( len(samples) )
-            totalNumSamples += len(samples)
-            # print(samples);
-            for sample in samples:
-                print(sample)
+            # print( len(chunk) )
+            totalNumSamples += len(chunk)
+            # print(chunk);
+            for sample in chunk:
+                # print(sample)
                 validSamples += 1
 
     print( "Number of Chunks and Samples == {} , {}".format(numChunks, totalNumSamples) )
diff --git a/Networking-Test-Kit/LSL/lslStreamTest_3Streams.py b/Networking-Test-Kit/LSL/lslStreamTest_3Streams.py
@@ -10,43 +10,51 @@
 import time
 
 numStreams = 3
+duration_seconds = 20
 # first resolve an EEG stream on the lab network
 print("looking for an EEG stream...")
-stream1 = resolve_stream('type', 'EEG')
-stream2 = resolve_stream('type', 'AUX')
-stream3 = resolve_stream('type', 'FFT')
+stream_1 = resolve_stream('type', 'EEG')
+stream_2 = resolve_stream('type', 'AUX')
+stream_3 = resolve_stream('type', 'FOCUS')
 
 # create a new inlet to read from the stream
-inlet = StreamInlet(stream1[0])
-inlet2 = StreamInlet(stream2[0])
-inlet3 = StreamInlet(stream3[0])
+inlet = StreamInlet(stream_1[0])
+intlet_2 = StreamInlet(stream_2[0])
+intlet_3 = StreamInlet(stream_3[0])
 
 def testLSLSamplingRates():
-    print( "Testing Sampling Rates..." )
+    print( "Testing Sampling Rates for {} seconds".format(duration_seconds) )
     start = time.time()
-    numSamples1 = 0
-    numSamples2 = 0
-    numSamples3 = 0
-    while time.time() < start + 5:
+    num_samples_1 = 0
+    num_samples_2 = 0
+    num_samples_3 = 0
+    while time.time() < start + duration_seconds:
     # get a new sample (you can also omit the timestamp part if you're not
     # interested in it)
         for i in range(numStreams):
             if i == 0:
                 chunk, timestamps = inlet.pull_chunk()
                 if timestamps:
-                    numSamples1 += 1
+                    for sample in chunk:
+                        if sample:
+                            num_samples_1 += 1
+                            #print(sample)
             elif i == 1:
-                chunk, timestamps2 = inlet2.pull_chunk()
-                if timestamps2:
-                    numSamples2 += 1
+                chunk, timestamps_2 = intlet_2.pull_chunk()
+                if timestamps_2:
+                    for sample in chunk:
+                        num_samples_2 += 1
+                        #print(sample)
             elif i == 2:
-                chunk, timestamps3 = inlet3.pull_chunk()
-                if timestamps3:
-                    numSamples3 += 1
+                chunk, timestamps_3 = intlet_3.pull_chunk()
+                if timestamps_3:
+                    for sample in chunk:
+                        num_samples_3 += 1
+                        #print(sample)
             #print("Stream", i + 1, " == ", chunk)
-    print( "Stream 1 Sampling Rate == ", numSamples1, " | Type : EEG")
-    print( "Stream 2 Sampling Rate == ", numSamples2, " | Type : AUX")
-    print( "Stream 3 Sampling Rate == ", numSamples3, " | Type : FFT")
+    print( "Stream 1 Sampling Rate == ", num_samples_1 / duration_seconds, " | Type : EEG")
+    print( "Stream 2 Sampling Rate == ", num_samples_2 / duration_seconds, " | Type : AUX")
+    print( "Stream 3 Sampling Rate == ", num_samples_3 / duration_seconds, " | Type : FOCUS")
 
 
 testLSLSamplingRates()
diff --git a/Networking-Test-Kit/LSL/lslStreamTest_FFTplot.py b/Networking-Test-Kit/LSL/lslStreamTest_FFTplot.py
@@ -11,16 +11,17 @@
 
 last_print = time.time()
 fps_counter = deque(maxlen=150)
+duration = 5
 
 # first resolve an EEG stream on the lab network
 print("looking for an EEG stream...")
-streams = resolve_stream('type', 'EEG')
+streams = resolve_stream('type', 'FFT')
 # create a new inlet to read from the stream
 inlet = StreamInlet(streams[0])
 
 channel_data = {}
 
-for i in range(5):  # how many iterations. Eventually this would be a while True
+for i in range(duration):  # how many iterations. Eventually this would be a while True
 
     for i in range(16): # each of the 16 channels here
         sample, timestamp = inlet.pull_sample()
diff --git a/OpenBCI_GUI/ADS1299SettingsController.pde b/OpenBCI_GUI/ADS1299SettingsController.pde
@@ -138,7 +138,7 @@ class ADS1299SettingsController {
                 }
             }
 
-            boolean showCustomCommandUI = settings.expertModeToggle;
+            boolean showCustomCommandUI = guiSettings.getExpertModeBoolean();
             
             //Draw background behind command buttons
             pushStyle();
diff --git a/OpenBCI_GUI/ControlPanel.pde b/OpenBCI_GUI/ControlPanel.pde
@@ -2778,7 +2778,6 @@ class InitBox {
             }
         } else {
             //if system is already active ... stop session and flip button state back
-            outputInfo("Learn how to use this application and more at openbci.github.io/Documentation/");
             setInitSessionButtonText("START SESSION");
             topNav.setLockTopLeftSubNavCp5Objects(false); //Unlock top left subnav buttons
             //creates new data file name so that you don't accidentally overwrite the old one
diff --git a/OpenBCI_GUI/CustomCp5Classes.pde b/OpenBCI_GUI/CustomCp5Classes.pde
@@ -90,7 +90,8 @@ class ButtonHelpText{
     }
 
     public void draw(){
-        if (!isVisible || settings.expertModeToggle) {
+        //When using expert mode, disable help text over UI objects
+        if (!isVisible || guiSettings.getExpertModeBoolean()) {
             return;
         }
 
diff --git a/OpenBCI_GUI/Debugging.pde b/OpenBCI_GUI/Debugging.pde
@@ -54,7 +54,7 @@ class HelpWidget {
     int padding;
 
     //current text shown in help widget, based on most recent command
-    String currentOutput = "Learn how to use this application and more at openbci.github.io/Documentation/";
+    String currentOutput = "Learn how to use this application and more at docs.openbci.com";
     OutputLevel curOutputLevel = OutputLevel.INFO;
 
     HelpWidget(float _xPos, float _yPos, float _width, float _height) {
diff --git a/OpenBCI_GUI/FocusEnums.pde b/OpenBCI_GUI/FocusEnums.pde
@@ -14,8 +14,7 @@ public enum FocusXLim implements FocusEnum
 {
     FIVE (0, 5, "5 sec"),
     TEN (1, 10, "10 sec"),
-    TWENTY (2, 20, "20 sec"),
-    THIRTY (3, 30, "30 sec");
+    TWENTY (2, 20, "20 sec");
 
     private int index;
     private int value;
diff --git a/OpenBCI_GUI/GuiSettings.pde b/OpenBCI_GUI/GuiSettings.pde
@@ -0,0 +1,116 @@
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import java.io.*;
+
+
+interface GuiSettingsEnum {
+    public String getName();
+}
+
+enum ExpertModeEnum implements GuiSettingsEnum {
+    ON("Active", true),
+    OFF("Inactive", false);
+
+    private String name;
+    private boolean val;
+
+    ExpertModeEnum(String _name, boolean _val) {
+        this.name = _name;
+        this.val = _val;
+    }
+
+    @Override
+    public String getName() {
+        return name;
+    }
+
+    public boolean getBooleanValue() {
+        return val;
+    }
+}
+
+public class GuiSettingsValues {
+    private ExpertModeEnum expertMode = ExpertModeEnum.OFF;
+
+    public GuiSettingsValues() {
+    }
+}
+
+class GuiSettings {
+
+    public GuiSettingsValues values;
+    private String filename;
+
+    GuiSettings(String settingsDirectory) {
+
+        values = new GuiSettingsValues();
+        
+        StringBuilder settingsFilename = new StringBuilder(settingsDirectory);
+        settingsFilename.append("GuiWideSettings.json");
+        filename = settingsFilename.toString();
+        File fileToCheck = new File(filename);
+        boolean fileExists = fileToCheck.exists();
+        if (fileExists) {
+            loadSettingsValues();
+            println("OpenBCI_GUI::Settings: Found and loaded existing GUI-wide Settings from file.");
+        } else {
+            println("OpenBCI_GUI::Settings: Creating new GUI-wide Settings file.");
+            saveToFile();
+        }
+    }
+
+    public boolean loadSettingsValues() {
+        try {
+            File file = new File(filename);
+            StringBuilder fileContents = new StringBuilder((int)file.length());        
+            Scanner scanner = new Scanner(file);
+            while(scanner.hasNextLine()) {
+                fileContents.append(scanner.nextLine() + System.lineSeparator());
+            }
+            Gson gson = new Gson();
+            values = gson.fromJson(fileContents.toString(), GuiSettingsValues.class);
+            return true;
+        } catch (IOException e) {
+            e.printStackTrace();
+            outputWarn("OpenBCI_GUI::Settings: Error loading GUI-wide settings from file. Attempting to create a new one.");
+            //If there is an error, attempt to overwrite the file or create a new one
+            saveToFile();
+            return false;
+        }
+    }
+
+    public String getJson() {
+        Gson gson = new GsonBuilder().setPrettyPrinting().create();
+        return gson.toJson(values);
+    }
+
+    public boolean saveToFile() {
+        String json = getJson();
+        try {
+            FileWriter writer = new FileWriter(filename);
+            writer.write(json);
+            writer.close();
+            println("OpenBCI_GUI::Settings: Successfully saved GUI-wide settings to file!");
+            return true;
+        } catch (IOException e) {
+            e.printStackTrace();
+            outputWarn("OpenBCI_GUI::Settings: Error saving GUI-wide settings to file. Please make an issue on GitHub.");
+            return false;
+        }
+    }
+
+    //Call this method at the end of GUI main Setup in OpenBCI_GUI.pde to make sure everything exists
+    //Has to be in this class to make sure other classes exist
+    public void applySettings() {
+        topNav.configSelector.toggleExpertModeFrontEnd(getExpertModeBoolean());
+    }
+
+    public void setExpertMode(ExpertModeEnum val) {
+        values.expertMode = val;
+        saveToFile();
+    }
+    
+    public boolean getExpertModeBoolean() {
+        return values.expertMode.getBooleanValue();
+    }
+}
diff --git a/OpenBCI_GUI/Info.plist.tmpl b/OpenBCI_GUI/Info.plist.tmpl
@@ -23,7 +23,7 @@
         <key>CFBundleShortVersionString</key>
         <string>5</string>
         <key>CFBundleVersion</key>
-        <string>5.0.6</string>
+        <string>5.0.7</string>
         <key>CFBundleSignature</key>
         <string>????</string>
         <key>NSHumanReadableCopyright</key>
@@ -32,7 +32,7 @@
 	Copyright © 2021 OpenBCI
 	</string>
         <key>CFBundleGetInfoString</key>
-        <string>July 2021</string>
+        <string>September 2021</string>
         <!-- End of the set that can be customized -->
 
         @@jvm_runtime@@
diff --git a/OpenBCI_GUI/Interactivity.pde b/OpenBCI_GUI/Interactivity.pde
@@ -31,7 +31,7 @@ synchronized void keyPressed() {
     boolean anyActiveTextfields = isNetworkingTextActive() || textFieldIsActive;
 
     if(!controlPanel.isOpen && !anyActiveTextfields){ //don't parse the key if the control panel is open
-        if (settings.expertModeToggle || key == ' ') { //Check if Expert Mode is On or Spacebar has been pressed
+        if (guiSettings.getExpertModeBoolean() || key == ' ') { //Check if Expert Mode is On or Spacebar has been pressed
             if ((int(key) >=32) && (int(key) <= 126)) {  //32 through 126 represent all the usual printable ASCII characters
                 parseKey(key);
             }
diff --git a/OpenBCI_GUI/OpenBCI_GUI.pde b/OpenBCI_GUI/OpenBCI_GUI.pde
diff --git a/OpenBCI_GUI/SessionSettings.pde b/OpenBCI_GUI/SessionSettings.pde
diff --git a/OpenBCI_GUI/TopNav.pde b/OpenBCI_GUI/TopNav.pde
diff --git a/OpenBCI_GUI/W_Networking.pde b/OpenBCI_GUI/W_Networking.pde
diff --git a/OpenBCI_GUI/W_Template.pde b/OpenBCI_GUI/W_Template.pde
diff --git a/appveyor.yml b/appveyor.yml

Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,7 @@ class ADS1299SettingsController {`
`138`	`138`	`}`
`139`	`139`	`}`
`140`	`140`
`141`		`- boolean showCustomCommandUI = settings.expertModeToggle;`
	`141`	`+ boolean showCustomCommandUI = guiSettings.getExpertModeBoolean();`
`142`	`142`
`143`	`143`	`//Draw background behind command buttons`
`144`	`144`	`pushStyle();`
Original file line number	Diff line number	Diff line change
`@@ -2778,7 +2778,6 @@ class InitBox {`
`2778`	`2778`	`}`
`2779`	`2779`	`} else {`
`2780`	`2780`	`//if system is already active ... stop session and flip button state back`
`2781`		`- outputInfo("Learn how to use this application and more at openbci.github.io/Documentation/");`
`2782`	`2781`	`setInitSessionButtonText("START SESSION");`
`2783`	`2782`	`topNav.setLockTopLeftSubNavCp5Objects(false); //Unlock top left subnav buttons`
`2784`	`2783`	`//creates new data file name so that you don't accidentally overwrite the old one`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,8 @@ class ButtonHelpText{`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`public void draw(){`
`93`		`- if (!isVisible \|\| settings.expertModeToggle) {`
	`93`	`+ //When using expert mode, disable help text over UI objects`
	`94`	`+ if (!isVisible \|\| guiSettings.getExpertModeBoolean()) {`
`94`	`95`	`return;`
`95`	`96`	`}`
`96`	`97`
Original file line number	Diff line number	Diff line change
`@@ -14,8 +14,7 @@ public enum FocusXLim implements FocusEnum`
`14`	`14`	`{`
`15`	`15`	`FIVE (0, 5, "5 sec"),`
`16`	`16`	`TEN (1, 10, "10 sec"),`
`17`		`- TWENTY (2, 20, "20 sec"),`
`18`		`- THIRTY (3, 30, "30 sec");`
	`17`	`+ TWENTY (2, 20, "20 sec");`
`19`	`18`
`20`	`19`	`private int index;`
`21`	`20`	`private int value;`