Drive Fleet
smartreport.v3.reports.drives.fleet.sections.climatic_conditions.ClimaticConditionsSection
Bases: KPIDriveFleetReportSection
Creates a Drive Fleet Report Climatic Condition KPI details section.
The section is made of introduction text, a timeline plot and recommendations. It is based on the generic solution for KPI details sections.
Details
The section uses add_timeline_plot() method to add a timeline plot to the report. The method takes the following arguments: drive_fleet, kpi_id, title.
First, it reads the data for the given KPI from the DriveFleet, then it cleans the data and enhance it with
data annotations for not supported drives. (only drives with environmental sensors are supported)
Finally, the plot_kpi_timelines function is used to create the plot, which is added to the report document.
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. |
smartreport.v3.reports.drives.fleet.sections.connectivity_status.ConnectivityStatusSection
Bases: DriveFleetReportSection
Section containing table with drive connectivity status.
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
NO_DATA_MARK |
str
|
Character/text displayed when there is no data to be shown |
ONLY_FOR_FRESH_DATA |
bool
|
Boolean flag indicating if the section should be displayed only for fresh data |
smartreport.v3.reports.drives.fleet.sections.current_overload.CurrentOverloadSection
Bases: KPIDriveFleetReportSection
Creates a Drive Fleet Report Current Overload KPI details section.
The section is made of introduction text, a summary table and a timeline kpi plot.
Details
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. |
smartreport.v3.reports.drives.fleet.sections.drive_air_temperature.DriveAirTemperatureSection
Bases: KPIDriveFleetReportSection
Creates a Drive Fleet Report Current Overload KPI details section.
The section is made of introduction text, a summary table and a timeline kpi plot.
Details
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. |
smartreport.v3.reports.drives.fleet.sections.drive_events.DriveEventsSection
Bases: KPIDriveFleetReportSection
Creates a Drive Fleet Report Drive Events KPI details section.
I consists of an introdution text and three sub-sections for each events category: Protection, Operational and Other.
Each sub-section consists of its own introduction text, a timeline plot and recommendations. It is based on the generic solution for KPI details sections.
Details
The section uses add_timeline_plot() method to add a timeline plot to the report. The method takes the following arguments: drive_fleet, kpi_id, title.
First, it reads the data for the given KPI from the DriveFleet, then it cleans the data and enhance it with
data annotations for not supported drives.
Finally, the plot_kpi_timelines function is used to create the plot, which is added to the report document.
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. |
smartreport.v3.reports.drives.fleet.sections.drive_status.DriveStatusSection
Bases: KPIDriveFleetReportSection
Creates a Drive Fleet Report Drive Status KPI details section.
The section is made of introduction text, a timeline plot and recommendations. It is based on the generic solution for KPI details sections.
Details
The section uses add_timeline_plot() method to add a timeline plot to the report. The method takes the following arguments: drive_fleet, kpi_id, title.
First, it reads the data for the given KPI from the DriveFleet, then it cleans the data and enhance it with
data annotations for not supported drives.
Finally, the plot_kpi_timelines function is used to create the plot, which is added to the report document.
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. |
smartreport.v3.reports.drives.fleet.sections.environment_humidity.EnvironmentHumiditySection
Bases: KPIDriveFleetReportSection
Creates a Drive Fleet Report Environment Humidity KPI details section.
The section is made of introduction text, a timeline plot and recommendations. It is based on the generic solution for KPI details sections.
Details
The section uses add_timeline_plot() method to add a timeline plot to the report. The method takes the following arguments: drive_fleet, kpi_id, title.
First, it reads the data for the given KPI from the DriveFleet, then it cleans the data and enhance it with
data annotations for not supported drives. (only drives with environmental sensors are supported)
Finally, the plot_kpi_timelines function is used to create the plot, which is added to the report document.
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. |
create(fleet)
smartreport.v3.reports.drives.fleet.sections.environment_temperature.EnvironmentTemperatureSection
Bases: KPIDriveFleetReportSection
Creates a Drive Fleet Report Environment Temperature KPI details section.
The section is made of introduction text, a timeline plot and recommendations. It is based on the generic solution for KPI details sections.
Details
The section uses add_timeline_plot() method to add a timeline plot to the report. The method takes the following arguments: drive_fleet, kpi_id, title.
First, it reads the data for the given KPI from the DriveFleet, then it cleans the data and enhance it with
data annotations for not supported drives. (only drives with environmental sensors are supported)
Finally, the plot_kpi_timelines function is used to create the plot, which is added to the report document.
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. |
create(fleet)
smartreport.v3.reports.drives.fleet.sections.fleet_details.FleetDetailsSection
Bases: DriveFleetReportSection
Creates a Drive Fleet Report Fleet details section.
The section is made of 4 tables:
- Site details
- Monitoring details
- Operating time overview
- Fleet information
It ends with a page break.
Details
Site details table has two rows: Country and Sites. It shows unique values of these nameplate keys for all assets in the fleet.
Monitoring details table has two rows: Monitoring period and Environmental sensors. Monitoring period shows the start and end date of the report. Environmental sensors shows how many assets have sensors and how many don't.
Operating time overview table has four rows: Number of monitored assets, Number of assets with faults during reporting period, Total fault time for all assets and Total time for which data is unavailable.
Fleet information table has seven rows: Asset name, Type code, Serial number, Cooling type, Commissioning date, Life cycle status and Warranty end. The table has one row per asset in the fleet. Data comes from drive nameplate and drive details (Life cycle status).
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
REMOVE_EMPTY_VALUES |
bool
|
If true, then the table rows with empty values are not displayed. |
make_operating_time_overview_table(fleet)
Returns a table data for operating time overview table. Results are based on Drive status KPI.
smartreport.v3.reports.drives.fleet.sections.introduction.IntroductionSection
Bases: DriveFleetReportSection
Creates a Drive Fleet Report introduction section.
The section is made of a heading and the introduction text.
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. |
smartreport.v3.reports.drives.fleet.sections.kpi_overview.KpiOverviewSection
Bases: CommonKpiOverviewSection
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. |
USE_PRECISE_DRIVE_STATUS |
TEXT
|
If True, the Drive Status KPI will be computed using the seconds-level resolution. |
is_kpi_supported(entity, kpi_id)
Checks if the temperature KPI is supported by the fleet.
smartreport.v3.reports.drives.fleet.sections.power_module_temperature.PowerModuleTemperatureSection
Bases: KPIDriveFleetReportSection
Creates a Drive Fleet Report Power Module Temperature KPI details section.
The section is made of introduction text, a timeline plot and recommendations. It is based on the generic solution for KPI details sections.
Details
The section uses add_timeline_plot() method to add a timeline plot to the report. The method takes the following arguments: drive_fleet, kpi_id, title.
First, it reads the data for the given KPI from the DriveFleet, then it cleans the data and enhance it with
data annotations for not supported drives. (only device types: ACS800, ACS880, ACx580 are supported)
Finally, the plot_kpi_timelines function is used to create the plot, which is added to the report document.
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. |
create(fleet)
smartreport.v3.reports.drives.fleet.sections.recommendations.RecommendationsSection
Bases: DriveFleetReportSection
Creates a Drive Fleet Report Recommendation section.
It is made of the heading, end a textbox for expert comments.
Notes
In future a better interface for providing the recommendations data should be provided.
In the original design document the recommendations are presented as a table with the following columns: Site Name, Asset name, Parameter, Analysis, Urgency, Recommended action.
smartreport.v3.reports.drives.fleet.sections.report_overview_table.ReportOverviewTableSection
Bases: DriveFleetReportSection
Creates a Drive Fleet Report Overview Table section.
This section adds a first page table the following rows:
- Organization name (from fleet details)
- Organization ID (from fleet details)
- Reference no. (user provided)
- Date of report (automatic or user provided)
- Monitoring period (from DriveFleet parameters)
- Number of monitored assets (from DriveFleet parameters)
Settings
Bases: Settings
Attributes:
| Name | Type | Description |
|---|---|---|
REPORT_TIME |
Optional[datetime]
|
Date of report generation. If empty, then the |
SHOW_POWERTRAIN_LINK |
bool
|
If true powertrain portal link will be displayed |
REFERENCE_NO |
str
|
Reference number specific to one particular report, given from reporting portal |
smartreport.v3.reports.drives.fleet.sections.short_asset_names.ShortAssetNamesSection
Bases: KPIDriveFleetReportSection