stdatalog_gui/Release_Notes.html at main · STMicroelectronics/stdatalog_gui · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
  <meta charset="utf-8" />
  <meta name="generator" content="pandoc" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
  <title>Release Notes for stdatalog_gui</title>
  <style type="text/css">
      code{white-space: pre-wrap;}
      span.smallcaps{font-variant: small-caps;}
      span.underline{text-decoration: underline;}
      div.column{display: inline-block; vertical-align: top; width: 50%;}
  </style>
  <link rel="stylesheet" href="_htmresc/mini-st_2020.css" />
  <!--[if lt IE 9]>
    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
  <![endif]-->
  <link rel="icon" type="image/x-icon" href="_htmresc/favicon.png" />
</head>
<body>
<div class="row">
<div class="col-sm-12 col-lg-4">
<center>
<h1 id="release-notes-for-stdatalog_gui">Release Notes for <mark>stdatalog_gui</mark></h1>
<p>Copyright © 2025 STMicroelectronics</p>
<a href="https://www.st.com" class="logo"><img src="_htmresc/st_logo_2020.png" alt="ST logo" /></a>
</center>
<h1 id="purpose">Purpose</h1>
<p>The <strong><a href="https://github.com/STMicroelectronics/stdatalog_gui">stdatalog_gui</a></strong> package is a UI toolkit developed by STMicroelectronics, based on <strong><a href="https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/DTDL.v2.md">DTDLv2</a></strong> (<strong>D</strong>igital <strong>T</strong>win <strong>D</strong>efinition <strong>L</strong>anguage) and <strong><a href="https://pypi.org/project/PySide6/">PySide6</a></strong>. It provides a graphical user interface for high-speed data logging and communication with STMicroelectronics hardware devices. The package provides a set of graphical widgets useful to display live data streams, configure, and show connected device parameters and manage data collection. These widgets are the basic building blocks for creating interactive graphical user interfaces (GUIs) to manage datalogging applications and devices configuration.</p>
<p>The package is part of the <strong><a href="https://github.com/STMicroelectronics/stdatalog-pysdk">STDATALOG-PYSDK</a></strong>, which is a set of libraries and tools that enable the development of applications for data logging and data monitoring.</p>
</div>
<div class="col-sm-12 col-lg-8">
<h1 id="update-history">Update History</h1>
<div class="collapse">
<input type="checkbox" id="collapse-section6" checked aria-hidden="true"> <label for="collapse-section6" aria-hidden="true">v1.4.0 / 15-May-26</label>
<div>
<h2 id="main-changes">Main Changes</h2>
<h3 id="maintenance-release">Maintenance Release</h3>
<ul>
<li>Enhanced widget modules with improved documentation and code structure
<ul>
<li>Added comprehensive docstrings to <code>PropertyWidget</code>, <code>TelemetryWidget</code>, and <code>ToggleButton</code> classes, detailing parameters, attributes, and responsibilities.</li>
<li>Refactored code for better readability, including consistent formatting and line wrapping.</li>
<li>Improved hover and state handling in <code>ToggleButton</code> for better user experience.</li>
<li>Updated <code>PropertyWidget</code> and <code>TelemetryWidget</code> to ensure consistent handling of telemetry data and UI updates.</li>
<li>Enhanced <code>SubPropertyWidget</code> and <code>SubTelemetryWidget</code> to better manage nested properties and telemetry fields.</li>
<li>Ensured all widgets maintain a clear separation of concerns, focusing on presentation while delegating logic to controllers.</li>
</ul></li>
<li>Refactored MLC and ISPU configuration handling
<ul>
<li>Added the support to JSON format. UCF still maintained to ensure retrocompatibility</li>
<li>Updated signal names and file filters</li>
<li>Refactored HSD_Controller and HSDPlotLinesWidget to support MLC ISPU configuration and output formats</li>
</ul></li>
<li>Added ‘PlotImageWidget’ and ‘HSDPlotImageWidget’ to manage data from camera and image sensors</li>
<li>Fixed exception error when closing main window</li>
<li>Refactored plotting widgets and enhance documentation
<ul>
<li>Updated HSDPlotPOWWidget to improve docstrings and clarify parameters.</li>
<li>Enhanced HSDPlotTMOSWidget with detailed descriptions and improved parameter handling.</li>
<li>Refined HSDPlotToFWidget to include comprehensive docstrings and maintainability improvements.</li>
<li>Introduced TagToggleButton with clear documentation for tag controls.</li>
<li>Enhanced TagsInfoWidget with detailed docstrings, improved signal handling, and better organization of tag management logic.</li>
<li>Improved code readability and consistency across all modified files.</li>
</ul></li>
<li>Refactored DeviceInformation into dedicated widget subclass avoiding hardcoded unit labels</li>
<li>Refactored Motor Control Widgets for Improved Documentation and Structure
<ul>
<li>Added module-level docstrings to <code>HSD_MC_ControlWidget</code>, <code>HSD_MC_FastTelemetriesPlotLinesWidget</code>, <code>HSD_MC_FastTelemetriesPlotWidget</code>, <code>HSD_MC_LogControlWidget</code>, and <code>HSD_MC_SlowTelemetriesPlotWidget</code> to enhance clarity on their purpose and functionality.</li>
<li>Improved class docstrings to specify parameters, attributes, and methods for better understanding and maintainability.</li>
<li>Updated method docstrings to describe their functionality, parameters, and return types where applicable.</li>
<li>Cleaned up code formatting and removed unnecessary semicolons and comments.</li>
<li>Enhanced signal-slot connections and widget initialization for better readability and organization.</li>
<li>Ensured consistent use of f-strings for string formatting.</li>
</ul></li>
</ul>
</div>
</div>
<div class="collapse">
<input type="checkbox" id="collapse-section5" aria-hidden="true"> <label for="collapse-section5" aria-hidden="true">v1.3.0 / 15-Nov-25</label>
<div>
<h2 id="main-changes-1">Main Changes</h2>
<h3 id="maintenance-release-and-product-update">Maintenance Release and Product Update</h3>
<ul>
<li><strong>Full support to Serial Datalog adding compatibility with STSW-SDATALOG firmware examples</strong></li>
<li><strong>Added support to CubeAI and NanoEdgeAI based examples for FP-IND-DATALOGMC</strong></li>
<li>Created dedicated connection widget for motor control application</li>
<li>Removed useless get acquisition info commands before start/stop</li>
<li>Reshaped and optimized start_log/start_plot procedure</li>
<li>Added PnPL_Warning management - same as PnPL_Error</li>
<li>Fixed MainWindow closeEvent + stop_plots/stop_log + fixed save_files_flag</li>
<li>Fixed dimensions for “ispu” use case: calculate it instead of hard coded value</li>
<li>Fixed custom_dtmi entries management with fw_id and board_id fields in DeviceTemplateLoadingWidget</li>
<li>Fixed FFT normalization factors</li>
<li>Updated staiotcraft version</li>
<li>Bug fixing and code cleaning. Fixed typos</li>
</ul>
</div>
</div>
<div class="collapse">
<input type="checkbox" id="collapse-section4" aria-hidden="true"> <label for="collapse-section4" aria-hidden="true">v1.2.1 / 29-Aug-25</label>
<div>
<h2 id="main-changes-2">Main Changes</h2>
<h3 id="patch-release">Patch Release</h3>
<ul>
<li>Solved issue #1 - pull request #2: accepted proposal from <span class="citation" data-cites="YumTaha">@YumTaha</span></li>
<li>Fixed custom Device Model save and update</li>
</ul>
</div>
</div>
<div class="collapse">
<input type="checkbox" id="collapse-section3" aria-hidden="true"> <label for="collapse-section3" aria-hidden="true">v1.2.0 / 20-Jun-25</label>
<div>
<h2 id="main-changes-3">Main Changes</h2>
<h3 id="maintenance-release-1">Maintenance Release</h3>
<ul>
<li>Added support to Python 3.13</li>
<li>Removed dependency from matplotlib in HSD_GUI</li>
<li>Updated ACTUATOR components and properties management, aligned to new fast and slow telemetry DTDL components</li>
<li>New USB catalog management: sync/update with the online catalog</li>
<li>Added new dialog to show received PnPL_Error</li>
<li>Moved query_dtdl_model from DeviceTemplateManager to DeviceCatalogManager class</li>
<li>Aligned to staiotcraft python latest library version</li>
<li>Fixed plot threads creation and shutdown + join stopped sensors acquisition threads</li>
</ul>
</div>
</div>
<div class="collapse">
<input type="checkbox" id="collapse-section2" aria-hidden="true"> <label for="collapse-section2" aria-hidden="true">v1.1.0 / 9-Apr-25</label>
<div>
<h2 id="main-changes-4">Main Changes</h2>
<h3 id="maintenance-release-2">Maintenance Release</h3>
<ul>
<li><strong>Added macos support.</strong></li>
<li>Optimized TagsInfoWidget creation function.</li>
<li>Fixed SpinBoxes arrows icons + QFrame unwanted borders + CommandWidget button name</li>
<li>Added support for Vanilla and serial datalogger.</li>
</ul>
</div>
</div>
<div class="collapse">
<input type="checkbox" id="collapse-section1" aria-hidden="true"> <label for="collapse-section1" aria-hidden="true">v1.0.0 / 17-Jan-25</label>
<div>
<h2 id="main-changes-5">Main Changes</h2>
<h3 id="first-official-release">First official release</h3>
</div>
</div>
</div>
</div>
<footer class="sticky">
<div class="columns">
<div class="column" style="width:95%;">
<p>For complete documentation, visit: <a href="https://github.com/STMicroelectronics/stdatalog-pysdk">www.st.com</a></p>
</div><div class="column" style="width:5%;">
<p><abbr title="Based on template cx566953 version 2.0">Info</abbr></p>
</div>
</div>
</footer>
</body>
</html>