-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathRelease_Notes.html
More file actions
183 lines (183 loc) · 10.3 KB
/
Copy pathRelease_Notes.html
File metadata and controls
183 lines (183 loc) · 10.3 KB
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
<!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_core</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_core">Release Notes for <mark>stdatalog_core</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_core">stdatalog_core</a></strong> package is designed for high-speed data logging and communication with STMicroelectronics hardware devices. It provides a comprehensive set of tools for data acquisition, processing, conversion, and visualization. It manages USB communication to retrieve connected board information and data, set target properties, and control the data acquisition process. Additionally, it oversees error management and application log messages, ensuring smooth and reliable operation.</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>Added support for uploading JSON configuration files for MLC and ISPU sensors
<ul>
<li>Renamed attributes</li>
<li>Updated methods to use MLC/ISPU formats with JSON and maintained retrocompatibility with UCF format</li>
<li>Fixed plot function + dataframe conversion for ISPU</li>
</ul></li>
<li>Refactored utility modules for improved documentation and code clarity
<ul>
<li>Enhanced docstrings across <code>file_manager.py</code>, <code>plot_utils.py</code>, <code>sensors_utils.py</code>, and <code>type_conversion.py</code> to provide clearer descriptions of module purposes, function parameters, return types, and usage examples.</li>
<li>Improved code readability by standardizing formatting, including consistent use of whitespace and line breaks.</li>
<li>Updated <code>FileManager</code> methods to clarify file naming conventions and error handling.</li>
<li>Refined <code>PlotUtils</code> methods for drawing regions and tags on Plotly figures, including better parameter descriptions and behavior notes.</li>
<li>Streamlined <code>SensorUtils</code> and <code>TypeConversion</code> classes for sensor type management and type conversion, respectively, with clearer logic and reduced branching.</li>
<li>Added error handling and edge case considerations in type conversion functions, ensuring robustness against unexpected inputs.</li>
</ul></li>
<li>Refactored HSDatalog_v2
<ul>
<li>Added support streaming Parquet row-groups with fastparquet and fallback to (lazy) Dask DataFrame if available</li>
<li>Improved type casting and rounding for data columns: solved “ispu” casting</li>
</ul></li>
<li>Added get_type_short function in sensors_utils.py</li>
<li>Added missing nullity check for dataframe variable in __get_dataframe_batch and __get_dataframe_batch_gen methods</li>
<li>Refactored HSDatalog to streamline sensor and actuator data handling in HDF5 format</li>
<li>Improve command response handling in PnPLSTSRL_CommandManager</li>
<li>Refactored SSTL implementation and enhance documentation
<ul>
<li>Updated SSTL.py to improve code structure and readability.</li>
<li>Added comprehensive docstrings for classes and methods in SSTL.</li>
<li>Implemented detailed comments explaining packet header construction and segmentation logic.</li>
<li>Modified STWIN_HSD communication files to skip pylint checks for better compatibility.</li>
<li>Enhanced STWINHSDSetMLCSensorCmd class with additional documentation for clarity.</li>
<li>Ensured consistent formatting and style across communication modules.</li>
</ul></li>
<li>Improved data loss detection over ASPEP serial via CRC</li>
<li>Added dedicated exceptions for SSTL and PnPLSTSRL_com_manager</li>
<li>Fixed exception_error, when closing main window</li>
<li>Enhanced documentation and error handling across modules
<ul>
<li>Updated docstrings in converters.py to provide detailed descriptions of classes and methods, including usage examples and parameter explanations.</li>
<li>Improved error handling in dtm.py for loading Device Template Models, ensuring better validation and logging of issues.</li>
<li>Expanded exception classes in exceptions.py with detailed docstrings, providing context for each error type and improving clarity for users.</li>
<li>Enhanced logging functionality in logger.py with improved formatting and documentation for better usability and understanding of logging behavior.</li>
</ul></li>
<li>Replaced pyarrow with fastparquet for DataFrame to Parquet conversion</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>
<ul>
<li>Reshaped serial communication protocol management, based on ASPEP and SSTL</li>
<li>Manage TX and RX segmented packages</li>
<li>Fixded bit order for beacon messages and packet_number</li>
<li>Reset all serial connection attributes in PnPLSTSRL_CommandManager close() function + updated flush() function</li>
<li>Added timeout and data len check</li>
</ul></li>
<li>Added get_base_acquisition_folder</li>
<li>Added missing cmd response check in hs_datalog_stop_log and hs_datalog_set_rtc_time</li>
<li>Fixed dimensions for “ispu” use case: calculate it instead of hard coded value</li>
<li>Robust tags extraction from acquisition info model status</li>
<li><strong>Optimized convert_acquisition_to_hdf5 function</strong>
<ul>
<li>Added parameter “target_filename=None” to function convert_acquisition_to_hdf5 if user want to rename the h5 file created</li>
<li>Manage missing tags_info component</li>
</ul></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>Fixed to_parquet and h5 converter and plot functions</li>
<li>Updated HSDLink start_log API</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: use Parquet + Plotly (wResampler) + Dash as default for HSDatalog_v2 plots</li>
<li>Updated type_conversion, managing float_t, double_t, int_24_t, uint24_t</li>
<li>Updated ACTUATOR components and properties management</li>
<li>Updated ToF plot: added ranging distance value for each zone + automatic time scrolling animation</li>
<li>New USB catalog management: sync/update with the online catalog</li>
<li>Moved query_dtdl_model from DeviceTemplateManager to DeviceCatalogManager class</li>
<li>Fixed data conversion in batch with dummy data (or spts = 0)</li>
<li>Fixed empty conversion job from not supported algorithm (i.e.: ai_motor_classifier)</li>
<li>Integration of new staiotcraft_sdk library version</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><strong>Updated libhs_datalog_v2 libraries for all the supported OS.</strong>
<ul>
<li>Updated libusb linking and added missing lirbary import for UNIX.</li>
<li>Added a new logging system to manage application messages with different levels (NONE, ERROR, WARNING, INFO, DEBUG).</li>
<li>Updated cmake_minimum_required version used to recompile libraries.</li>
<li>Added new hs_datalog_load_ucf_file_to_mlc API (deprecated old hs_datalog_load_ucf_to_mlc API).</li>
</ul></li>
<li>Added hs_datalog_close error message.</li>
<li>Added support for Vanilla and serial datalogger.</li>
<li>Updated return values for last_index, missing_bytes and saved_bytes when returning from__extract_data in case of EOF and fixed missing len(df) check.</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>