apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi Class Reference

Render automotive contract updates in a simple terminal dashboard. More...

Inheritance diagram for apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi:

Public Member Functions
bool	initialize (self)
	Create resources and leave the frontend ready to run.
None	shutdown (self)
	Release frontend resources; repeated calls must be safe.
None	set_gear (self, Gear|None gear)
	Set the currently engaged gear.
None	set_vehicle_speed (self, float|None speed_mps)
	Set vehicle speed.
None	set_engine_speed (self, float|None engine_speed_rad_s)
	Set engine angular speed.
None	set_fuel_level (self, float|None fuel_level_ratio)
	Set fuel level.
None	set_throttle_position (self, float|None throttle_position_ratio)
	Set throttle position.
None	set_accelerator_position (self, float|None accelerator_position_ratio)
	Set accelerator-pedal position.
None	set_engine_load (self, float|None engine_load_ratio)
	Set calculated engine load.
None	set_coolant_temperature (self, float|None coolant_temperature_k)
	Set engine coolant temperature.
None	set_intake_air_temperature (self, float|None intake_air_temperature_k)
	Set intake-air temperature.
None	set_manifold_pressure (self, float|None manifold_pressure_pa)
	Set manifold absolute pressure.
None	set_barometric_pressure (self, float|None barometric_pressure_pa)
	Set ambient barometric pressure.
None	set_boost_pressure (self, float|None boost_pressure_pa)
	Set boost pressure relative to atmosphere.
None	set_mass_air_flow (self, float|None mass_air_flow_kg_s)
	Set engine mass air flow.
None	set_control_voltage (self, float|None control_voltage_v)
	Set vehicle control-module voltage.
None	set_ambient_temperature (self, float|None ambient_temperature_k)
	Set the outside ambient temperature.
None	set_engine_oil_temperature (self, float|None engine_oil_temperature_k)
	Set the engine oil temperature.
None	set_engine_oil_pressure (self, float|None engine_oil_pressure_pa)
	Set the engine oil pressure.
None	set_transmission_temperature (self, float|None transmission_temperature_k)
	Set the transmission-fluid temperature.
None	set_odometer (self, float|None distance_m)
	Set the vehicle's lifetime distance.
None	set_trip_distance (self, float|None distance_m)
	Set the current trip distance.
None	set_estimated_range (self, float|None distance_m)
	Set the estimated remaining driving range.
None	set_instantaneous_fuel_consumption (self, float|None fuel_consumption_m3_per_m)
	Set instantaneous fuel volume consumed per distance.
None	set_average_fuel_consumption (self, float|None fuel_consumption_m3_per_m)
	Set average fuel volume consumed per distance.
None	set_fuel_used (self, float|None fuel_volume_m3)
	Set fuel consumed during the current trip.
None	set_tire_pressure (self, TirePosition position, float|None pressure_pa)
	Set one tire's pressure.
None	set_tire_temperature (self, TirePosition position, float|None temperature_k)
	Set one tire's temperature.
None	set_tire_pressure_warning (self, TirePosition position, bool|None active)
	Set one tire's pressure-warning state.
None	set_opening_state (self, VehicleOpening opening, bool|None is_open)
	Set whether one door or panel is open.
None	set_seat_belt_state (self, SeatPosition seat, bool|None fastened)
	Set whether one seat belt is fastened.
None	set_exterior_light_state (self, ExteriorLight light, bool|None active)
	Set whether one exterior light function is active.
None	set_parking_brake (self, bool|None applied)
	Set the parking-brake state.
None	set_connection_state (self, VehicleConnectionState|None state)
	Set or clear the vehicle connection state.
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.
None	run (self)
	Run the terminal UI until the user requests shutdown.

Detailed Description

Render automotive contract updates in a simple terminal dashboard.

Member Function Documentation

initialize()

bool apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.initialize

(

self

)

Create resources and leave the frontend ready to run.

Returns

True when initialization succeeds.

Reimplemented from ui.ui_if.UiIf.

set_accelerator_position()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_accelerator_position	(		self,
		float | None	accelerator_position_ratio
	)

Set accelerator-pedal position.

Parameters

accelerator_position_ratio

Position from 0.0 through 1.0, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_ambient_temperature()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_ambient_temperature	(		self,
		float | None	ambient_temperature_k
	)

Set the outside ambient temperature.

Parameters

ambient_temperature_k

Temperature in kelvin, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_average_fuel_consumption()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_average_fuel_consumption	(		self,
		float | None	fuel_consumption_m3_per_m
	)

Set average fuel volume consumed per distance.

Parameters

fuel_consumption_m3_per_m

Cubic metres per metre, or None.

Reimplemented from ui.automotive.vehicle_trip_ui_if.VehicleTripUiIf.

set_barometric_pressure()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_barometric_pressure	(		self,
		float | None	barometric_pressure_pa
	)

Set ambient barometric pressure.

Parameters

barometric_pressure_pa

Pressure in pascals, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_boost_pressure()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_boost_pressure	(		self,
		float | None	boost_pressure_pa
	)

Set boost pressure relative to atmosphere.

Parameters

boost_pressure_pa

Relative pressure in pascals, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_connection_state()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_connection_state	(		self,
		VehicleConnectionState | None	state
	)

Set or clear the vehicle connection state.

Parameters

state

Current connection state, or None when unavailable.

Reimplemented from ui.automotive.vehicle_connection_ui_if.VehicleConnectionUiIf.

set_control_voltage()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_control_voltage	(		self,
		float | None	control_voltage_v
	)

Set vehicle control-module voltage.

Parameters

control_voltage_v

Voltage in volts, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_coolant_temperature()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_coolant_temperature	(		self,
		float | None	coolant_temperature_k
	)

Set engine coolant temperature.

Parameters

coolant_temperature_k

Temperature in kelvin, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_diagnostics_request_handler()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_diagnostics_request_handler	(		self,
		DiagnosticsRequestHandlerIf | None	handler
	)

Set or clear the diagnostics request handler.

Parameters

handler

Request handler, or None to disconnect it.

Reimplemented from ui.automotive.vehicle_diagnostics_ui_if.VehicleDiagnosticsUiIf.

set_emissions_readiness()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_emissions_readiness	(		self,
		bool | None	ready
	)

Set whether all supported emissions monitors are ready.

Parameters

ready

Readiness state, or None when unavailable.

Reimplemented from ui.automotive.vehicle_diagnostics_ui_if.VehicleDiagnosticsUiIf.

set_engine_load()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_engine_load	(		self,
		float | None	engine_load_ratio
	)

Set calculated engine load.

Parameters

engine_load_ratio

Engine load from 0.0 through 1.0, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_engine_oil_pressure()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_engine_oil_pressure	(		self,
		float | None	engine_oil_pressure_pa
	)

Set the engine oil pressure.

Parameters

engine_oil_pressure_pa

Pressure in pascals, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_engine_oil_temperature()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_engine_oil_temperature	(		self,
		float | None	engine_oil_temperature_k
	)

Set the engine oil temperature.

Parameters

engine_oil_temperature_k

Temperature in kelvin, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_engine_speed()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_engine_speed	(		self,
		float | None	engine_speed_rad_s
	)

Set engine angular speed.

Parameters

engine_speed_rad_s

Engine speed in radians per second, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_estimated_range()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_estimated_range	(		self,
		float | None	distance_m
	)

Set the estimated remaining driving range.

Parameters

distance_m

Estimated range in metres, or None.

Reimplemented from ui.automotive.vehicle_trip_ui_if.VehicleTripUiIf.

set_exterior_light_state()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_exterior_light_state	(		self,
		ExteriorLight	light,
		bool | None	active
	)

Set whether one exterior light function is active.

Parameters

light	Exterior light function whose state changed.
active	Active state, or None when unavailable.

Reimplemented from ui.automotive.vehicle_body_ui_if.VehicleBodyUiIf.

set_fuel_level()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_fuel_level	(		self,
		float | None	fuel_level_ratio
	)

Set fuel level.

Parameters

fuel_level_ratio

Fuel level from 0.0 through 1.0, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_fuel_used()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_fuel_used	(		self,
		float | None	fuel_volume_m3
	)

Set fuel consumed during the current trip.

Parameters

fuel_volume_m3

Fuel volume in cubic metres, or None.

Reimplemented from ui.automotive.vehicle_trip_ui_if.VehicleTripUiIf.

set_gear()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_gear	(		self,
		Gear | None	gear
	)

Set the currently engaged gear.

Parameters

gear	Current gear, or None when unavailable.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_instantaneous_fuel_consumption()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_instantaneous_fuel_consumption	(		self,
		float | None	fuel_consumption_m3_per_m
	)

Set instantaneous fuel volume consumed per distance.

Parameters

fuel_consumption_m3_per_m

Cubic metres per metre, or None.

Reimplemented from ui.automotive.vehicle_trip_ui_if.VehicleTripUiIf.

set_intake_air_temperature()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_intake_air_temperature	(		self,
		float | None	intake_air_temperature_k
	)

Set intake-air temperature.

Parameters

intake_air_temperature_k

Temperature in kelvin, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_malfunction_indicator()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_malfunction_indicator	(		self,
		bool | None	active
	)

Set the malfunction-indicator-lamp state.

Parameters

active

Active state, or None when unavailable.

Reimplemented from ui.automotive.vehicle_diagnostics_ui_if.VehicleDiagnosticsUiIf.

set_manifold_pressure()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_manifold_pressure	(		self,
		float | None	manifold_pressure_pa
	)

Set manifold absolute pressure.

Parameters

manifold_pressure_pa

Absolute pressure in pascals, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_mass_air_flow()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_mass_air_flow	(		self,
		float | None	mass_air_flow_kg_s
	)

Set engine mass air flow.

Parameters

mass_air_flow_kg_s

Mass flow in kilograms per second, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_odometer()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_odometer	(		self,
		float | None	distance_m
	)

Set the vehicle's lifetime distance.

Parameters

distance_m

Lifetime distance in metres, or None.

Reimplemented from ui.automotive.vehicle_trip_ui_if.VehicleTripUiIf.

set_opening_state()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_opening_state	(		self,
		VehicleOpening	opening,
		bool | None	is_open
	)

Set whether one door or panel is open.

Parameters

opening	Door or panel whose state changed.
is_open	Open state, or None when unavailable.

Reimplemented from ui.automotive.vehicle_body_ui_if.VehicleBodyUiIf.

set_parking_brake()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_parking_brake	(		self,
		bool | None	applied
	)

Set the parking-brake state.

Parameters

applied

Applied state, or None when unavailable.

Reimplemented from ui.automotive.vehicle_body_ui_if.VehicleBodyUiIf.

set_seat_belt_state()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_seat_belt_state	(		self,
		SeatPosition	seat,
		bool | None	fastened
	)

Set whether one seat belt is fastened.

Parameters

seat	Seat whose belt state changed.
fastened	Fastened state, or None when unavailable.

Reimplemented from ui.automotive.vehicle_body_ui_if.VehicleBodyUiIf.

set_throttle_position()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_throttle_position	(		self,
		float | None	throttle_position_ratio
	)

Set throttle position.

Parameters

throttle_position_ratio

Position from 0.0 through 1.0, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_tire_pressure()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_tire_pressure	(		self,
		TirePosition	position,
		float | None	pressure_pa
	)

Set one tire's pressure.

Parameters

position	Tire whose pressure changed.
pressure_pa	Pressure in pascals, or None when unavailable.

Reimplemented from ui.automotive.vehicle_tire_ui_if.VehicleTireUiIf.

set_tire_pressure_warning()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_tire_pressure_warning	(		self,
		TirePosition	position,
		bool | None	active
	)

Set one tire's pressure-warning state.

Parameters

position	Tire whose warning state changed.
active	Warning state, or None when unavailable.

Reimplemented from ui.automotive.vehicle_tire_ui_if.VehicleTireUiIf.

set_tire_temperature()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_tire_temperature	(		self,
		TirePosition	position,
		float | None	temperature_k
	)

Set one tire's temperature.

Parameters

position	Tire whose temperature changed.
temperature_k	Temperature in kelvin, or None when unavailable.

Reimplemented from ui.automotive.vehicle_tire_ui_if.VehicleTireUiIf.

set_transmission_temperature()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_transmission_temperature	(		self,
		float | None	transmission_temperature_k
	)

Set the transmission-fluid temperature.

Parameters

transmission_temperature_k

Temperature in kelvin, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

set_trip_distance()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_trip_distance	(		self,
		float | None	distance_m
	)

Set the current trip distance.

Parameters

distance_m

Trip distance in metres, or None.

Reimplemented from ui.automotive.vehicle_trip_ui_if.VehicleTripUiIf.

set_trouble_codes()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_trouble_codes	(		self,
		Sequence[DiagnosticTroubleCode]	trouble_codes
	)

Replace the complete displayed trouble-code collection.

Parameters

trouble_codes

Current diagnostic trouble codes.

Reimplemented from ui.automotive.vehicle_diagnostics_ui_if.VehicleDiagnosticsUiIf.

set_vehicle_speed()

None apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi.set_vehicle_speed	(		self,
		float | None	speed_mps
	)

Set vehicle speed.

Parameters

speed_mps

Vehicle speed in metres per second, or None.

Reimplemented from ui.automotive.vehicle_ui_if.VehicleUiIf.

---

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

• apps/demos/automotive/automotive_demo_ui.py