Merge pull request #44 from open-ephys-plugins/fix-loading-sample-rate

* Fix loading sample rate & bitfile
* Package .bit files in shared folder
* Show alert when Opal Kelly FPGA bitfile upload fails

Author: anjaldoshi

.github/workflows/linux.yml

@@ -83,7 +83,7 @@ jobs:
         echo "PLUGIN_VERSION=$(grep -w Source/OpenEphysLib.cpp -e 'info->libVersion' | grep -Eo "[0-9]+.[0-9]+.[0-9]+")" >> "$GITHUB_OUTPUT"
         sudo apt update
         cd ../..
-        git clone https://github.com/open-ephys/plugin-GUI.git --branch testing-juce8
+        git clone https://github.com/open-ephys/plugin-GUI.git --branch main
         sudo ./plugin-GUI/Resources/Scripts/install_linux_dependencies.sh
         cd plugin-GUI/Build && cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release ..
         echo "PLUGIN_API=$(grep -rnw ../Source -e '#define PLUGIN_API_VER' | grep -Eo "[0-9]*" | tail -1)" >> "$GITHUB_OUTPUT"
@@ -132,6 +132,7 @@ jobs:
         cp -r $build_dir/*.so plugins
         mkdir shared
         cp Resources/libokFrontPanel.so shared
+        cp Resources/*.bit shared
         cp -r libONI/linux/*.so shared
         zipfile=${package}_${new_plugin_ver}.zip
         zip -r -X $zipfile plugins shared

.github/workflows/mac.yml

@@ -82,7 +82,7 @@ jobs:
       run: |
         echo "PLUGIN_VERSION=$(grep -w Source/OpenEphysLib.cpp -e 'info->libVersion' | grep -Eo "[0-9]+.[0-9]+.[0-9]+")" >> "$GITHUB_OUTPUT"
         cd ../..
-        git clone https://github.com/open-ephys/plugin-GUI.git --branch testing-juce8
+        git clone https://github.com/open-ephys/plugin-GUI.git --branch main
         cd plugin-GUI/Build && cmake -G "Xcode" ..
         echo "PLUGIN_API=$(grep -rnw ../Source -e '#define PLUGIN_API_VER' | grep -Eo "[0-9]*" | tail -1)" >> "$GITHUB_OUTPUT"
 
@@ -139,6 +139,7 @@ jobs:
 
         mkdir shared 
         cp -r Resources/libokFrontPanel.1.dylib shared
+        cp Resources/*.bit shared
         cp -r libONI/osx/*.dylib shared
 
         # Turn our base64-encoded certificate back to a regular .p12 file

.github/workflows/windows.yml

@@ -82,11 +82,11 @@ jobs:
       run: |
         echo "PLUGIN_VERSION=$(grep -w Source/OpenEphysLib.cpp -e 'info->libVersion' | grep -Eo "[0-9]+.[0-9]+.[0-9]+")" >> "$GITHUB_OUTPUT"
         cd ../..
-        git clone https://github.com/open-ephys/plugin-GUI.git --branch testing-juce8
+        git clone https://github.com/open-ephys/plugin-GUI.git --branch main
         cd plugin-GUI/Build
         cmake -G "Visual Studio 17 2022" -A x64 .. 
         mkdir Release && cd Release
-        curl -L https://openephys.jfrog.io/artifactory/GUI-binaries/Libraries/open-ephys-lib-v1.0.0-alpha.zip --output open-ephys-lib.zip
+        curl -L https://openephys.jfrog.io/artifactory/GUI-binaries/Libraries/open-ephys-lib-v1.0.0.zip --output open-ephys-lib.zip
         unzip open-ephys-lib.zip
         echo "PLUGIN_API=$(grep -rnw ../../Source -e '#define PLUGIN_API_VER' | grep -Eo "[0-9]*" | tail -1)" >> "$GITHUB_OUTPUT"
       shell: bash
@@ -145,6 +145,7 @@ jobs:
         mkdir shared
         cp libONI/win64/*.dll shared
         cp Resources/okFrontPanel.dll shared
+        cp Resources/*.bit shared
         zipfile=${package}_${new_plugin_ver}.zip
         powershell Compress-Archive -Path "plugins" -DestinationPath ${zipfile}
         powershell Compress-Archive -U -Path "shared" -DestinationPath ${zipfile}

Resources/intan_rhd_usb.bit

@@ -66,7 +66,7 @@ DeviceEditor::DeviceEditor (GenericProcessor* parentNode,
 
     if (board->getBoardType() == AcquisitionBoard::BoardType::ONI)
     {
-        if (((AcqBoardONI*)board)->getMemoryMonitorSupport())
+        if (((AcqBoardONI*) board)->getMemoryMonitorSupport())
         {
             desiredWidth += 22;
 
@@ -398,7 +398,7 @@ void DeviceEditor::startAcquisition()
         canvas->beginAnimation();
     }
 
-    if(memoryUsage != nullptr)
+    if (memoryUsage != nullptr)
         memoryUsage->startAcquisition();
 
     acquisitionIsActive = true;
@@ -531,7 +531,13 @@ void DeviceEditor::loadVisualizerEditorParameters (XmlElement* xml)
         return;
     }
 
-    sampleRateInterface->setSelectedId (xml->getIntAttribute ("SampleRate"));
+    int sampleRateId = xml->getIntAttribute ("SampleRate");
+    Array<int> sampleRates = board->getAvailableSampleRates();
+    if (! sampleRates.contains (sampleRateId))
+    {
+        sampleRateId = sampleRates.getLast(); // if the requested sample rate is not available, use the last one in the list
+    }
+    sampleRateInterface->setSelectedId (sampleRateId);
     bandwidthInterface->setLowerBandwidth (xml->getDoubleAttribute ("LowCut"));
     bandwidthInterface->setUpperBandwidth (xml->getDoubleAttribute ("HighCut"));
     auxButton->setToggleState (xml->getBoolAttribute ("AUXsOn"), sendNotification);

Source/DeviceEditor.cpp

@@ -41,7 +41,7 @@ extern "C" EXPORT void getLibInfo(Plugin::LibraryInfo* info)
 {
 	info->apiVersion = PLUGIN_API_VER;
 	info->name = "Acquisition Board";
-	info->libVersion = "1.1.0";
+	info->libVersion = "1.1.1";
 	info->numPlugins = NUM_PLUGINS;
 }
 

Source/OpenEphysLib.cpp

@@ -110,12 +110,12 @@ bool AcqBoardOpalKelly::detectBoard()
     }
     else if (return_code == -1) // Opal Kelly library not found
     {
-        LOGC ("No Opal Kelly DLL found.");
+        LOGE ("No Opal Kelly DLL found.");
         return false;
     }
     else if (return_code == -2)
     {
-        LOGC ("No Opal Kelly Acquisition Board found.");
+        LOGE ("No Opal Kelly Acquisition Board found.");
         return false;
     }
 
@@ -144,11 +144,30 @@ bool AcqBoardOpalKelly::initializeBoard()
     bitfilename += File::getSeparatorString();
     bitfilename += evalBoard->isUSB3() ? "rhd2000_usb3.bit" : "rhd2000.bit";
 
-    if (! evalBoard->uploadFpgaBitfile (bitfilename.toStdString()))
+    if (! File (bitfilename).existsAsFile() || ! evalBoard->uploadFpgaBitfile (bitfilename.toStdString()))
     {
-        LOGC ("Could not upload FPGA bitfile from ", bitfilename);
-        deviceFound = false;
-        return false;
+        // If the bitfile is not found in the executable directory or if the upload fails,
+        // try to load it from the saved state directory.
+
+        bitfilename = CoreServices::getSavedStateDirectory().getFullPathName();
+        bitfilename += File::getSeparatorString();
+        bitfilename += "shared-api" + String (PLUGIN_API_VER);
+        bitfilename += File::getSeparatorString();
+        bitfilename += evalBoard->isUSB3() ? "rhd2000_usb3.bit" : "rhd2000.bit";
+
+        if (! evalBoard->uploadFpgaBitfile (bitfilename.toStdString()))
+        {
+            AlertWindow::showMessageBoxAsync (AlertWindow::WarningIcon,
+                                              "Failed to upload FPGA bitfile",
+                                              "The Opal Kelly FPGA bitfile upload failed. Refer to the console for further details.",
+                                              "OK",
+                                              nullptr,
+                                              ModalCallbackFunction::create ([] (int) {}));
+
+            LOGE ("Could not upload FPGA bitfile");
+            deviceFound = false;
+            return false;
+        }
     }
 
     LOGC ("Successfully uploaded bitfile, initializing board...");