Merge pull request #35 from sync2brain/fix_sgDeps

pablorcum · web-flow · commit 67420b76f677 · 2023-08-26T20:04:11.000+02:00
Fix sg deps
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -30,7 +30,7 @@ jobs:
 
       - name: Run MATLAB command
         run: |
-          &"$env:ProgramFiles\MATLAB\$env:MATLAB_VER\bin\matlab.exe" -batch "openProject(pwd); cd('buildUtilities'); buildtool test('') package('${{  github.ref_name }}','${{  github.actor }}')"
+          &"$env:ProgramFiles\MATLAB\$env:MATLAB_VER\bin\matlab.exe" -batch "openProject(pwd); cd('buildUtilities'); buildtool test('bdConnected') package('${{  github.ref_name }}','${{  github.actor }}')"
       
       # Create new release
       - name: Release
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,8 @@
 work
+.buildtool
 toolbox/html
+toolbox/dependencies/sg
+toolbox/dependencies/firmware
 
 # Autosave files
 *.asv
diff --git a/buildUtilities/buildfile.m b/buildUtilities/buildfile.m
@@ -19,12 +19,18 @@
     Actions = @(~) updateSGdeps,...
     Outputs = fullfile(projObj.RootFolder,"toolbox/dependencies/sg/**"));
 
+plan("updateFirmwareDeps") = Task( ...
+    Description = "Update Firmware dependencies", ...
+    Actions = @(~) updateFirmwareDeps,...
+    Outputs = fullfile(projObj.RootFolder,"toolbox/dependencies/firmware/**"));
+
 % Create the "test" task and add it to the plan
 plan("test") = Task( ...
     Description = "Run unit tests", ...
     Actions = @(~,tags) testTask(tags),...
     Inputs = [fullfile(projObj.RootFolder,'**/*.m'),...
-    plan("updateSGdeps").Outputs]);
+    plan("updateSGdeps").Outputs,...
+    plan("updateFirmwareDeps").Outputs]);
 
 plan("buildDoc") = Task( ...
     Description = "Build HTML doc from sources", ...
@@ -37,7 +43,7 @@
     Description = "Package toolbox", ...
     Dependencies = ["check" "test"], ...
     Actions = @(~,toolboxVer,authorName) releaseTask(toolboxVer,authorName),...
-    Inputs = [plan("buildDoc").Outputs, plan("updateSGdeps").Outputs]);
+    Inputs = [plan("buildDoc").Outputs, plan("updateSGdeps").Outputs plan("updateFirmwareDeps").Outputs]);
 
 % Set default tasks in the plan
 plan.DefaultTasks = ["check" "test"];
diff --git a/buildUtilities/releaseTask.m b/buildUtilities/releaseTask.m
@@ -1,22 +1,14 @@
-function toolboxOptions = releaseTask(toolboxVersion, authorName, shareFolder)
+function toolboxOptions = releaseTask(toolboxVersion, authorName)
 %GENERATETOOLBOX Function that generates a toolbox for the boss device API
 
 arguments
     toolboxVersion string {mustBeTextScalar} = '0.0'
     authorName string {mustBeTextScalar} = "sync2brain" % Use committer name when packaging from CI
-    shareFolder {mustBeFolder} = getenv('firmwareSharePath')
 end
 
 % Get current project object
 projObj = currentProject;
 
-% Copy firmware in local share folder to toolbox to facilitate distribution
-if ~isempty(shareFolder)
-    copyfile(shareFolder,fullfile(projObj.RootFolder,'toolbox/dependencies/firmware/'));
-else
-    warning('Share folder not found. Firmware dependencies will not be packaged in toolbox.');
-end
-
 % Remove v from toolboxVersion
 options.toolboxVersion = erase(toolboxVersion,"v");
 
diff --git a/buildUtilities/updateFirmwareDeps.m b/buildUtilities/updateFirmwareDeps.m
@@ -0,0 +1,16 @@
+function updateFirmwareDeps(shareFolder)
+
+arguments
+    shareFolder {mustBeFolder} = getenv('firmwareSharePath')
+end
+
+projObj = currentProject;
+
+% Copy firmware in local share folder to toolbox to facilitate distribution
+if ~isempty(shareFolder)
+    copyfile(shareFolder,fullfile(projObj.RootFolder,'toolbox/dependencies/firmware/'));
+else
+    error('Share folder not found. Firmware dependencies will not be packaged in toolbox.');
+end
+
+end
diff --git a/buildUtilities/updateSGdeps.m b/buildUtilities/updateSGdeps.m
@@ -2,12 +2,14 @@
 
 projObj = currentProject;
 
-assert(exist('speedgoatroot','file'),'Speedgoat dependencies not found installed in local system.');
+[isSGinstalled, sgDefaultPath] = bossapi.isSpeedgoatBlocksetInstalled;
 
-fprintf('Updating Speedgoat dependencies in local project from %s...\n',speedgoatroot);
+assert(isSGinstalled,'Speedgoat dependencies not found installed in local system.');
+
+fprintf('Updating Speedgoat dependencies in local project from %s...\n',sgDefaultPath);
 
 % Figure out list of Speedgoat tools to copy
-sgTools = dir(fullfile(speedgoatroot,'sg_resources'));
+sgTools = dir(fullfile(sgDefaultPath,'sg_resources'));
 sgTools = sgTools(~[sgTools.isdir]);
 
 % Create dependencies folder in local toolbox
@@ -22,8 +24,9 @@
 end
 
 % Copy common Speedgoat functions
-copyfile(fullfile(speedgoatroot,'sg_functions','+sg'),fullfile(destFolder,'+sg'));
-copyfile(fullfile(speedgoatroot,'sg_functions','+speedgoat'),fullfile(destFolder,'+speedgoat'));
+copyfile(fullfile(sgDefaultPath,'speedgoatroot.p'),destFolder);
+copyfile(fullfile(sgDefaultPath,'sg_functions','+sg'),fullfile(destFolder,'+sg'));
+copyfile(fullfile(sgDefaultPath,'sg_functions','+speedgoat'),fullfile(destFolder,'+speedgoat'));
 
 fprintf('Speedgoat dependencies updated in toolbox.\n');
 
diff --git a/resources/project/-yj-zgdEElpZjlogbAXxP8XBgk4/D_dPBt9q0E2OY6IbuGPfcwyWnjId.xml b/resources/project/-yj-zgdEElpZjlogbAXxP8XBgk4/D_dPBt9q0E2OY6IbuGPfcwyWnjId.xml
diff --git a/resources/project/-yj-zgdEElpZjlogbAXxP8XBgk4/D_dPBt9q0E2OY6IbuGPfcwyWnjIp.xml b/resources/project/-yj-zgdEElpZjlogbAXxP8XBgk4/D_dPBt9q0E2OY6IbuGPfcwyWnjIp.xml
diff --git a/resources/project/EEtUlUb-dLAdf0KpMVivaUlztwA/Y0NOeZw9EXOLu_IsKVdbsMMOJsId.xml b/resources/project/EEtUlUb-dLAdf0KpMVivaUlztwA/Y0NOeZw9EXOLu_IsKVdbsMMOJsId.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info Ref="toolbox/html" Type="Relative"/>
diff --git a/resources/project/EEtUlUb-dLAdf0KpMVivaUlztwA/Y0NOeZw9EXOLu_IsKVdbsMMOJsIp.xml b/resources/project/EEtUlUb-dLAdf0KpMVivaUlztwA/Y0NOeZw9EXOLu_IsKVdbsMMOJsIp.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location="824f7d17-4701-47e2-be96-1e9afe06c88f" type="Reference"/>
diff --git a/resources/project/_BcHeyeYYWxz6MENB98iTz25sSI/nWYhdJ9SIXhKqBMoaMa7pxo7Y9Ud.xml b/resources/project/_BcHeyeYYWxz6MENB98iTz25sSI/nWYhdJ9SIXhKqBMoaMa7pxo7Y9Ud.xml
@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info>
+    <Category UUID="FileClassCategory">
+        <Label UUID="design"/>
+    </Category>
+</Info>
diff --git a/resources/project/_BcHeyeYYWxz6MENB98iTz25sSI/nWYhdJ9SIXhKqBMoaMa7pxo7Y9Up.xml b/resources/project/_BcHeyeYYWxz6MENB98iTz25sSI/nWYhdJ9SIXhKqBMoaMa7pxo7Y9Up.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location="updateFirmwareDeps.m" type="File"/>
diff --git a/tests/exampleTests.m b/tests/exampleTests.m
@@ -11,16 +11,17 @@
 
     properties
         bd bossdevice
+        sgPath
+        isSGinstalled
     end
 
     methods (TestClassSetup)
         function setupBossdevice(testCase)
-            if exist('sg_path','file')
+            [testCase.isSGinstalled, testCase.sgPath] = bossapi.isSpeedgoatBlocksetInstalled;
+            if testCase.isSGinstalled
                 % If local installation of Speedgoat blockset is present, update toolbox dependencies and work with them
-                disp('Remove Speedgoat local installation.');
-                sg_path(0);
+                bossapi.removeSpeedgoatBlocksetFromPath(testCase.sgPath);
             end
-
             import matlab.unittest.fixtures.PathFixture
             if isfolder(testCase.firmwarePath)
                 testCase.applyFixture(PathFixture(testCase.firmwarePath));
@@ -31,10 +32,10 @@ function setupBossdevice(testCase)
     end
 
     methods (TestClassTeardown)
-        function resetSgPath(~)
-            if exist('sg_path','file')
-                disp('Restore Speedgoat local installation.');
-                sg_path(1);
+        function resetSgPath(testCase)
+            if testCase.isSGinstalled
+                % If local installation of Speedgoat blockset is present, restore default paths
+                bossapi.addSpeedgoatBlocksetToPath(testCase.sgPath);
             end
         end
 
diff --git a/tests/smokeTests.m b/tests/smokeTests.m
@@ -6,26 +6,35 @@
 
     properties
         bd bossdevice
+        sgPath
+        isSGinstalled
     end
 
     methods (TestClassSetup)
         function setupBossdevice(testCase)
-            if exist('sg_path','file')
+            [testCase.isSGinstalled, testCase.sgPath] = bossapi.isSpeedgoatBlocksetInstalled;
+            if testCase.isSGinstalled
                 % If local installation of Speedgoat blockset is present, update toolbox dependencies and work with them
-                disp('Remove Speedgoat local installation.');
-                sg_path(0);
+                bossapi.removeSpeedgoatBlocksetFromPath(testCase.sgPath);
             end
 
             testCase.bd = bossdevice;
             testCase.bd.targetObject.update;
         end
+
+        function addFirmwarePath(testCase)
+            import matlab.unittest.fixtures.PathFixture
+            if isfolder(testCase.firmwarePath)
+                testCase.applyFixture(PathFixture(testCase.firmwarePath));
+            end
+        end
     end
 
     methods (TestClassTeardown)
-        function resetSgPath(~)
-            if exist('sg_path','file')
-                disp('Restore Speedgoat local installation.');
-                sg_path(1);
+        function resetSgPath(testCase)
+            if testCase.isSGinstalled
+                % If local installation of Speedgoat blockset is present, restore default paths
+                bossapi.addSpeedgoatBlocksetToPath(testCase.sgPath);
             end
         end
 
@@ -47,17 +56,7 @@ function clearBossdeviceObj(testCase)
 
     methods (Test, TestTags = {'noHW'})
         % Test methods that do not require bossdevice or any target connected
-        function noFirmware(testCase)
-            if batchStartupOptionUsed
-                testCase.verifyWarning(@() bossdevice, 'bossapi:noMLDATX');
-            end
-        end
-
         function noBossdevice(testCase)
-            import matlab.unittest.fixtures.PathFixture
-            if isfolder(testCase.firmwarePath)
-                testCase.applyFixture(PathFixture(testCase.firmwarePath));
-            end
             testCase.bd = bossdevice;
             testCase.verifyFalse(testCase.bd.isConnected);
         end
@@ -66,10 +65,6 @@ function noBossdevice(testCase)
     methods (Test, TestTags = {'bdConnected'})
         % Test methods with bossdevice connected and reachable from the host PC
         function bdInitialization(testCase)
-            import matlab.unittest.fixtures.PathFixture
-            if isfolder(testCase.firmwarePath)
-                testCase.applyFixture(PathFixture(testCase.firmwarePath));
-            end
             testCase.bd = bossdevice;
             testCase.bd.initialize;
             testCase.verifyTrue(testCase.bd.isConnected);
@@ -80,10 +75,6 @@ function bdInitialization(testCase)
         end
 
         function bdShortRun(testCase)
-            import matlab.unittest.fixtures.PathFixture
-            if isfolder(testCase.firmwarePath)
-                testCase.applyFixture(PathFixture(testCase.firmwarePath));
-            end
             testCase.bd = bossdevice;
             testCase.bd.start;
             testCase.verifyTrue(testCase.bd.isRunning);
diff --git a/toolbox/bossdevice.m b/toolbox/bossdevice.m
@@ -47,6 +47,10 @@ function clearPersonalSettings()
             s.bossdeviceAPI.TargetSettings.TargetName.clearPersonalValue;
             s.bossdeviceAPI.TargetSettings.TargetIPAddress.clearPersonalValue;
         end
+
+        function doc()
+            web('bossdevice_api_landing_page.html');
+        end
     end
 
     methods
@@ -86,14 +90,15 @@ function clearPersonalSettings()
 
             % Check and enable built-in Speedgoat dependencies
             obj.sgDepsPath = fullfile(toolboxPath,'dependencies','sg',matlabRelease.Release);
-            if exist('speedgoatroot','file')
+            isSGinstalled = bossapi.isSpeedgoatBlocksetInstalled;
+            if isSGinstalled
                 % Using own full installation of Speedgoat I/O Blockset (for development or debugging purposes)
                 fprintf('[Debug] Using own full installation of Speedgoat I/O Blockset v%s.\n',speedgoat.version);
             elseif isfolder(obj.sgDepsPath)
                 % Try using built-in Speedgoat dependency
                 addpath(obj.sgDepsPath);
                 assert(exist('updateSGtools.p','file'),...
-                    sprintf('Speedgoat files not found in "%s". Please reach out to <a href="matlab:open(''bossdevice_api_support.html'')">sync2brain technical support</a>.',sgDepsPath));
+                    sprintf('Speedgoat files not found in "%s". Please reach out to <a href="matlab:open(''bossdevice_api_support.html'')">sync2brain technical support</a>.',obj.sgDepsPath));
             else
                 error('Speedgoat dependencies not found. Please reach out to <a href="matlab:open(''bossdevice_api_support.html'')">sync2brain technical support</a>.');
             end
@@ -115,23 +120,23 @@ function clearPersonalSettings()
             end
 
             % Search firmware binary and prompt user if not found in MATLAB path
-            firmwareSharePath = fullfile(toolboxPath,'dependencies','firmware',matlabRelease.Release,[obj.appName,'.mldatx']);
+            firmwareDepsPath = fullfile(toolboxPath,'dependencies','firmware',matlabRelease.Release,[obj.appName,'.mldatx']);
 
             if exist([obj.appName,'.mldatx'],"file")
                 obj.firmwareFilepath = obj.appName;
-            elseif isfile(firmwareSharePath)
-                obj.firmwareFilepath = firmwareSharePath;
+            elseif isfile(firmwareDepsPath)
+                obj.firmwareFilepath = firmwareDepsPath;
             elseif ~batchStartupOptionUsed
                 [filename, firmwareFilepath] = uigetfile([obj.appName,'.mldatx'],...
                     'Select the firmware binary to load on the bossdevice');
                 if isequal(filename,0)
-                    disp('User selected Cancel.');
+                    disp('User selected Cancel. Please select firmware mldatx file to complete bossdevice dependencies.');
                     return;
                 else
                     obj.firmwareFilepath = fullfile(firmwareFilepath,filename);
                 end
             else
-                warning('bossapi:noMLDATX',[obj.appName,'.mldatx could not be found in the MATLAB path.']);
+                error('bossapi:noMLDATX',[obj.appName,'.mldatx could not be found in the MATLAB path.']);
             end
         end
 
@@ -374,6 +379,10 @@ function manualTrigger(obj)
             setparam(obj.targetObject, [obj.appName,'/GEN'], 'manualtrigger', 0);
         end
 
+        function openDocumentation(obj)
+            obj.doc;
+        end
+
         %% Target object wrappers
         function addInstrument(obj, inst)
             arguments
diff --git a/toolbox/dependencies/+bossapi b/toolbox/dependencies/+bossapi
@@ -1 +1 @@
-Subproject commit b9911a5fcec3d6670f69a112465c8e5c0c7e27ff
+Subproject commit 8edec5d5a6574d66ebcdfa333d461b01bcbb9373
diff --git a/toolbox/dependencies/sg/speedgoatroot.p b/toolbox/dependencies/sg/speedgoatroot.p

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<?xml version='1.0' encoding='UTF-8'?>`
	`2`	`+<Info Ref="toolbox/html" Type="Relative"/>`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<?xml version='1.0' encoding='UTF-8'?>`
	`2`	`+<Info location="824f7d17-4701-47e2-be96-1e9afe06c88f" type="Reference"/>`