Merge pull request #29 from sync2brain/pack_mldatx

Pack firmware mldatx file in toolbox

.gitignore

@@ -1,5 +1,6 @@
 work
 toolbox/html
+toolbox/dependencies/firmware
 
 # Autosave files
 *.asv

README.md

@@ -14,7 +14,7 @@
 3. If you are working on Windows, please set the Development-to-Target Computer Ethernet Interface as `Private`. Follow the steps documented [here](https://www.mathworks.com/help/slrealtime/ug/troubleshoot-communication-failure-through-firewall.html).
 
 ## Initial toolbox configuration
-1. Download `bossdevice-api-installer.mltbx` and the firmware `mainmodel.mldatx` from the latest [release](https://github.com/sync2brain/bossdevice-api-matlab/releases) available in the GitHub project.
+1. Download `bossdevice-api-installer.mltbx` from the latest [release](https://github.com/sync2brain/bossdevice-api-matlab/releases) available in the GitHub project.
 2. Start MATLAB and install the bossdevice API toolbox with double click on `bossdevice-api-installer.mltbx`.
 3. In the MATLAB Command Window, call `bd = bossdevice` to add the bossdevice with the default settings to the list of targets. It will also try to establish connection. If you want to change either the name of the bossdevice or its default IP address in your local MATLAB settings, call `bd = bossdevice('bossdevice','192.168.7.5')` replacing the function arguments with the name and IP address you want to set on the real-time device.
 4. Click on the update command if prompted to update the software dependencies on the bossdevice.

buildUtilities/releaseTask.m

@@ -1,14 +1,22 @@
-function toolboxOptions = releaseTask(toolboxVersion, authorName)
+function toolboxOptions = releaseTask(toolboxVersion, authorName, shareFolder)
 %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");
 

resources/project/EEtUlUb-dLAdf0KpMVivaUlztwA/GAjcWvQFPRgbJP0M7BnYLBR0SC4d.xml

@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info Ref="toolbox/dependencies/firmware" Type="Relative"/>

resources/project/EEtUlUb-dLAdf0KpMVivaUlztwA/GAjcWvQFPRgbJP0M7BnYLBR0SC4p.xml

@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location="7b27b9ba-3b11-4cd5-ab8b-e41b1f5d5d33" type="Reference"/>

resources/project/qZ8ItaPycF0cft2oV6KfE--jrg0/587XyntKtAhkQTPdd-zq81WPdhgd.xml

@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info>
+    <Category UUID="FileClassCategory">
+        <Label UUID="design"/>
+    </Category>
+</Info>

resources/project/qZ8ItaPycF0cft2oV6KfE--jrg0/587XyntKtAhkQTPdd-zq81WPdhgp.xml

@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location=".gitkeep" type="File"/>

resources/project/qZ8ItaPycF0cft2oV6KfE--jrg0/Zt0EuUu3hp5JE6eUymXgY7nusMod.xml

@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info/>

resources/project/qZ8ItaPycF0cft2oV6KfE--jrg0/Zt0EuUu3hp5JE6eUymXgY7nusMop.xml

@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location="1" type="DIR_SIGNIFIER"/>

resources/project/qawpnVjg7KZRdWTKOsH-xxMCD14/qZ8ItaPycF0cft2oV6KfE--jrg0d.xml

@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info/>

resources/project/qawpnVjg7KZRdWTKOsH-xxMCD14/qZ8ItaPycF0cft2oV6KfE--jrg0p.xml

@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location="firmware" type="File"/>

toolbox/bossdevice.m

@@ -98,8 +98,13 @@ function clearPersonalSettings()
             end
 
             % Search firmware binary and prompt user if not found in MATLAB path
+            toolboxPath = fileparts(which(mfilename));
+            firmwareSharePath = 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 ~batchStartupOptionUsed
                 [filename, firmwareFilepath] = uigetfile([obj.appName,'.mldatx'],...
                     'Select the firmware binary to load on the bossdevice');