SmartSensor Asset
smartreport.v3.reports.smartsensor.asset.sections.asset_details.AssetDetailsSection
Bases: AssetReportSection
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
DEFAULT_ASSET_PROPERTY |
str
|
Default asset property symbol that is displayed when asset property value is not found. |
smartreport.v3.reports.smartsensor.asset.sections.data_trends.DataTrendsSection
Bases: AssetReportSection
Adds data trends section to the report.
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
SYMBOLIC_NAMES |
List[str | List[str]]
|
List of KPI IDs that defines trends to be displayed in the KPI trends section. It should be provided as a list of strings. Default depends on the report type. |
FIGSIZE |
Tuple[int, int]
|
Proportions of a graph figure used to present the trend in the KPI Trends section. It should be provided as a tuple of two integers where the first one represents the width and the second one represents the height of the figure. Default: (12, 5) |
SHOW_THRESHOLD |
bool
|
Allow to show or hide plot's thresholds. |
create(asset)
Creates trends section in asset report. Trends of selected kpis and additional_trends.
smartreport.v3.reports.smartsensor.asset.sections.equipment_view.EquipmentViewSection
Bases: AssetReportSection
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
SYMBOLIC_NAMES |
List[str]
|
List of symbolic names that defines trends to be displayed in the equipment view section. It should be provided as a list of strings. Default depends on the report type. |
INCLUDE_RUNNING_STATUS |
bool
|
If true then the special Running Trend is included to the displayed trends.
Default: |
FIGSIZE |
Tuple[int, int]
|
Proportions of a donut graph figure used to present the trend in the equipment view section.
It should be provided as a tuple of two integers where the first one represents the width
and the second one represents the height of the figure. Default: |
create(asset)
Adds equipment view section to asset report.
Donut graphs for selected kpis and running time if flag include_running_time is set to True.
smartreport.v3.reports.smartsensor.asset.sections.introduction.IntroductionSection
Bases: AssetReportSection
Creates an Asset Report introduction section.
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
INTRODUCTION |
TEXT
|
Custom introduction text to be used. If not provided, then the default text, specific for a given asset type, is used. |
ADD_PAGE_BREAK |
bool
|
If True, a page break is added after the introduction section. |
smartreport.v3.reports.smartsensor.asset.sections.last_week_table.LastWeekTableSection
Bases: AssetReportSection
Adds a section with the table that compares the last week with the current week
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
TIMEDELTA |
timedelta
|
Time delta to compare with. Default is 7 days. |
RESULT_PRECISION |
int
|
Number of decimal places to round the results to. Default is 2. |
smartreport.v3.reports.smartsensor.asset.sections.machine_guardian_programme.MachineGuardianProgrammeSection
Bases: ReportSection
Adds a Machine Guardian programme section main heading
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
IMAGE_ACCEL |
Path
|
Default Accelerometer (vibration) sensor icon |
IMAGE_BOLT |
Path
|
Default Partial discharge sensors icon |
IMAGE_CURRENT |
Path
|
Default Current & voltage sensors icon |
IMAGE_HUMIDITY |
Path
|
Default Humidity Sensor icon |
IMAGE_MAGNET |
Path
|
Default Magnetic flux Sensor icon |
IMAGE_OIL |
Path
|
Default Oil particle wear sensor icon |
IMAGE_TEMPERATURE |
Path
|
Default Temperature Sensor icon |
IMAGE_SLEEVE |
Path
|
Default Sleeve bearing sensor sensor icon |
smartreport.v3.reports.smartsensor.measurement.sections.magnetic_signals.MagneticSignalsSection
Bases: RawDataSignalSection
make_broken_rotor_bars_lines(line_frequency, speed, axis)
classmethod
Makes a vertical lines group for broken rotor bars characteristic frequencies.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
line_frequency
|
float
|
Line frequency in Hz. |
required |
speed
|
float
|
Rotation speed in Hz. |
required |
axis
|
SignalAxis
|
Axis of the signal. |
required |
Returns:
| Type | Description |
|---|---|
SpectrumPointsGroup
|
A group of vertical lines with broken rotor bars characteristic frequencies. |
smartreport.v3.reports.smartsensor.asset.sections.main_findings.MainFindingsSection
Bases: AssetReportSection
Adds table with main findings to the report.
The table contains the main findings of the asset condition indices.
Rows correspond to the symbolic names of the condition indices. Columns correspond to the condition index models: threshold crossing, long term trend detection, short term trend detection.
The table is filled with the last or worst state of the condition index. This is controlled by the SELECTION_MODE setting.
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
SELECTION_MODE |
Literal['last', 'worst']
|
Controls how the condition index state is selected from the timeseries. Can be "last" or "worst". Default is "last". |
build_main_findings_table(ci_results, signal_types, extract_mode='last')
classmethod
Makes the main findings table. It is made from the condition index results.
For each row we take the collection of condition index results timeseries. From these timeseries we extract the value of the threshold crossing index. Depending on the mode: last or worst.
Then we take the worst state of the condition index and display it in the table with the corresponding color and text.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ci_results
|
ConditionIndicesResults
|
Dictionary with condition index results. |
required |
signal_types
|
List[ConditionIndexSignalType]
|
List of signal types to be used to build the table rows. |
required |
extract_mode
|
Literal['last', 'worst']
|
Mode of the extraction. Can be "last" or "worst". Default is "last". |
'last'
|
smartreport.v3.reports.smartsensor.asset.sections.new_condition_indices_combined_plots.NewConditionIndicesCombinedPlotsSection
Bases: AssetReportSection
Adds a section with new condition indices combined plots
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
SYMBOLIC_NAMES |
List[AssetKPI]
|
List of symbolic names to be used in the new condition indices section. |
smartreport.v3.reports.smartsensor.asset.sections.new_condition_indices.NewConditionIndicesSection
Bases: AssetReportSection
Adds a section with new condition indices details
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
SYMBOLIC_NAMES |
List[AssetKPI]
|
List of symbolic names to be used in the new condition indices section. |
smartreport.v3.reports.smartsensor.asset.sections.operating_time_overview.OperatingTimeOverviewSection
Bases: AssetReportSection
Add an overview section with motor's operating time
smartreport.v3.reports.smartsensor.asset.sections.raw_signals.RawSignalsSection
Bases: ReportSection
Adds a Raw data section main heading
smartreport.v3.reports.smartsensor.asset.sections.recommendations.RecommendationsSection
Bases: AssetReportSection
Section containing expert recommendations.
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
ICON_SIZE |
int
|
size of the icon displayed as the urgency icon |
SELECTION_MODE |
Literal['last', 'worst']
|
Controls how the condition index state is selected from the timeseries. Can be "last" or "worst". Default is "last". |
smartreport.v3.reports.smartsensor.asset.sections.report_overview_table.ReportOverviewTableSection
Bases: AssetReportSection
Adds a table with an overview of the asset the report is about and the report itself. It's usually used on the first page of the report.
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
CONTACT_MAIL |
str
|
Contact mail to be used in the table. |
SHOW_SMARTSENSOR_LINK |
bool
|
If true, then the link to asset details in the SmartSensor portal
is added under the table. Default: |
SHOW_POWERTRAIN_LINK |
bool
|
If true, then the link to asset details in the Powertrain portal
is added under the table. Default: |
REPORT_TIME |
Optional[datetime]
|
Date of report generation. If empty, then the |
DEFAULT_VALUE |
str
|
Default symbol that is displayed when property value is not found. |
create(asset)
Adds the Report Overview Table Section. It adds table with asset and report overview, followed by links to asset details page in the portals.
smartreport.v3.reports.smartsensor.asset.sections.scatter_trends.ScatterTrendsSection
Bases: AssetReportSection
Adds scatter trends section to the report.
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
SYMBOLIC_NAMES |
List[str | List[str]]
|
List of KPI IDs that defines trends to be displayed in the KPI trends section. It should be provided as a list of strings. Default depends on the report type. |
FIGSIZE |
Tuple[int, int]
|
Proportions of a graph figure used to present the trend in the KPI Trends section. It should be provided as a tuple of two integers where the first one represents the width and the second one represents the height of the figure. Default: (12, 5) |
SHOW_THRESHOLD |
bool
|
Allow to show or hide plot's thresholds. |
create(asset)
Creates scatter trends section in Motor Machine Guardian asset report. Trends of selected kpis.
smartreport.v3.reports.smartsensor.asset.sections.site_condition.SiteConditionSection
Bases: AssetReportSection
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
DEFAULT_SITE_CONDITION |
str
|
Default site condition property symbol that is displayed when asset property value is not found. |
smartreport.v3.reports.smartsensor.measurement.sections.vibration_signals_bearing_overview.VibrationSignalsBearingOverviewSection
Bases: RawDataSignalSection
This section is used to show the Bearing related analysis of the Acceleration Vibration signals in frequency domain.
Settings
Bases: Settings
SIGNAL_AXIS: The axis of the signal to plot. Default: "axial"
smartreport.v3.reports.smartsensor.measurement.sections.vibration_signals_envelope.VibrationSignalsEnvelopeSection
Bases: RawDataSignalSection
This section is used to show the frequency domain analysis of the envelope of acceleration vibration signals for provided measurements.
Settings
Bases: Settings
SIGNAL_AXIS: The axis of the signal used for analysis. Default: SignalAxis.RADIAL USE_SINGLE_AXIS_ACC: If True, then the data from the single axis accelerometer is used. Default: False BEARING_SIDES: The sides of the bearing to be used for analysis. Default: [SignalSide.DE, SignalSide.NDE] MAX_HARMONICS_FACTOR: The maximum harmonics factor used for analysis. Default: 6 CUT_FREQUENCIES: If True, then the frequencies are cut off. Default: False NUMBER_OF_BEARING_HARMONICS: The number of harmonics to be used for analysis. Default: 3 USE_DPEAKS: If True, then the dpeaks method is used to find magnitudes. Default: True
calculate_threshold_frequencies(bearing_frequencies, speed_frequency, max_harmonics_factor=6.0, no_of_harmonics=3)
classmethod
Calculates the threshold frequencies based on the bearing frequencies and speed frequency. This method computes the minimum sampling frequency, maximum harmonic frequency, and maximum frequency based on the provided parameters.
The results are used to determine the appropriate frequency range for the vibration signal analysis.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bearing_frequencies
|
Dict[SignalSide, BearingFreqData]
|
A dictionary containing bearing frequencies for different sides. |
required |
speed_frequency
|
Optional[float]
|
The speed frequency of the machine. If None, returns default ThresholdFrequencies. |
required |
max_harmonics_factor
|
float
|
The factor to multiply the maximum harmonic frequency. Default is 6.0. |
6.0
|
no_of_harmonics
|
int
|
The number of harmonics to consider. Default is 3. |
3
|
Returns:
| Type | Description |
|---|---|
ThresholdFrequencies
|
An object containing the calculated minimum sampling frequency, maximum frequency, and maximum harmonic frequency. |
make_bearing_harmonics_points_groups(bearing_frequencies, speed_frequency, spectrum, side, no_of_harmonics=3, use_dpeaks=True)
classmethod
Creates a list of vertical lines groups for the bearing harmonics based on the provided bearing frequencies, speed frequency, spectrum, and side of the bearing.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bearing_frequencies
|
Dict[SignalSide, BearingFreqData]
|
A dictionary containing bearing frequencies for different sides. |
required |
speed_frequency
|
Optional[float]
|
The speed frequency of the machine. If None, returns an empty list. |
required |
spectrum
|
RawDataSignalSpectrum
|
The spectrum of the signal. |
required |
side
|
SignalSide
|
The side of the bearing for which the harmonics are calculated. |
required |
no_of_harmonics
|
int
|
The number of harmonics to consider for each bearing frequency. Default is 3. |
3
|
use_dpeaks
|
bool
|
If True, uses the dpeaks method to find magnitudes. Default is True. |
True
|
Returns:
| Type | Description |
|---|---|
List[SpectrumPointsGroup]
|
A list of SpectrumPointsGroup objects, each containing points for the harmonics of the bearing frequencies. |
smartreport.v3.reports.smartsensor.measurement.sections.vibration_signals_fft.VibrationSignalsFFTSection
Bases: RawDataSignalSection
This section is used to show the frequency domain velocity vibration signals for provided measurements.
Settings
Bases: Settings
ADD_SLIDER: If True, then the speed-adjusting slider is added to the interactive report document. Default: True
CUT_OFF_HIGH: The high cut-off frequency for the signal [Hz]. Default: 1000.0
FILTER_ORDER: The order of the filter used for signal filtering. Default: 3
DYNAMIC_CUT_OFF_HIGH: The dynamic cut-off frequency for the signal. Default: 0.025
HARD_CUT_OFF_HIGH: The hard cut-off frequency for the signal [Hz]. Default: None
MINIMUM_SAMPLING_FREQUENCY: The minimum sampling frequency for the signal to be plotted [Hz]. Default: 300.0
PEAKS_CUT_OFF_LOW: The low cut-off frequency for the peak detection [Hz]. Default: 10.0
SIGNAL_CUT_OFF_LOW: The low cut-off frequency for the signal [Hz]. Default: 10.0
USE_SINGLE_AXIS_ACC: If True, then the data from the single axis accelerometer is used. Default: False
NUMBER_OF_HIGHEST_PEAKS: Number of highest peaks to show in the table and plot. Default: 5
VELOCITY_SPECTRA_LIMIT: The limit for the velocity spectra in Hz. Default: 1000.0
USE_DPEAKS: If True, then the DPeaks algorithm is used for peak detection. Default: True
TITLE: Title of the section. Default Frequency domain vibration velocity signals
INCLUDE_PHASE: If True, then the phase is included in the frequency table. Default: False
smartreport.v3.reports.smartsensor.measurement.sections.vibration_signals_time.VibrationSignalsTimeSection
Bases: RawDataSignalSection
This section is used to show the time domain Acceleration Vibration signals for provided measurements.
Settings
Bases: Settings
ADD_AUDIO_PLAYER: If True, then the audio player is added to the interactive report. Default: False FIGSIZE: The size (aspect ratio) of the figure. Default: (11, 3) NUMBER_OF_Y_TICKS: The number of ticks on the Y axis. Default: 5 Y_RANGE_FACTOR: The factor used to calculate the Y axis range. Default: 1.05 MINIMUM_SAMPLING_FREQUENCY: The minimum sampling frequency [Hz] for the signal to be plotted. Default: 300.0
make_speed_and_line_frequency_table(speed_hz, line_frequency)
classmethod
Creates a table data with speed and line frequency.
The table has two columns. The first row contains the names of the parameters (Speed and LF) and the second row contains the values of the parameters.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
speed_hz
|
Optional[float]
|
Speed in Hz. |
required |
line_frequency
|
Optional[float]
|
Line frequency in Hz. |
required |
Returns:
| Type | Description |
|---|---|
TableData
|
Table data with speed and line frequency. |
make_vibration_signal_statistics_table(signals, unit_standard=UnitStandard.METRIC)
classmethod
Creates a table data with time domain statistics of the provided signals. Each row in the table corresponds to a signal and each column corresponds to a statistical measure.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
signals
|
Sequence[AccelerationVibrationRawDataSignal]
|
List of AccelerationVibrationRawDataSignal objects. |
required |
unit_standard
|
UnitStandard
|
UnitStandard to use for the velocity RMS unit. Default: UnitStandard.METRIC. |
METRIC
|
Returns:
| Type | Description |
|---|---|
TableData
|
Table data with statistical measures for each signal. |