CHANGELOG
Changelog
All notable changes to this project will be documented in this file.
This file is related to the SmartReport Python package.
[2.43.37] - 2026-01-21
Fixed
- Deionizer Indicator KPI text in drive asset report
[2.43.36] - 2026-01-16
Fixed
- Value error in DC Voltage section when no data available
[2.43.35] - 2026-01-12
Added
- Deionizer Indicator KPI to drive asset report
[2.43.34] - 2025-12-23
Fixed
- Remove Smart Sensor portal text from new drive reports
[2.43.33] - 2025-12-05
Fixed
- REC: Section not add when gateway equal None
[2.43.32] - 2025-12-04
Fixed
- REC: Section not add when sensor equal None
Changed
- REC: Add assets sorting to tables
[2.43.31] - 2025-11-26
Changed
- REC: Fix summary info, contract info section
- REC: Add Sensor identifiers to the connectivity analysis and contract information table
- REC: In connectivity analysis, show assets with last seen > 8 hours from report generation time
[2.43.30] - 2025-11-25
Changed
- Changed: No Data to Unknown to make Status on reports inline with Powertrain portal
[2.43.29] - 2025-11-24
Fixed
- Fixed: make display name shorten and clean up ShortAssetNamesSection
[2.43.28] - 2025-11-18
Fixed
- Fixed: Truncate long asset names in Drive Status plots for improved readability. Introduced
Asset.short_nameto store the shortened version.
[2.43.27] - 2025-11-18
Added
- Add DC Voltage KPI to drive asset report
[2.43.26] - 2025-11-13
Fixed
- Duplicate removal in
upsample_indexwas causing attribute error when working with ordinary data frames due to wrong logging statement
[2.43.25] - 2025-11-13
Fixed
- Bug 502140 - Change Current Overload section introduction text
[2.43.24] - 2025-11-06
Changed
- Add number of assets in tables in fleet reports for drives and motors
[2.43.23] - 2025-11-05
Changed
- Align the Machine Guardian report template - section 6.10 FFT magnetic flux
[2.43.22] - 2025-10-31
Fixed
- Fix building documentation
[2.43.21] - 2025-10-31
Fixed
- Fix SonarCube
[2.43.20] - 2025-10-30
Changed
- Align the Machine Guardian report template - section 6.9 frequency domain vibration
[2.43.19] - 2025-10-29
Fixed
- REC Fix: Model validation error.
[2.43.18] - 2025-10-27
Fixed
- REC Fix: Implemented logic to honor the "Do not Show Empty parameter" (formerly the first parameter always visible) for the General Information Table.
[2.43.17] - 2025-10-21
Fixed
- Fix bug: #493084 - Y-axis handling on the current overload plot
[2.43.16] - 2025-10-20
Changed
- REC : Flag for skipping offline devices in connectivity analysis
[2.43.15] - 2025-10-20
Changed
- Align the Machine Guardian report template - section 6.8 FFT Velocity
[2.43.14] - 2025-10-10
Fixed
- Fix bug: #476494 - Current overload condition index and Air temperature are missing in the Instant report
- Fix bug: #490639 - expert fleet report does not show unsupported drives
[2.43.13] - 2025-10-09
Fixed
- Fix bug: #486583 - Instant motor asset report - Few mismatches
- Fix bug: #486888 - Fleet Overview Report - Missing section description
- Fix bug: #486991 - Drive instant asset report - Few mismatches
[2.43.12] - 2025-09-16
Fixed
- Parametrize mass unit in machine guardian asset report Asset Details section
[2.43.11] - 2025-09-25
Changed
- Update and align the requirements
[2.43.10] - 2025-09-24
Changed
- Add support for Python 3.13
[2.43.9] - 2025-09-23
Changed
- Use local unit converter
[2.43.8] - 2025-09-22
Changed
- Use and setup uv from DevOpsHelper repository
[2.43.7] - 2025-09-16
Updated
- ReportConnectors = 1.27.1
[2.43.6] - 2025-09-16
Fixed
- Bugfix #476664: Condition index 'Air temp' no calculated for ACS580 ASCD2
[2.43.5] - 2025-09-12
Fixed
- Bugfix #475686: No icons in Machine Guardian Asset Report
[2.43.4] - 2025-09-04
Fixed
- REC Report:
- Report info sites
[2.43.3] - 2025-09-04
Changed
- REC Report:
- Analysis attachments as list of dict
- Add Contract info section
[2.43.2] - 2025-08-28
Fixed
- REC Report:
- Add support for base64 encoded analysis
- Add Contract info section
[2.43.1] - 2025-08-22
Fixed
- REC Report:
- Adjust picture for first page
- add brake pages into REC JSON file
- add connectivity analysis to table
- fix parsing date of last activity
[2.43.0] - 2025-08-20
Changed
- Raw Data related logic is removed from this repository. Instead, we use the
smartanalyticspackage (>=0.43) implementation.
Fixed
- Improved handling of the Raw Data Signal Side in the Statistics table.
[2.42.4] - 2025-08-14
Fixed
- Add side name to Raw Data Signal table Bug #454788
[2.42.3] - 2025-08-14
Added
- V3 Rec Fleet Report: Gateway Connectivity Section
[2.42.2] - 2025-08-04
Added
- Bearing condition (Section 6.6) in Machine Guardian report
[2.42.1] - 2025-08-01
Fixed
- Bugfix #475686: Invalid translation texts for the Drive Events Sections
[2.42.0] - 2025-07-18
Added
- V3 Rec Fleet Report
[2.41.5] - 2025-07-21
Fixed
- Remove WIP from MachineGuardian Report section 2
[2.41.4] - 2025-07-15
Fixed
- Bug #468905:
Drive Asset Report V3 - Current Overload Section Issues
[2.41.3] - 2025-07-10
Fixed
- Bug #454193: Incorrect signal axes for data from Como sensors with new firmware
[2.41.2] - 2025-07-04
Fixed
- Translation texts for the Drive Asset Report V3
[2.41.1] - 2025-07-04
Fixed
- bug #468896:
Wrong Threshold are displayed in the Air Temperature plot.
[2.41.0] - 2025-07-03
Added
- New concept of builder and processors for V3 reports
Fixed
- bug #455778:
Speed profile show wrong unit. - bug #468894:
Switch between Air Temperature and Environment Temperature malfunctions
[2.40.3] - 2025-07-03
Fixed
- Bugfix #470226 - Filter out CI model columns from the CI results returned by the Powertrain Report API.
[2.40.2] - 2025-06-27
Added
- Condition Indices related plots. Migrated from PIRAT's CI Viewer
- New Asset Report Section: Condition Indices Combined Plots, with a combined view of all condition indices per signal.
[2.40.1] - 2025-06-25
Fixed
- RawDataSignal
to_wavemethod saves the signal to both the file path and open file object.
[2.40.0] - 2025-06-25
Added
- Dedicated RawDataSignalSpectrum class created to deal with spectrum data.
- SpectrumPointsGroup class to group points from the spectrum (harmonics, peaks, etc.)
Changed
- RawDataSignal class refactored.
.fft()method returns RawDataSignalSpectrum object. plot_signal_in_frequencyrefactored to use RawDataSignalSpectrum as an input.- FigureResampler removed from the signal-plotting functions, to avoid issues with spectrum misrepresentation.
- RawData sections in the V3 reports changed to always use D-Peaks algorithm to detect peaks and harmonics.
- plot zooming callbacks extracted from the speed edit related callbacks.
Fixed
- bug #453064: Invalid behavior of the highest peak detection in the spectrum plots
[2.39.6] - 2025-06-25
Fixed
- bug #455985: Smart Reports V3 Events subsection not displayed when KPI is green
[2.39.5] - 2025-06-24
Fixed
- Current Overload does not show up in the Drive Asset Report V3
Changed
- Verification if KPI is supported by Drive based on PT API
- CURRENT_OVERLOAD_INTRODUCTION_TEXT for the Drive Current Overload section in Drive Asset Report V3
- AIR_TEMPERATURE_INTRODUCTION_TEXT for the Drive Air Temperature section in Drive Asset Report V3
[2.39.4] - 2025-05-25
Added
- Machine Guardian report template:
- Vibration analysis (section 6.1 - 6.5)
- Raw acceleration signals (section 6.7)
[2.39.3] - 2025-06-03
Fixed
- INTRODUCTION_TEXT for Drive Air Temperature
[2.39.2] - 2025-05-30
Added
- Drive asset report V3 section DriveEvents
- Drive fleet report V3 section DriveEvents
- ProtectionEvents in overview section
Fixed
- issue with the legend of the Drive Status kpi timeline in the fleet report , drive status section.
[2.39.1] - 2025-05-30
Add
- DriveAirTemperatureSection to asset and fleet report V3.
[2.39.0] - 2025-05-25
Added
- Initial migration of Machine Guardian Asset Report (Section 1, 2, 3 and 4)
[2.38.4] - 2025-05-21
Fixed
- removed indirect dependency on
shapelypackage
[2.38.3] - 2025-05-21
Fixed
- bug #437513 - Time not available on network is wrong
[2.38.2] - 2025-05-19
Added
- Drive fleet report V3 section CurrentOverload
[2.38.1] - 2025-05-19
Added
- Drive asset report V3 section CurrentOverload
Fixed
- bug #433388 - Power Module Temperature Not supported for DCS drives
[2.38.0] - 2025-05-09
Added
- Imperial Unit Standard support for all V3 reports
- Add SORT_LEGEND to KPIDriveFleetReportSection.Settings
Fixed
- bug #447969 - Missing drive indicator results/traffic lights in New instant drive fleet detailed report
[2.37.6] - 2025-05-12
Changed
- PBI #447959 - REPLACE KPI with Indicators
[2.37.5] - 2025-05-09
Fixed
- bug #437835 - wrong bar size on the timeline plots on the Drive Asset Report
- bug #445407 - wrong style of timeline plots on the Drive Asset Report
- bug #431832 - wrong asset details section in Drive Asset Report
[2.37.4] - 2025-05-08
Added
- report-variant parameter support in the report regression tests
Fixed
- bug #438217 - Wrong section in the fleet override report V3
[2.37.3] - 2025-05-08
Changed
- Speed estimation for raw data uses the signals with the lowest sampling frequencies. Applies to both legacy and V3.
[2.37.2] - 2025-05-05
Fixed
- bug #443157 - Wrong heading text for Fleet Alarms section
- bug #435080 - Empty Condition index data causing fleet alarm section to fail
- Handling of invalid value and data type in the AsseProperty model
[2.37.1] - 2025-04-30
Fixed
- bug #433531 - Asset Instant Report vs Template Inconsistencies - sections order
[2.37.0] - 2025-04-30
Added
- CSV Raw data readers
- Implemented efficient CSV reading using Pandas.
- Enhanced header parsing using Pydantic.
- Raw data models:
- Raw Data Signal model with refactored and documented methods.
- Raw Data Measurement model with support for better signal filtering, measurement context, bearing data, and advanced filtering.
- Assert Report V3 Integration
- New Measurement Report V3 utilizing new models.
- Support for Python 3.12
- Dedicated callbacks for V3 reports
Changed
- Removed support for Python 3.9
[2.36.8] - 2025-04-29
Fixed
- bug #433531 - Asset Instant Report vs Template Inconsistencies
[2.36.7] - 2025-04-20
Fixed
- Sorting in tables by float.
[2.36.6] - 2025-04-23
Changed
- Update reference regression files to be based on March 2025 data from ABB demo assets
Fixed
- bug #443358 - Use correct environment sensor data in the Drive Asset report V3
[2.36.5] - 2025-04-15
Fixed
- bug #439646 - Use Asset ID in the first page table on the V3 asset reports
[2.36.4] - 2025-04-14
Fixed
- has_access() method in AssetV3 was not verifying the correct capability
[2.36.3] - 2025-04-14
Fixed
- has_acces in powertrian
[2.36.2] - 2025-04-08
Fixed
- Flaky regression tests for drive asset report.
[2.36.1] - 2025-04-08
Fixed
- bug #433531 - [v3] Asset Instant Report vs Template Inconsistencies
[2.36.0] - 2025-04-04
Changed
- Use Report API to get the asset details in Powertrain data reader.
- Use Report API to get capabilities to check access to resources in Powertrain data reader.
- Remove dependency on Asset API client and Organization API client.
Fixed
- bug #436812 - Fix URL generation to the asset details on Powertrain portal
[2.35.5] - 2025-04-02
Fixed
- bug #438218 - ValueError: cannot reindex on an axis with duplicate labels
[2.35.4] - 2025-03-31
Fixed
- Report V3 - fix for Fleet Expert Report vs Template Inconsistencies
Changed
smartreport\v3\plot\figures\donut.pychange label order to static
[2.35.3] - 2025-03-26
Fixed
- Report V3 - fix for V3 Enviroment KPIs show No data when gateway == DCP (IoTPanel)
[2.35.2] - 2025-03-25
Fixed
- Report V3 - fix for V3 Fleet Expert Report vs Template Inconsistencies
[2.35.1] - 2025-03-20
Fixed
- Report V3 - fix for Drive Status section and Data Availability subgraph
[2.35.0] - 2025-03-14
Added
- Generic Machine Asset Report V3
[2.34.2] - 2025-03-13
Fixed
- ploty-resampler for large datasets show dots instead of lines in figure
[2.34.1] - 2025-03-13
Fixed
- validation error for AssetDetails serial_number
[2.34.0] - 2025-03-10
Removed
- Energy reports and energy related calculations
[2.33.4] - 2025-03-05
Fixed
- AttributeError: type object 'Report' has no attribute 'NO_HIGHEST_PEAKS'
[2.33.3] - 2025-03-03
Added
- Unit tests to validate all included report variant files.
- Powertrain Raw Data Viewer example script.
Fixed
- Content of
expert_motor_asset_report_variantfile.
[2.33.2] - 2025-03-03
Changed
reportconnectorsupdate to 1.26.2
[2.33.1] - 2025-02-27
Added
- Timestamp based measurement mode for Motor Asset Reports V3
Changed
reportconnectorsupdate to 1.26.1extend_indexfunction account for special timestamp columns if present in the data. This reduces the false positives in the no data detection
Fixed
- Fix one of issue in Bug 423470 - Speed Profile and Speed Trend unit % -> rpm
[2.33.0] - 2025-02-26
Added
get_sensor_detailsmethod to PowertrainAPIAssetDataReader
Changed
reportconnectorsdependency updated to 1.26- PowertrainAPIAssetDataReader updated to rely mostly on PowertrainReportAPIClient
- Powertrain Organization Viewer updated to use only PowertrainReportAPIClient
- example scripts with Powertrain Report generation updated
get_ciam_tokenhelper uses SQLite as a cache
[2.32.0] - 2025-02-14
Added
allow_exceptions=Falseflag added to ReportV3.make_report() method. If set to true, then the report generation fails when the exception is raised
Changed
reportconnectorsdependency updated to >= 1.23.1- Initialization of the Powertrain Asset Data Reader requires CIAM_API_URL environmental variable
- Analytic algorithm results from Powertrain use the
end_timeproperty as an index of results dataframe get_ciam_tokenhelper method updated
[2.31.1] - 2025-02-06
Changed
- Merges changes with hotfix in versions 2.29.15 and 2.29.16
- Changed dependency on CosmosDBClient from deprecated library to new one
- Dependencies reviewed and updated
[2.31.0] - 2025-01-22
Changed
- Local New Condition Indices calculations and reports removed
[2.30.1] - 2025-01-22
Changed
- Long timeseries request are split into smaller chunks to comply with the Timeseries API limits
- Data availability calculation logic for report is mocked until the valid implementation is provided
[2.30.0] - 2025-01-21
This release introduces the Powertrain API support for all new reports. New data reader is added to support the Powertrain API data source. Also, new data models are added to simplify the report generation process and match the Powertrain API data structure.
The new reports are not compatible anymore with old readers and data models.
Added
- V3 readers:
- PowertrainAPIDataReader
- V3 data models:
- Asset
- Fleet
- ConditionIndexResults
- Support for Python 3.11
Changed
- V3 reports use the new data models
- V3 reports targets the Powertrain data source
[2.29.17] - 2025-04-02
Fixed
- bug #438218 - ValueError: cannot reindex on an axis with duplicate labels
[2.29.16] - 2025-02-04
Fixed
- bug #423795 - Read data from dedicated SmartSensor API endpoints: /Sensor/Details and /Asset/Property
[2.29.15] - 2025-01-30
Added
- plotly-resampler dependency, used for downsampling large datasets in plots
[2.29.14] - 2025-01-21
Changed
- Fix for ValueError: add warning
[2.29.13] - 2025-01-21
Changed
- Fix for ValueError: cannot reindex on an axis with duplicate labels
[2.29.12] - 2024-11-12
Changed
- Fix for Exception when additional kwargs are passed to the report
[2.29.11] - 2024-11-12
Changed
- Fix for magnitude difference for same frequencies observed in MS-R expert report
[2.29.10] - 2024-10-24
Changed
- Fix for Failed report generation - log: broken_rotor_bar.py 'NoneType' and 'float'
[2.29.9] - 2024-10-18
Changed
- Remove Smart Sensor links from reports
[2.29.8] - 2024-10-01
Changed
- Fix for Drive Asset Report - donut not visible if no data available
[2.29.7] - 2024-09-25
Changed
- Fix checking data availability for new / v3 drive reports
[2.29.6] - 2024-09-25
Changed
- Fix : Value error in Measurement Report
[2.29.5] - 2024-09-20
Changed
- Fix : Magnitude difference for same frequencies observed in MS-R expert report
[2.29.4] - 2024-09-05
Changed
- Fix ValueError: No objects to concatenate in aggregated_scatter
- Remove fleet_reliability_rul and fleet_reliability_rrd
[2.29.3] - 2024-09-02
Changed
- Fix ValueError: No objects to concatenate in aggregate
[2.29.2] - 2024-08-20
Changed
- Changed pydantic to v2.7.4 (2024-06-12)
- RUL removed
- Fix old links to documentation
[2.29.1] - 2024-06-05
Changed
- Renamed MACHSense-R to Machine Guardian
Fixed
- unit-tests using
np.alltrue
[2.29.0] - 2024-05-09
Changed
- Limited number of event types on a single plot in drive reports
Fixed
- Legend of timeline plots for New Drive Fleet report
- Legend of timeline plots in Operating Time section of New Fleet report
[2.28.0] - 2024-04-12
Added
- Example script for drive data availability calculation
Changed
- Improved data availability calculation for Drive Reports:
- Don't include environmental stress data when the environmental sensor is missing
- Change the data frame availability formula to
number of_documents_with_any_data/number_of_expected_documents
Fixed
- Signal profile data parsing in CMD API data reader
[2.27.1] - 2024-03-06
Changed
- reportconnectors dependency changed to >= 1.11
Fixed
- Phase angle section of MachSense-R report
[2.27.0] - 2024-02-14
Added
- Use data from SmartSensor API as a source of bearing info in reports
Fixed
- Bug #339441 - Error while prefetching data from MachSense-R assets
[2.26.1] - 2024-01-05
Fixed
- Bug #311711 - Incorrect unit, VoltageTrend for ACS800
%as unit instead ofV
[2.26.0] - 2024-01-04
Added
- New Drive Fleet report. Detailed expert and instant variants.
make_cmd_drive_analysisexample script, that creates analysis of drive available at CMD data sourceget_fleet_detailmethod added to DriveFleetget_drive_detailmethod added to DriveAsset
Changed
- New Drive Asset report updated with UX recommendations
- Updated dependencies for
drivekpis>=0.2andreportconnectors>=1.10 - V3 plots moved to
smartreport.v3.plot - Drive related definitions moved to
smartreport.datatypes.drive
[2.25.3] - 2024-01-02
Changed
- Implemented UX recommendations for the new motor fleet report
Fixed
- Bug #329120 - Environmental data missing for 2 assets in (old) drive fleet reports
[2.25.2] - 2023-11-29
Changed
- Reports V3 - all possible legend elements are visible on timeline plots
Fixed
- Bug #323370 - Invalid data availability results New Fleet Motor reports
[2.25.1] - 2023-11-16
Changed
- 'Marketplace' mentions removed from the Motor Fleet Report
[2.25.0] - 2023-11-13
Changed
- Improvements to waterfall plot in MACHsense-R report
Fixed
- Bug #310556 - Missing Environmental Water Conditions plots (drive reports)
[2.24.0] - 2023-10-20
Changed
- Updated dependencies: Pandas > 2, Pydantic > 2
[2.23.1] - 2023-10-06
Fixed
- Bug #311722 - Invalid data availability results for non-standard sensor measurement interval
[2.23.0] - 2023-09-29
Changed
- MACHSense-R Report improvements
- LongTermTrend index algorithm adjustments
Fixed
- Bug #308761 - Motor Fleet report fails when there assets with single datapoint in Trend kpi
- Duplicated data from drive analytics algorithms
[2.22.0] - 2023-08-18
Added
get_sensor_sampling_periodmethod to SmartSensor Asset- unit tests for new Drive Asset Reports
Changed
- Refactor the
distibution_by_thresholdmethod in Trend. It is now based on index deltas - Trend upsampling is based on the sensor sampling period for SmartSensor Assets
- Data availability calculations respect the sensor sampling period
[2.21.1] - 2023-08-10
Fixed
- Drive Reports:
- URLs should point to the Powertrain portal
- Event comments should only be present in the expert variant
[2.21.0] - 2023-08-04
Added
- Drive Asset report based on new Drive KPIs
- Plot functions for new reports
- Plot section documentation
- Automatic expert comments in events section of Expert drive report
Changed
- MACHsense-R report content update
Fixed
- Handling edge cases for thresholds
[2.20.0] - 2023-07-20
Added
- Overview variant for New Motor Fleet Report.
[2.19.0] - 2023-07-18
Changed
- Drive expert report content aligned
check_data_availabilitymethods returnDataAvailabilityResults- Logging mechanism improved in V3 reports
[2.18.4] - 2023-07-10
Changed
- V3 Fleet report health signals section refactored
- V3 Fleet report operating time section refactored
Fixed
- MACHsense-R report scatter plot
- V3 reports naming
[2.18.3] - 2023-07-04
Added
- Script for new condition indices generation
Changed
- V3 Fleet report refactored
- V3 docs updated
Fixed
- Pydantic version locked to <2.0
[2.18.2] - 2023-06-22
Added
- Health signals overview section in new fleet report
- Offline devices section in new fleet report
Fixed
- Naming convention in energy calculation
- Event texts wrapping
- Data availability calculation edge cases
- MACHsense-R report trend handling
- Donut plots in Drive Fleet report
[2.18.1] - 2023-06-14
Changed
- List of available Motor KPIs
- Source of
Peak to PeakKPI used by reports V3
[2.18.0] - 2023-06-14
Added
- New Motor Fleet Report additional sections.
- Data availability calculation methods for each data reader type
- Data availability check methods for each report type
Changed
- Dependencies updated
- RawDataCollectorAPIClient from reportconnectors is used for communication with RawDataCollector
- Data prefetching is moved from
generate_reportmethod to separate methodprefetch_datafor all report types - When dealing with efficiency values % are always used
- Removed obsolete Asset methods related to Cosmos-DB caching
-
Removed
regreasing adviceKPI from MotorAsset report logic
Fixed
- Datetimes handling of CMD API data.
- RUL plots naming in Drive Fleet report
- Moving average plots in Drive Fleet report
- Trends handling in Drive reports based on CMD API
[2.17.1] - 2023-04-28
Fixed
- Plot condition indices with subplots don't break the report when there is no data
- Raw signals section formatting
[2.17.0] - 2023-04-27
Added
- Report V3 New standard for defining the report structure, generation flow, and report variants. Check
V3section in docs. - New Motor Asset Report added. Based on Report V3 approach.
- First draft of new Motor Fleet Report. Based on Report V3 approach.
- Support for translations.
Changed
enginesubmodule extracted fromreports. It includes Report Output, Dash and translations.- Anomaly detection support removed from the codebase. SmartSensor assets no longer have anomaly detection methods.
- Path building is done using pathlib.
Fixed
- Trend names in Drive Fleet Reports
[2.16.0] - 2023-04-11
Added
- Support for compressors application in Energy Efficiency VSD reports
include_raw_dataflag in SmartSensor asset reports
Changed
- Scatter creation logic for Drive Expert reports
Fixed
- Missing constants for Drive Fleet report
- PDF conversion related bugs: missing fonts, ToC and hyperlink styling.
- Drive reliability table
- Line chart in drive multiasset stress section
- Test pipelines reporting in Azure DevOps
[2.15.0] - 2023-03-21
Added
- Graphical components for new motor reports
- Load-Unload profile detection for compressor application in energy reports (not yet used in the report)
Changed
- Updates for Energy Efficiency Reports
- Improved unit handling
- Improved report's static text
- Improved performance of fetching motor data for all organization
- Updates for MACHsense-R report
- Improved plots behaviour
- Used custom dpeaks algorithm to find spectra peaks
- Refactored code structure after SonarCube analysis
- Removed support for Python 3.7
- New layout and structure of the documentation pages.
Fixed
- Bug #245297 (Unhandled error in empty report)
- Bug #248122 (Invalid frequency when creating empty Trend)
- Drive Asset Instant report generation using CMD API
[2.14.1] - 2023-01-24
Fixed
- Correct static texts in Energy Efficiency Asset Report (section for VSD upgrade)
[2.14.0] - 2023-01-24
Added
- Support for fan application in VSD upgrade reports
- Support for multi-threaded tests execution
- load_type field to AssetValidationResult
- Support for custom titles in all report types
Changed
- Project organization changed
- Build system is based on pyproject.toml
- Enabled keyword arguments in each report section creation function
- reportconnectors updated to 1.4.0
Fixed
- Energy consumption estimation for very low flows
- Displaying of missing data from SmartSensor
- Drive details table column names
- Unit test configurations
[2.13.0] - 2022-12-06
Added
- Test cases to compare CosmosDB and CMD API based Drive Reports
Changed
- MACHsense-R report updated to the alpha version
- reportconnectors updated to 1.3.0
- smartanalytics updated to 0.10.0
Fixed
- Measurement mode parameter support for all asset report types
- Status calculation for BearingAsset
- Threshold calculation based on dataframes with Drive KPIs
[2.12.0] - 2022-11-28
Added
- Generic Machine Asset Report v1
- Support for custom report title and subtitle
- Support for dynamic scaling of raw data signal plots
Changed
- APIAssetDataReader depends on SmartSensorAPIClient from reportconnectors
- reportconnectors dependency updated to >= 1.2
- smartsensorapiclient dependency deprecated
- datatypes.asset divided into submodules per asset type
Fixed
- Bug #221816: Random unit test failures due to hypothesis timeouts
- Bug #233234: Add retry policy for SonarQube analysis
[2.11.0] - 2022-11-10
Added
- Report anonymization
Changed
- MACHsense-R report revision
- Regression and unit test moved to separate folders under
/tests - Raw data tables and plots reviewed and extended
- Condition indices table will not be displayed when there is nothing to show
Fixed
- Regression tests procedure
- Bug #229202: Incorrect power integration over time
- Bug #228232: Cutting value after comma in energy reports
[2.10.0] - 2022-11-02
Added
- Alpha version of MachSense-R Report
Fixed
- Bug #228997 (Motor Fleet Report generation failing)
[2.9.1] - 2022-10-21
Fixed
- Bug #227926 (filter_running_only function generates error on smartreports 2.9.0)
- Bug #220565 (Sorting in energy detailed fleet reports tables)
[2.9.0] - 2022-10-20
Added
- Upgrade to VSD section for Energy Asset report (for pumps application).
Fixed
- Bug #220611 (Condition Indices are unnecessarily resampled)
- Report engine regression tests
[2.8.0] - 2022-10-07
Added
- Possibility to generate drive reports from CMD API.
- New drive data reader that uses CmdAPIClient.
- Support for imperial unit standard in energy reports.
- Automatic SonarQube code analysis in test pipeline.
Changed
- Drive Expert Report. Events timestamp in now in UTC.
- Energy Reports. Static text updated in analysis section.
- Energy Reports. Energy saving calculation update in "Upgrade to VSD" variant of the report.
Removed
- Pump Analysis section from Drive Report.
- Pump Assets from Fleet Report.
Fixed
- Bug #225295 (Negative energy savings)
[2.7.0] - 2022-09-15
Added
- New type of Energy Fleet Detailed Report: Upgrade to VSD Control
Fixed
- Bug #220868 (Pump VSD upgrade report (fleet overview) has huge total energy mismatch compared to Motor energy efficiency fleet report)
- Bug #206257 (Dash callback error in Asset Report reports)
[2.6.0] - 2022-09-02
Added
- Support for NEMA standard to Energy Reports
- New type of Energy Fleet Overview Report: Upgrade to VSD Control
Changed
- Split energy report validation rules into 3 sets: IEC upgrade, NEMA upgrade, upgrade to VSD control
- Removed unused drive data validation pipeline and associated code
- Improved handling of assets with load = 0 in Energy Asset Report
Fixed
- Bug #217961 (Fix unstable test
test_create_no_trend_data_report[word])
[2.5.0] - 2022-08-04
Added
- Initial support for NEMA standard (not yet integrated into reports)
Changed
- Example generation scripts for Smart Sensor reports are using cache by default
- Empty pages handling in Drive Asset reports
Fixed
- Bug #200359 (WCU limits in the report should be dynamic, shall be applied read from parameter backup)
- Bug #213821 (SmartSensor reports always have an "Expert ..." title, no matter what is the mode of the report)
- Bug #211333 (Incorrect axis names in Drive reports)
- Missing tables in Drive Multi-asset reports
[2.4.0] - 2022-07-08
Added
- Support for Python versions: 3.8 and 3.9
- Automatically generated documentation based on docs folder and docstrings.
- Method add_pictures added to a ReportOutput interface a standard way to add pictures
- Method add_figures added to a ReportOutput interface a standard way to add figures
- Dedicated event filtering in Drive Report for LCI drives
- Table of Content support for Dash Reports
Changed
- Energy Appraisal Report texts' reviewed
- Refactor of ReportOutput interface
- Parameter column_widths add_table method supports values in percents
- All reports updated to:
- use the add_figures method to add figures to the report
- use percent values in column_widths input parameter to add_table method
- use a consistent version of the add_toc method
- control the style of tables by style property
- JSON ReportOutput is now fully compatible with the ReportOutput interface
- Updates for Motor Model™:
- fix formula for total losses (add rotor copper losses and remove duplicated calculation of stray losses)
- correct the TMEIC formula for stray losses
- improve iron losses to contain a contribution from all load-independent losses
- Plot titles in the reports are rendered using custom text style instead of Heading 4
Fixed
- Bug #197217 (Fix condensation risk thresholds)
- Bug #196850 (Error while exporting Raw data to CSV)
- Code improvements that silence a lot of NumPy and pandas warnings
[2.3.1] - 2022-06-22
Fixed
- Bug #210864 (Fix handling of missing quality flag in SmartSensor KPI data)
[2.3.0] - 2022-06-10
Added
- Count of assets with wrong nameplates to energy fleet reports
Changed
- Updated pipelines, so now package is tested against python 3.7, 3.8 and 3.9
Fixed
- Bug #208833 (AssetType empty structure is not supported in smartreports)
- Bug #208980 (Urgency matrix legend shows at most 8 asset names while there are 10 assets on the plot)
[2.2.2.0] - 2022-05-25
Added
- New asset validation rule: Valid Efficiency
- Support for LCI drive type in Drive Report
Fixed
- Water conductivity units in Drive Report
[2.2.1.1] - 2022-05-25
Added
- RNG constant seed for some tests with random data
- Additional unit tests for dash reports
Changed
- Changes for drives reports:
- DC-Link maximum value to Supply voltage maximum
- DC-Link minimum value to Supply Voltage minimum
- Vdc to Usupply
Fixed
- Bug 197217 (correct condensation thresholds)
- Bug 197641 (correct relative humidity threshold)
- Bug 207404 (correct calculation of minimal efficiencies of IEC motors)
[2.2.1.0] - 2022-05-16
Added
- Support for multi column layout
- Support for single word report template
- Additional unit tests for plot layouts
- Additional test cases for report engine regression tests
Changed
- Extended condition indices documentation
- Executive summary in Energy Fleet Overview report is now using 2-column layout
- Improved consistency between title section look for dash and Word reports
Fixed
- Bug #204905 (visible in Energy Fleet reports)
- Bug #204580
- Bug #205587
- Typo in Energy Asset report efficiency section summary table
[2.2.0.1] - 2022-04-25
Added
- Adjusted energy reports (asset, fleet detailed, fleet overview) to newest mockups
- UML diagram for calculation flow in energy efficiency reports
- Initial regression tests for report engine
Fixed
- Issue in Energy Fleet reports, where elements with value "0" were displayed on the donut (bug #204316)
[2.2.0.0] - 2022-04-20
Added
- New plot layout implementation for Plotly
Changed
- Plots used in the reports updated according to the UX guidelines
Fixed
- Cumulative saving aggregation in energy reports
[2.1.1.0] - 2022-04-19
Changed
- Drive Instant Report sections are not shown when the data is missing
Fixed
- correct calculation of mean efficiency in energy reports
[2.1.0.2] - 2022-04-04
Fixed
- Bugfix for default energy fleet report
[2.1.0.1] - 2022-04-01
Fixed
- Bugfixes for energy fleet report
[2.1.0.0] - 2022-03-31
Added
- New condition indices algorithms for non-motor asset types
- First version of documentation
Changed
- Drive Instant Asset Report simplification
- Energy Asset and Fleet Reports update
- Dependencies upgraded to latest versions
- TrendsDF and Trends structures extended
Fixed
- Integration over time rules for energy reports
- Calculation of fleet apparent power in energy reports
[2.0.8.0] - 2022-03-16
Changed
- Threshold crossing index extended for other asset types.
- plotly version updated
Fixed
- API regression scripts
- quality flag logs
- sensor type asset validation rule
- sustainability report bugs:
- input power sum function
- energy saving after motor replacement formula
[2.0.7.0] - 2022-02-07
Added
- Asset validation mechanism
- Validation rules for sustainability reports
Changed
- Improved asset details fetching from SmartSensor API
- Improved assets listing in Organization structure
- Formatting of first page in Fleet Report
- Minor improvements to Sustainability Fleet Report
[2.0.6.0] - 2022-01-28
Added
- Support for intermediate KPI download
- Scripts to generate pumps anomalies
Fixed
- on_off_trend calculation for pumps
- Color palette for drive fleet reports (bug #194279)
- Issue in Measurements Report generation due to wrong validation in calculate_pole_pairs_no function
Changed
- Replaced usage of np.isnan with pd.isna (pd.isna is correctly handling None values)
[2.0.5.0] - 2021-12-16
Added
- Drive Instant Multi-asset Report
Changed
- Example for Raw Data automatic collection via RawDataCollector
Fixed
- Units for data from Audio Sensor
[2.0.4.0] - 2021-12-13
Added
- Pump anomaly reports
Fixed
- Changed ambient temperature name to air temperature name in drive reports
- Remove redundant trends prefetching in Condition Indices Fleet reports
- Fix units in voltage vs torque plot in drive fleet report
Changed
- Improve SmartIndexJSONEncoder used to serialize python objects to json
[2.0.3.1] - 2021-11-25
Added
- Date to aggregated trend plot hover template
- Method for calculation of motor slip in [rpm]
Fixed
- Issue in report generation when None was provided as a ci_client
- All output files are now encoded in "utf-8"
Changed
- Default cache size for trends to 300 [MB]
[2.0.3.0] - 2021-11-23
Added
- Support for Condition Indices from SmartIndex Azure Function
- Loading packages AC530 and AC580 support in Drive Reports
- Asset properties validation script for Energy reports
Fixed
- Cusum unit tests
[2.0.2.0] - 2021-11-09
Changed
- Asset ID is always converted to integer on initialization of Asset object
- Typing improvement
- Get Threshold logic for calculated trends
Fixed
- Drive Reports:
- Event Matrix
- Charging and Start up counters
- Reference signal for HW Temperature Anomaly
- Logging in Condition Indices calculation
[2.0.1.0] - 2021-11-02
Added
- JSON serialization of Condition Indices models
- Support for SmartSensor quality flags
Changed
- Unify interface for getting last timestamp from condition indices models
- Raw data collection scripts in examples
Fixed
- Imperial unit handling for Raw Data section in asset reports
- Bearing status calculation
- Drive report bug fixed
- Drive report event matrix colors
[2.0.0.1] - 2021-10-13
Changed
- Speed-up of phase calculation in frequency domain plots
- Condition indices report visual improvements
[2.0.0.0] - 2021-10-11
Added
- Trend caching mechanism in Asset Data Reader
- Trends pre-fetching in all SmartSensor based reports
- New Examples:
- Trend detection indices with details
- Drive Asset Report based on Mongo DB drive data client
- New version of SmartSensorAPIClient used (0.6.1):
- Auto retry on timeout errors
- Handling multiple trends requests longer than 90d limit
- Unit test for full report generation process; all report types and all output types
Removed
- Dependency on Matplotlib; this includes removing plot/matplotlib module
Changed
- Data Readers are not initialized with asset_id, but the Asset objects are
- THIS BREAKS THE COMPATIBILITY WITH OLD REPORT SCRIPTS
- BearingDB refactored to class
- Whole codebase auto-format with Black
- Whole codebase lint with Flake8
- Calculation and trend modifying methods are always returning an instance of Trend
- Drive Report updates:
- Stress sections
- Nameplate details table
Fixed
- Handling infinite values in environmental scatter plots
- Speed editing for SSHH raw data plots in dash report
- Snapshot creation for measurement with invalid timestamp
[1.11.6.1] - 2021-09-30
Fixed
- Word template file for Energy expert support added
[1.11.6.0] - 2021-09-30
Added
- Energy Fleet Report
- Energy Fleet Overview Report
- Support for MongoDB based connector for drive data
Fixed
- Bearing Index calculation in New Condition Indices
[1.11.5.0] - 2021-09-21
Added
- Condition Indices Section in Motor Asset Report
- Example scripts for raw data collection via Portal and Collector
- Unit tests for multiple plot types
Changed
- StdEstimator used in Condition Indices is made asymptotically unbiased
- Last values display in RUL tables in Drive Reports
- Fault and reset info in availability table in drive Reports
- Bearing Condition index handling for Condition Index Calculation
Fixed
- Running Pump trend calculation
- Pump's master motor speed handling
- Handling no events case in Drive Asset Report
- KPI Matrix plots for Drive Fleet Report
- Cell merging in Drive Table Monthly Generator
- Water temperature thresholds in Drive Asset Report
[1.11.4.0] - 2021-08-27
Added
- Condition Indices:
- Advanced Analytics Index
- Drive Reports:
- Product name in Nameplate Details table
- Introduction text in Environmental Stress sections
- Support for inverted Thresholds
Changed
- Drive Report:
- Event details table look improved
- Ambient Conditions thresholds handling
Fixed
- Axis mapping for CoMo based Raw data
- Data coping from Dash tables
- Drive Report:
- Threshold consistency on various plots
- Temperature and humidity plots consistency
- Profile trends look
[1.11.3.0] - 2021-08-18
Added
- SmartSensorAPIClient updated to 0.6
- Automatic token refresh
- Smart Threshold calculations
- Support for caching asset data & measurements
- Score combiner formula
Changed
- Excel file format used for Fleet Reports
- Time unit handling in dount graphs
- Drive Report RUL tables
- Drive Report Event details table
- API request test suite
- Asset reference period calculation
Fixed
- Anomaly table percentage display
- Condition indices report bugs
- Drive Report bugs
- Threshold consistency on various plots
- Power consumption chart
- Temperature and humidity plots consistency
- Profile trends look
[1.11.2.0] - 2021-07-30
Added
- Condition indices fleet reports
- First three condition indices:
- Threshold crossing index
- Long term trend index
- Short term trend index
Changed
- Table legend style (currently used only in drive fleet report)
- Plot title to "Daily voltage peak to peak" in scatter vs voltage section of drive asset report
[1.11.1.1] - 2021-07-29
Removed
- reportconnectors dependency
[1.11.1.0] - 2021-07-22
Added
- Peak detection algorithm
Changed
- Environmental plots for Drive Report cleaned-up
- Y-labels and titles of Drive Report cleaned-up
- Colors used in wear-out charts in Drive Report
Fixed
- Parsing a CSV file with a single column of data
- Handling of small values in donut plot used in Drive Report
- Anomaly preprocessing unit tests
- Data filtering for motor not running when using imperial unit standard
[1.11.0.3] - 2021-07-13
Fixed
- Edit Speed pop-up in dash reports opening for all types of measurements
[1.11.0.2] - 2021-07-06
Changed
- in Energy Reports: allowed using efficiency class estimation coefficients for nameplate power outside the range suggested in specification
- updated SmartSensorAPI version - auth with external token is fixed
[1.11.0.1] - 2021-07-05
Fixed
- type checks in circuit parameters calculations
[1.11.0.0] - 2021-07-02
Added
- First version of energy report for motor asset
- First version of energy report for fleet of assets
- Support for imperial unit standard in Raw Data signals
Changed
- SmartSensorAPI client has support for fetch_files flag
- Source of Drive Asset name property updated
Fixed
- Handling of null measurement points when creating KPI trend
- Hover text for KPI matrix plot
- Dynamic threshold slowness
[1.10.4.2] - 2021-06-28
Changed
- Column names used for Drive Reports
- Drive Fleet Report default section order
- Environmental, RUL and Reliability Tables logic
- ROC trends changed into aggregated trends in Drive Reports
Fixed
- Voltage table logic for Drive Fleet Report
[1.10.4.1] - 2021-06-23
Fixed
- Limit handling in Trend plots
- Allow adding unlimited numbers of drives in Drive Fleet
[1.10.4.0] - 2021-06-22
Added
- Water environment section added to Drive Fleet Report
- SmartSensor API request testing
- Donut graph added to Availability plots in Drive Fleet Report
- Support for small font size in Word Reports Tables
- Support for text wrapping in Dash Reports Tables
- Support for Drive Fleet filtering based on Drive asset properties
Changed
- Drive Tables generation refactored
- Drive Event tables look refreshed
Fixed
- Minor bugs in drive reports
[1.10.3.0] - 2021-06-15
Added
- New sections in Drive Fleet Reports
Changed
- Mouse scroll zoom disabled in Dash Reports
- plotting function for scatter graphs changed to ScatterGL
Fixed
- Color handling in Drive Fleet Reports
- Text position in Drive Reports graphs
- report generation warnings when processing all nans data
[1.10.2.0] - 2021-06-08
Added
- MultiAsset Drive Report
Fixed
- processing Speed Control nameplate details for motor assets
[1.10.1.0] - 2021-05-20
Added
- First version of Drive Fleet Report
- DriveFleet class
- Legend tables support
Changed
- nameplate details access for drives
- plotly plot functions for aggregated trends, environmental scatters and scatters refactored
- plotly layout figure handling refactored
[1.10.0.3] - 2021-05-11
[1.10.0.2] - 2021-05-11
Fixed
- missing rows added to nameplate details section in pump asset report
[1.10.0.1] - 2021-05-07
Added
- support for new sensor types in raw data section
Changed
- smart sensor asset properties are based on assetPropertyType from now
- nameplate details for motor and pumps are reviewed and updated
[1.10.0.0] - 2021-04-27
Changed
- dependencies reviewed and update to the latest versions
- unit tests excluded from the package
- drive events table limited in size
- new endpoint used to get the raw data
Fixed
- drive asset report bugs
- dash table filtering issues
- anomaly section behaviour with imperial unit standard
[1.9.11.1] - 2021-04-23
Changed
- limit of rows in word table set to 100 by default
[1.9.11.0] - 2021-04-19
Added
- unit standard support for asset properties
Changed
- SmartSensor KPI ID type changed to string
Fixed
- calculation of stresses and statuses in imperial unit standard
- line cutting in drive scatter plot
- method to determine if drive DataFrame is empty
- display of short headings in TOC
- units used in asset details tables in Fleet Reports
[1.9.10.2] - 2021-04-18
Changed
- default minimum sampling frequency filtering for SSHH
[1.9.10.1] - 2021-03-18
Changed
- plot matrix display updated
[1.9.10.0] - 2021-03-17
Added
- water condition section added to drive reports
- new first page picture in instant drive asset report
- color-bar in drive scatter plots
- drive data validation pipelines
Changed
- new version of smartanalytics
- new version of driveapiclient
- power consumption section logic updated in drive reports
- updated list of sections for expert and instant drive reports
- environmental scatter plots refactored
- report titles and first page pictures refreshed
- static and dynamic text in raw data section
Fixed
- driftage plot in anomaly section of instant asset report
- overall anomaly plot in anomaly section of instant asset report
- missing data handling in drive report sections
- pump bearing frequencies handling in raw data sections
[1.9.9.0] - 2021-02-26
Added
- drive reports can be build based on external json
- drive reports are separated into instant and expert types
- scatter plots for Drives with supply loading package (Current based)
- support for different loading packages and cooling types in drive reports
- raw data section tests
Changed
- events table loading speed improved
- scatter plot look refreshed
Fixed
- missing data handling in drive report sections
[1.9.8.2] - 2021-02-16
Added
- start and end date validation for drive asset
Fixed
- plot event matrix support for inconsistent date formats
[1.9.8.1] - 2021-02-16
Fixed
- report.definitions changed into module
[1.9.8.0] - 2021-02-16
Changed
- refactored measurement speed calculation
- extract asset report sections to separate methods (introduction, equipment view, trends, scatter plots, time domain vib signals, vib velocity spectra, vib envelope spectra, mag spectra, anomaly, recommendations)
- use extracted section in asset reports (motor, pump, bearing) and measurement report
- updated KPI definitions based on data from SS API
- optimized scatter plot data retrieval from CosmosDB
- extract sections from the drive report into separate methods
- use the latest version of SmartAnalytics library
Added
- unit tests for drive events table
- Snapshot class to get information on KPIs (name, value, unit, timestamp) closest to selected timestamp
- snapshot section in asset reports
- start and end dates validation in asset
- histogram plotting function
- unit tests for drive report sections
- handling SSHH raw data in asset report and measurement report
Fixed
- phase angle calculations in callbacks
- drive asset export to word
[1.9.7.1] - 2021-01-28
Changed
- move drive DataFrame column names to definition file
Added
- unit test for drive availability table
- unit tests for drive reliability tables
Fixed
- drive_rul_table nan handling
[1.9.7.0] - 2021-01-26
Changed
- split KPI anomalies plot into two subplots
- split Overall anomalies plot into two subplots
- PointWiseMultivariateAnomaly to provide reference and analysis data separately
- PointWiseAnomaly (from smartanalytics) to provide reference and analysis data separately
- Drive report structure and components
- display of found anomalies (table instead of plain text)
Added
- unit tests for report components (text, tables, plots, aggregated trends)
- unit tests for drive tables
- unit tests for drive data connectivity
- unit tests for nameplates details handling
- events time plot for drive reports
- CHANGELOG.md file
Fixed
- handling of missing data in drive report
[1.9.6.4] - 2020-12-13
Fixed
- Validate nominal power in motor anomaly calculation
[1.9.6.3] - 2020-12-11
Added
- Hyperlink support for static text
- No data plots when data is missing
- Executive summary for Drive Asset report
- Dropdown filters for table data in interactive reports
Changed
- Update fist page pictures in fleet and motor reports
- Update introduction text in fleet report
- Update Drive Asset report layout
- Use new csv format for raw data
Fixed
- Automatic recommendations for motors
- Handle spectra display when speed cannot be calculated
- Handle module in Measurement report
- Handle special characters in table cells
Removed
- DataBricks dependency
[1.9.6.0] - 2020-12-03
Added
- Handle multiple plots in single row
- Grid-based subplots
Changed
- Refactor anomaly detection
[1.9.5.0] - 2020-12-02
Added
- Drive Asset report
Changed
- Start using plotly as default Word plotting engine
[1.9.4.8] - 2020-10-22
Added
- Handle Pumps in fleet report