Skip to content

SmartSensor Fleet

smartreport.v3.reports.smartsensor.fleet.sections.connectivity_status.ConnectivityStatusSection

Bases: SmartSensorFleetReportSection

Section containing table with connection status per device list. The table contains information about the site name, asset name, sensor serial number, gateway status, gateway/sensor type, last activity on and gateway identifier.

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.smartsensor.fleet.sections.fleet_alarms.FleetAlarmsSection

Bases: SmartSensorFleetReportSection

Section containing assets segmentation and fleet overview.

Settings

Bases: Settings

Attributes:

Name Type Description
MAX_ASSETS_IN_FIGURE int

max number of timelines displayed on one figure

smartreport.v3.reports.smartsensor.fleet.sections.fleet_details.FleetDetailsSection

Bases: SmartSensorFleetReportSection

Section containing table with fleet details. That includes optional header and the table with the site details.

Settings

Bases: Settings

Attributes:

Name Type Description
SHOW_HEADER bool

If True, the section will show a main header.

smartreport.v3.reports.smartsensor.fleet.sections.fleet_overview.FleetOverviewSection

Bases: SmartSensorFleetReportSection

Section containing fleet overview table.

Settings

Bases: Settings

Attributes:

Name Type Description
NO_DATA_MARK str

Mark or text that is displayed in value field whenever there is no data.

USE_TIMEDELTA bool

If True, the report will use a time delta to calculate the start date for the fleet overview section data. Otherwise, the report will use the start date of the report. Default value is False.

TIMEDELTA timedelta

Time delta used to calculate the start date for condition index results data. We are only interested in the last values of the condition index results, so we can query for the most recent data. Default value is 12 hours.

smartreport.v3.reports.smartsensor.fleet.sections.health_signals_overview.HealthSignalsOverviewSection

Bases: SmartSensorFleetReportSection

Section containing table filled with listed assets that have at least one Condition Index in Yellow or Red state.

Assets in the table are sorted by urgency, which is calculated as the sum of urgency indicators for each CI. The default logic is to count Yellow as 1 point and Red as 2 points, but it can be changed is section settings.

Settings

Bases: Settings

Attributes:

Name Type Description
TIMEDELTA timedelta

Time delta used to calculate the start date for condition index results data. We are only interested in the last values of the condition index results, so we can query for the most recent data. Default value is 12 hours.

URGENCY_MAP Dict[ConditionIndexState, int]

Mapping of condition index states to urgency values.

smartreport.v3.reports.smartsensor.fleet.sections.introduction.IntroductionSection

Bases: SmartSensorFleetReportSection

Introduction section containing paragraph with 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.

ADD_PAGE_BREAK bool

If True, a page break is added after the introduction section.

smartreport.v3.reports.smartsensor.fleet.sections.operating_time_overview.OperatingTimeOverviewSection

Bases: SmartSensorFleetReportSection

Section containing information about operating time of organization's motors.

Settings

Bases: Settings

Attributes:

Name Type Description
EXPERTS_COMMENTS_PLACEHOLDER str

Text displayed as a placeholder in comment boxes.

smartreport.v3.reports.smartsensor.fleet.sections.recommendations.RecommendationsSection

Bases: SmartSensorFleetReportSection

Section containing recommendations. For each asset where one of chosen parameters indicates alarm or warning small table with listed parameters is created. Below each table there is space for expert's comments.

Settings

Bases: Settings

Attributes:

Name Type Description
ADD_PAGE_BREAK bool

If True, a page break is added after the recommendations section.

smartreport.v3.reports.smartsensor.fleet.sections.report_overview_table.ReportOverviewTableSection

Bases: SmartSensorFleetReportSection

Section containing report overview table.

Settings

Bases: Settings

Attributes:

Name Type Description
REPORT_TIME Optional[datetime]

Date of report generation. If empty, then the utcnow is used.

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