OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
ui.automotive.vehicle_diagnostics_ui_if.VehicleDiagnosticsUiIf Class Reference

Display diagnostics and connect diagnostic request handling. More...

Inheritance diagram for ui.automotive.vehicle_diagnostics_ui_if.VehicleDiagnosticsUiIf:
apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel ui.automotive.vehicle_diagnostics_ui_stub.VehicleDiagnosticsUiStub

Public Member Functions

None set_malfunction_indicator (self, bool|None active)
 Set the malfunction-indicator-lamp state.
 
None set_trouble_codes (self, Sequence[DiagnosticTroubleCode] trouble_codes)
 Replace the complete displayed trouble-code collection.
 
None set_emissions_readiness (self, bool|None ready)
 Set whether all supported emissions monitors are ready.
 
None set_diagnostics_request_handler (self, DiagnosticsRequestHandlerIf|None handler)
 Set or clear the diagnostics request handler.
 

Detailed Description

Display diagnostics and connect diagnostic request handling.

Member Function Documentation

◆ set_diagnostics_request_handler()

None ui.automotive.vehicle_diagnostics_ui_if.VehicleDiagnosticsUiIf.set_diagnostics_request_handler (   self,
DiagnosticsRequestHandlerIf | None  handler 
)

Set or clear the diagnostics request handler.

Parameters
handlerRequest handler, or None to disconnect it.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_diagnostics_ui_stub.VehicleDiagnosticsUiStub.

◆ set_emissions_readiness()

None ui.automotive.vehicle_diagnostics_ui_if.VehicleDiagnosticsUiIf.set_emissions_readiness (   self,
bool | None  ready 
)

Set whether all supported emissions monitors are ready.

Parameters
readyReadiness state, or None when unavailable.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_diagnostics_ui_stub.VehicleDiagnosticsUiStub.

◆ set_malfunction_indicator()

None ui.automotive.vehicle_diagnostics_ui_if.VehicleDiagnosticsUiIf.set_malfunction_indicator (   self,
bool | None  active 
)

Set the malfunction-indicator-lamp state.

Parameters
activeActive state, or None when unavailable.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_diagnostics_ui_stub.VehicleDiagnosticsUiStub.

◆ set_trouble_codes()

None ui.automotive.vehicle_diagnostics_ui_if.VehicleDiagnosticsUiIf.set_trouble_codes (   self,
Sequence[DiagnosticTroubleCode]  trouble_codes 
)

Replace the complete displayed trouble-code collection.

Parameters
trouble_codesCurrent diagnostic trouble codes.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_diagnostics_ui_stub.VehicleDiagnosticsUiStub.


The documentation for this class was generated from the following file: