Merge pull request #155 from ImperialCollegeLondon/feat/helioswarm-2.0.0

feat: Add support HelioSwarm `hs-mag` 2.0.0

Author: mfacchinelli

.env

@@ -1 +1 @@
-MAG_DATA_VISUALIZATION_VERSION=7.6.2
+MAG_DATA_VISUALIZATION_VERSION=7.7.0

app/mission/imap/+mag/+app/+imap/+control/HK.m renamed to app/core/+mag/+app/+control/HK.m

@@ -1,31 +1,46 @@
 classdef HK < mag.app.Control & mag.app.mixin.StartEndDate
-% HK View-controller for generating "mag.imap.view.HK".
+% HK View-controller for generating housekeeping view.
 
     properties (Constant)
         Name = "HK"
     end
 
+    properties (SetAccess = immutable)
+        ViewType function_handle {mustBeScalarOrEmpty}
+    end
+
     properties (SetAccess = private)
         Layout matlab.ui.container.GridLayout
     end
 
     methods
 
+        function this = HK(viewType)
+
+            arguments
+                viewType (1, 1) function_handle
+            end
+
+            this.ViewType = viewType;
+        end
+
         function instantiate(this, parent)
 
             this.Layout = this.createDefaultGridLayout(parent);
+
+            % Start and end dates.
             this.addStartEndDateButtons(this.Layout, StartDateRow = 1, EndDateRow = 2);
         end
 
         function supported = isSupported(~, results)
-            supported = results.HasHK;
+            supported = results.HasHK && any(results.HK.isPlottable());
         end
 
         function command = getVisualizeCommand(this, results)
 
             arguments (Input)
                 this
-                results (1, 1) mag.imap.Instrument
+                results (1, 1) mag.Instrument
             end
 
             arguments (Output)
@@ -35,7 +50,7 @@ function instantiate(this, parent)
             [startTime, endTime] = this.getStartEndTimes();
             results = mag.app.internal.cropResults(results, startTime, endTime);
 
-            command = mag.app.Command(Functional = @(varargin) mag.imap.view.HK(varargin{:}).visualizeAll(), ...
+            command = mag.app.Command(Functional = @(varargin) this.ViewType(varargin{:}).visualizeAll(), ...
                 PositionalArguments = {results});
         end
     end

app/mission/hs/+mag/+app/+hs/AnalysisManager.m

@@ -50,9 +50,10 @@ function instantiate(this, parent)
             this.MetadataPatternEditFieldLabel.Text = "Metadata pattern:";
 
             % Create MetadataPatternEditField.
-            this.MetadataPatternEditField = uieditfield(this.AnalyzeSettingsLayout, "text");
+            this.MetadataPatternEditField = uieditfield(this.AnalyzeSettingsLayout, "text", Enable = "off");
             this.MetadataPatternEditField.Layout.Row = 2;
             this.MetadataPatternEditField.Layout.Column = [2, 3];
+            this.MetadataPatternEditField.Placeholder = "Not supported for HelioSwarm yet";
 
             % Create SciencePatternEditFieldLabel.
             this.SciencePatternEditFieldLabel = uilabel(this.AnalyzeSettingsLayout);

app/mission/hs/+mag/+app/+hs/VisualizationManager.m

@@ -10,6 +10,7 @@
         function supportedVisualizations = getSupportedVisualizations(~, ~)
 
             supportedVisualizations = [mag.app.control.Field(@mag.hs.view.Field), ...
+                mag.app.control.HK(@mag.hs.view.HK), ...
                 mag.app.control.PSD(@mag.hs.view.PSD), ...
                 mag.app.control.Spectrogram(@mag.hs.view.Spectrogram), ...
                 mag.app.control.SignalAnalyzer("Science"), ...

app/mission/imap/+mag/+app/+imap/VisualizationManager.m

@@ -14,7 +14,7 @@
                 mag.app.imap.control.Field(), ...
                 mag.app.imap.control.IALiRT(), ...
                 mag.app.imap.control.Timestamp(), ...
-                mag.app.imap.control.HK(), ...
+                mag.app.control.HK(@mag.imap.view.HK), ...
                 mag.app.control.PSD(@mag.imap.view.PSD), ...
                 mag.app.control.Spectrogram(@mag.imap.view.Spectrogram), ...
                 mag.app.control.SignalAnalyzer(["Outboard", "Inboard"]), ...

resources/release-notes.md

@@ -1,14 +1,7 @@
-## Software
-
-- (Bartington, HelioSwarm, IMAP) Add support for more date formats for metadata readers
-- (IMAP) Add sensor activation attempts and activation status to SID15 (`mag.imap.hk.SID15`)
+## App
 
-## Project
+- (HelioSwarm) Add HK plot
 
-- Remove opening of project in `buildfile`
-- Add custom code analyzer configuration
-
-## CI
+## Software
 
-- Add support for testing on MATLAB R2025a
-- Add SARIF file
+- (HelioSwarm) Add support for `hs-mag` v2.0.0 artifacts

src/mission/hs/+mag/+hs/+in/ScienceCSV.m

@@ -34,7 +34,7 @@
             metadata = mag.meta.Science(metadataArgs{:}, Primary = true);
 
             % Remove variables.
-            rawData = removevars(rawData, regexpPattern("uprange_\w"));
+            rawData = removevars(rawData, regexpPattern("\w_saturation"));
 
             % Add compression and quality flags.
             if ismember("compression", rawData.Properties.VariableNames)

src/mission/hs/+mag/+hs/+view/Field.m

@@ -26,7 +26,7 @@ function visualize(this)
 
                 this.Figures = this.Factory.assemble( ...
                     science, mag.graphics.style.Stackedplot(Title = this.getFieldTitle(science), YLabels = ["x [nT]", "y [nT]", "z [nT]", "|B| [nT]"], Layout = [3, 1], Charts = mag.graphics.chart.Stackedplot(YVariables = ["X", "Y", "Z", "B"], Filter = science.Quality.isPlottable())), ...
-                    hk, mag.graphics.style.Default(Title = "Sensor Temperatures", YLabel = this.TLabel, Legend = ["Temperature 1", "Temperature 2"], Charts = mag.graphics.chart.Plot(YVariables = "Temperature" + [1, 2])), ...
+                    hk, mag.graphics.style.Default(Title = "Temperatures", YLabel = this.TLabel, Legend = ["Board", "Sensor"], Charts = mag.graphics.chart.Plot(YVariables = ["Board", "Sensor"] + "Temperature")), ...
                     Title = this.getFigureTitle(science), ...
                     Name = this.getFigureName(science), ...
                     Arrangement = [4, 1], ...

src/mission/hs/+mag/+hs/+view/HK.m

@@ -0,0 +1,38 @@
+classdef HK < mag.graphics.view.View
+% HK Show housekeeping for HelioSwarm.
+
+    methods
+
+        function this = HK(results, options)
+
+            arguments
+                results
+                options.?mag.hs.view.HK
+            end
+
+            this.Results = results;
+
+            this.assignProperties(options);
+        end
+
+        function visualize(this)
+
+            this.Figures = matlab.ui.Figure.empty();
+
+            hk = this.Results.HK;
+
+            this.Figures = this.Factory.assemble( ...
+                hk, ...
+                [mag.graphics.style.Default(Title = "1.5 V", YLabel = "[V]", Charts = mag.graphics.chart.Plot(YVariables = "P1V5V")), ...
+                mag.graphics.style.Default(Title = "2.5 V", YLabel = "[V]", Charts = mag.graphics.chart.Plot(YVariables = "P2V5V")), ...
+                mag.graphics.style.LeftRight(Title = "+8.5 V", LeftLabel = "[V]", RightLabel = "[mA]", Charts = [mag.graphics.chart.Plot(YVariables = "P8V5V"), mag.graphics.chart.Plot(YVariables = "P8V5I")]), ...
+                mag.graphics.style.LeftRight(Title = "-8.5 V", LeftLabel = "[V]", RightLabel = "[mA]", Charts = [mag.graphics.chart.Plot(YVariables = "N8V5V"), mag.graphics.chart.Plot(YVariables = "N8V5I")]), ...
+                mag.graphics.style.Stackedplot(Title = "Temperature", YLabels = ["Board " + this.TLabel, "Sensor " + this.TLabel], Layout = [2, 2], Charts = mag.graphics.chart.Stackedplot(YVariables = ["Board", "Sensor"] + "Temperature"))], ...
+                Name = "HK Time Series", ...
+                Arrangement = [4, 2], ...
+                TileIndexing = "rowmajor", ...
+                LinkXAxes = true, ...
+                WindowState = "maximized");
+        end
+    end
+end

src/mission/hs/+mag/+hs/HK.m

@@ -6,58 +6,52 @@
         P1V5V (:, 1) double
         % P2V5V +2.5 V voltage.
         P2V5V (:, 1) double
-        % P2V2I +2.2 V current.
-        P2V2I (:, 1) double
-        % P12I +12 V current.
-        P12I (:, 1) double
-        % P8V +8.0 V voltage.
-        P8V (:, 1) double
-        % P8I +8.0 V current.
-        P8VI (:, 1) double
-        % TEMPERATURE1 Temperature 1.
-        Temperature1 (:, 1) double
-        % TEMPERATURE2 Temperature 2.
-        Temperature2 (:, 1) double
-        % FILTERTYPE Filter type.
-        FilterType (:, 1) double
+        % P8V5V +8.0 V voltage.
+        P8V5V (:, 1) double
+        % P8V5I +8.0 V current.
+        P8V5I (:, 1) double
+        % N8V5V -8.5 V voltage.
+        N8V5V (:, 1) double
+        % N8V5I -8.5 V current.
+        N8V5I (:, 1) double
+        % BOARDTEMPERATURE Board temperature.
+        BoardTemperature (:, 1) double
+        % SENSORTEMPERATURE Sensor temperature.
+        SensorTemperature (:, 1) double
     end
 
     methods
 
         function p1v5v = get.P1V5V(this)
-            p1v5v = this.Data.p1p5v;
+            p1v5v = this.Data.ana_1p5_vlt;
         end
 
         function p2v5v = get.P2V5V(this)
-            p2v5v = this.Data.p2p5v;
+            p2v5v = this.Data.ana_2p5_vlt;
         end
 
-        function p2v2i = get.P2V2I(this)
-            p2v2i = this.Data.p2p2i;
+        function p8v5v = get.P8V5V(this)
+            p8v5v = this.Data.ana_p8p5_vlt;
         end
 
-        function p12i = get.P12I(this)
-            p12i = this.Data.p12i;
+        function p8v5vi = get.P8V5I(this)
+            p8v5vi = this.Data.ana_p8p5_cur;
         end
 
-        function p8v = get.P8V(this)
-            p8v = this.Data.p8v;
+        function n8v5v = get.N8V5V(this)
+            n8v5v = this.Data.ana_n8p5_vlt;
         end
 
-        function p8vi = get.P8VI(this)
-            p8vi = this.Data.p8i;
+        function n8v5v = get.N8V5I(this)
+            n8v5v = this.Data.ana_n8p5_cur;
         end
 
-        function temperature1 = get.Temperature1(this)
-            temperature1 = this.Data.temp1;
+        function boardTemperature = get.BoardTemperature(this)
+            boardTemperature = this.Data.ana_brd_tmp;
         end
 
-        function temperature2 = get.Temperature2(this)
-            temperature2 = this.Data.temp2;
-        end
-
-        function filterType = get.FilterType(this)
-            filterType = this.Data.filter_type;
+        function sensorTemperature = get.SensorTemperature(this)
+            sensorTemperature = this.Data.ana_sns_tmp;
         end
     end
 end