Update to 1.1.

Isaac-Ito-MW · Isaac-Ito-MW · commit 2804dab9b30a · 2021-11-10T11:01:44.000Z
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -0,0 +1,20 @@
+# GitLab CI configuration file
+
+# Copyright 2021 The MathWorks, Inc.
+
+test:
+    stage: test
+    tags:
+        - matlab_win64
+    script:
+        - mw -using R2021a matlab -batch "openProject('HybridElectricVehicle.prj'); HEV_RunTests;"
+    cache:
+        paths:
+            - /*.slxc
+    artifacts:
+        paths:
+            - testReport.pdf
+            - testResults.xml
+        when: always
+        reports:
+            junit: testResults.xml
diff --git a/Components/DrivingPatternBasic/DrivingPatternBasic_inputs.m b/Components/DrivingPatternBasic/DrivingPatternBasic_inputs.m
@@ -13,6 +13,7 @@
       'accelerate_decelerate_kph' ...
       'accelerate_decelerate_mph' ...
       'simple_drive_pattern' ...
+      'simple_slow_drive_pattern' ...
       'ftp75_mph' ...
     })} = 'all_zero'
   nvpairs.TimeStep (1,1) double {mustBePositive} = 0.1
@@ -250,6 +251,33 @@
     inputBus.Elements(2).Name = 'VehAccRef';
     inputBus.Elements(2).Unit = 'm/s^2';
 
+  case 'simple_slow_drive_pattern'
+    t_end = 200;
+    % Define signal trace:
+    VehSpdRef = timetable([0 0 0      20 20   20 20     30 30   30 30     10 10   10 10      0 0       0  0   25 25 25     35 35 35     45 45   45 45      30 30     30 30       15 15     15 15        0 0     0]', ...
+       'RowTimes',seconds([0 9.5 10   15 15.5 19.5 20   25 25.5 29.5 30   35 35.5 39.5 40   45 45.5 49.5 50   58 58.5 59   65 65.5 66   85 85.5 89.5 90   110 110.5 119.5 120   150 150.5 159.5 160   190 190.5 t_end])');
+    % Make the signal trace smooth using Akima interpolation:
+    VehSpdRef = retime(VehSpdRef, 'regular','makima', 'TimeStep',seconds(dt));
+    % Remove the negative wiggle:
+    VehSpdRef.Var1(VehSpdRef.Var1 < 0) = 0;
+    % Calculate the acceleration:
+    tmp = diff(VehSpdRef.Var1)/dt * 1000/3600;  % (km/hr)/s to m/s^2 conversion
+    VehAccRef = timetable([tmp; tmp(end)], 'RowTimes',VehSpdRef.Time);
+    inputSignals.VehSpdRef = VehSpdRef;                
+    inputSignals.VehSpdRef.Properties.VariableNames = {'VehSpdRef'};
+    inputSignals.VehSpdRef.Properties.VariableUnits = {'km/hr'};
+    inputSignals.VehSpdRef.Properties.VariableContinuity = {'continuous'};
+    inputSignals.VehAccRef = VehAccRef;
+    inputSignals.VehAccRef.Properties.VariableNames = {'VehAccRef'};
+    inputSignals.VehAccRef.Properties.VariableUnits = {'m/s^2'};
+    inputSignals.VehAccRef.Properties.VariableContinuity = {'continuous'};
+    inputBus.Elements(1) = Simulink.BusElement;
+    inputBus.Elements(1).Name = 'VehSpdRef';
+    inputBus.Elements(1).Unit = 'km/hr';
+    inputBus.Elements(2) = Simulink.BusElement;
+    inputBus.Elements(2).Name = 'VehAccRef';
+    inputBus.Elements(2).Unit = 'm/s^2';
+
   case 'ftp75_mph'
     opt.useFromWorkspace = false;  % Use another source
     opt.useKph = false;
diff --git a/HEV/PowerSplitHEV_SpeedTracking/PowerSplitHEV_SpeedTracking.slx b/HEV/PowerSplitHEV_SpeedTracking/PowerSplitHEV_SpeedTracking.slx
diff --git a/HEV/PowerSplitHEV_SpeedTracking/PowerSplitHEV_SpeedTracking_sweep.mlx b/HEV/PowerSplitHEV_SpeedTracking/PowerSplitHEV_SpeedTracking_sweep.mlx
diff --git a/HEV_main_script.mlx b/HEV_main_script.mlx
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![View Hybrid Electric Vehicle Model in Simscape on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/92820-hybrid-electric-vehicle-model-in-simscape)
 
-Version 1
+Version 1.1
 
 Copyright 2021 The MathWorks, Inc.
 
@@ -56,7 +56,7 @@ some components come with their own test setups.
 
 ## Tool Requirements
 
-Supported MATLAB version: R2020b or newer releases
+Supported MATLAB version: R2021a or newer releases
 
 Required:
 [MATLAB](https://www.mathworks.com/products/matlab.html),
@@ -67,6 +67,29 @@ Required:
 [Simscape Driveline&trade;](https://www.mathworks.com/products/simscape-driveline.html),
 [Simscape Electrical&trade;](https://www.mathworks.com/products/simscape-electrical.html)
 
+Optional:
+[Parallel Computing Toolbox&trade;](https://www.mathworks.com/products/parallel-computing.html)
+
+## What's New in Version 1.1
+
+### Highlights
+
+Parameter Sweep Workflow in Live Script
+
+- Demonstrates how to investigate the effect of reduction gear ratio,
+  high-voltage battery capacity and high-voltage battery weight
+  on the electrical efficiency.
+  You can optionally use Parallel Computing Toolbox to shorten
+  total simulation time.
+- Watch [YouTube video](https://www.youtube.com/watch?v=cbo83A8K_4w)
+  showing the workflow as well as real-time application.
+  - Real-Time application presented in the video will be added
+    to this project in future updates.
+
+### Other Updates
+
+- MATLAB R2021a or newer release is required.
+
 ## How to Use
 
 Open `HybridElectricVehicle.prj` in MATLAB, and
diff --git a/resources/project/AOPCqSsBDEeY5nWeMJSrMRk7ZkE/O3H8uxFsxo4zl8grqoBXkqDo_nId.xml b/resources/project/AOPCqSsBDEeY5nWeMJSrMRk7ZkE/O3H8uxFsxo4zl8grqoBXkqDo_nId.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/AOPCqSsBDEeY5nWeMJSrMRk7ZkE/O3H8uxFsxo4zl8grqoBXkqDo_nIp.xml b/resources/project/AOPCqSsBDEeY5nWeMJSrMRk7ZkE/O3H8uxFsxo4zl8grqoBXkqDo_nIp.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location="PowerSplitHEV_SpeedTracking_sweep.mlx" type="File" />
diff --git a/resources/project/EEtUlUb-dLAdf0KpMVivaUlztwA/dgnQYbKo9QhpBAmKIMeooB6Oa4Qd.xml b/resources/project/EEtUlUb-dLAdf0KpMVivaUlztwA/dgnQYbKo9QhpBAmKIMeooB6Oa4Qd.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info Ref="test" Type="Relative" />
diff --git a/resources/project/EEtUlUb-dLAdf0KpMVivaUlztwA/dgnQYbKo9QhpBAmKIMeooB6Oa4Qp.xml b/resources/project/EEtUlUb-dLAdf0KpMVivaUlztwA/dgnQYbKo9QhpBAmKIMeooB6Oa4Qp.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location="080bba62-92f7-4760-9f82-ad1d6d284941" type="Reference" />
diff --git a/resources/project/FI0gxbH-PhwjE_riDQGHPyYMHks/5Lk_HLOyBtA13ybsC7_0l8N5sPcd.xml b/resources/project/FI0gxbH-PhwjE_riDQGHPyYMHks/5Lk_HLOyBtA13ybsC7_0l8N5sPcd.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info />
diff --git a/resources/project/FI0gxbH-PhwjE_riDQGHPyYMHks/5Lk_HLOyBtA13ybsC7_0l8N5sPcp.xml b/resources/project/FI0gxbH-PhwjE_riDQGHPyYMHks/5Lk_HLOyBtA13ybsC7_0l8N5sPcp.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location="1" type="DIR_SIGNIFIER" />
diff --git a/resources/project/FI0gxbH-PhwjE_riDQGHPyYMHks/CVp40jxfehjKXVgv12AU4FGQbi8d.xml b/resources/project/FI0gxbH-PhwjE_riDQGHPyYMHks/CVp40jxfehjKXVgv12AU4FGQbi8d.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/FI0gxbH-PhwjE_riDQGHPyYMHks/CVp40jxfehjKXVgv12AU4FGQbi8p.xml b/resources/project/FI0gxbH-PhwjE_riDQGHPyYMHks/CVp40jxfehjKXVgv12AU4FGQbi8p.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location="HEV_RunTests.m" type="File" />
diff --git a/resources/project/FI0gxbH-PhwjE_riDQGHPyYMHks/Jk9_yYGEccH-2KVwVBcD8jHbqBId.xml b/resources/project/FI0gxbH-PhwjE_riDQGHPyYMHks/Jk9_yYGEccH-2KVwVBcD8jHbqBId.xml
@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info>
+    <Category UUID="FileClassCategory">
+        <Label UUID="test" />
+    </Category>
+</Info>
diff --git a/resources/project/FI0gxbH-PhwjE_riDQGHPyYMHks/Jk9_yYGEccH-2KVwVBcD8jHbqBIp.xml b/resources/project/FI0gxbH-PhwjE_riDQGHPyYMHks/Jk9_yYGEccH-2KVwVBcD8jHbqBIp.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location="HEV_UnitTest.m" type="File" />
diff --git a/resources/project/FI0gxbH-PhwjE_riDQGHPyYMHks/pAJWBvItu6EwAFyZVkEQHia1Ocgd.xml b/resources/project/FI0gxbH-PhwjE_riDQGHPyYMHks/pAJWBvItu6EwAFyZVkEQHia1Ocgd.xml
@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info>
+    <Category UUID="FileClassCategory">
+        <Label UUID="test" />
+    </Category>
+</Info>
diff --git a/resources/project/FI0gxbH-PhwjE_riDQGHPyYMHks/pAJWBvItu6EwAFyZVkEQHia1Ocgp.xml b/resources/project/FI0gxbH-PhwjE_riDQGHPyYMHks/pAJWBvItu6EwAFyZVkEQHia1Ocgp.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location="HEV_UnitTest_local.m" type="File" />
diff --git a/resources/project/qaw0eS1zuuY1ar9TdPn1GMfrjbQ/FI0gxbH-PhwjE_riDQGHPyYMHksd.xml b/resources/project/qaw0eS1zuuY1ar9TdPn1GMfrjbQ/FI0gxbH-PhwjE_riDQGHPyYMHksd.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info />
diff --git a/resources/project/qaw0eS1zuuY1ar9TdPn1GMfrjbQ/FI0gxbH-PhwjE_riDQGHPyYMHksp.xml b/resources/project/qaw0eS1zuuY1ar9TdPn1GMfrjbQ/FI0gxbH-PhwjE_riDQGHPyYMHksp.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location="test" type="File" />
diff --git a/resources/project/qaw0eS1zuuY1ar9TdPn1GMfrjbQ/ND1paoxO_gAn0xODWcXslm82AWod.xml b/resources/project/qaw0eS1zuuY1ar9TdPn1GMfrjbQ/ND1paoxO_gAn0xODWcXslm82AWod.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info />
diff --git a/resources/project/qaw0eS1zuuY1ar9TdPn1GMfrjbQ/ND1paoxO_gAn0xODWcXslm82AWop.xml b/resources/project/qaw0eS1zuuY1ar9TdPn1GMfrjbQ/ND1paoxO_gAn0xODWcXslm82AWop.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info location=".gitlab-ci.yml" type="File" />
diff --git a/test/HEV_RunTests.m b/test/HEV_RunTests.m
@@ -0,0 +1,33 @@
+%% Script to run unit test and generate report
+
+% Copyright 2021 The MathWorks, Inc.
+
+%% Create test suite
+
+import matlab.unittest.TestSuite;
+s1 = TestSuite.fromClass(?HEV_UnitTest);
+suite = s1;
+
+%% Create test runner
+
+runner = matlab.unittest.TestRunner.withTextOutput( ...
+  'OutputDetail', matlab.unittest.Verbosity.Detailed);
+
+%% Set up report
+
+% XML
+%{=
+runner.addPlugin( ...
+  matlab.unittest.plugins.XMLPlugin.producingJUnitFormat('testResults.xml'));
+%}
+
+% PDF
+%{=
+runner.addPlugin( ...
+  matlab.unittest.plugins.TestReportPlugin.producingPDF('testReport.pdf'));
+%}
+
+%% Run test
+
+results = runner.run(suite);
+disp(results.assertSuccess);
diff --git a/test/HEV_UnitTest.m b/test/HEV_UnitTest.m
@@ -0,0 +1,25 @@
+classdef HEV_UnitTest < matlab.unittest.TestCase
+% This implements unit tests that should be run both locally and in CI.
+
+% Copyright 2021 The MathWorks, Inc.
+
+methods (Test)
+
+  function testMATLABVersion_21a(testCase)
+    expected = "R2021a";
+    actual = matlabRelease.Release;
+    verifyEqual(testCase, actual, expected);
+  end
+
+  function minimalTest_HevSpeedTracking_10s(testCase)
+    mdl = "PowerSplitHEV_SpeedTracking";
+    t_end = 10;  % Simulation stop time in seconds
+    if not(bdIsLoaded(mdl)), load_system(mdl); end
+    in = Simulink.SimulationInput(mdl);
+    in = setModelParameter(in, 'StopTime',num2str(t_end));
+    sim(in);
+    bdclose(mdl)
+  end
+
+end  % methods (Test)
+end  % classdef
diff --git a/test/HEV_UnitTest_local.m b/test/HEV_UnitTest_local.m
@@ -0,0 +1,26 @@
+classdef HEV_UnitTest_local < matlab.unittest.TestCase
+% This implements tests that should be run locally.
+
+% Copyright 2021 The MathWorks, Inc.
+
+methods (Test)
+
+  function projectRunChecks(testCase)
+  %% Programatically run the projects's Run Check.
+  % This corresponds to "Project > Run Checks" in GUI.
+  % This test checks that Run Checks ends with all clean.
+    prj = currentProject;
+    updateDependencies(prj);
+    checkResults = runChecks(prj);
+    resultTable = table(checkResults);  % *.Passed, *.ID, *.Description
+    verifyEqual(testCase, all(resultTable.Passed==true), true);
+  end
+
+  function test_HevWorkflow(~)
+  %% Run the HEV parameter sweep workflow script.
+  % Note that individual figure windows will appear while this is running.
+    evalin("base", "PowerSplitHEV_SpeedTracking_sweep");
+  end
+
+end  % methods (Test)
+end  % classdef
diff --git a/utils/onPrjOpen.m b/utils/onPrjOpen.m
@@ -4,11 +4,9 @@
 %
 % Copyright 2020-2021 The MathWorks, Inc.
 
-v = ver('matlab');
-if not(v.Version == "9.9")
-  release = "R2020b";
-  disp("This project was developed in " + release + ".")
-  disp("This MATLAB is " + v.Release(2:end-1) + ".")
+if not(contains(string(ver('matlab').Release), "R2021a"))
+  disp("This project was developed in R2021a.")
+  versionhar = ver('matlab').Release;
+  disp("This MATLAB Release is " + versionhar(2:end-1) + ".")
   clear release
 end
-clear v

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="PowerSplitHEV_SpeedTracking_sweep.mlx" type="File" />`
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="test" 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="080bba62-92f7-4760-9f82-ad1d6d284941" type="Reference" />`