OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
apps.launchers.streamlit_launcher.StreamlitLauncher Class Reference

Launch a Streamlit server and its kiosk browser. More...

Inheritance diagram for apps.launchers.streamlit_launcher.StreamlitLauncher:
ui.system.app_launcher_if.AppLauncherIf apps.launchers.weather_dash_launcher.WeatherDashLauncher

Public Member Functions

None configure_browser_window (self, *tuple[int, int] position, tuple[int, int] size)
 Align the dashboard browser to a Car UI panel.
 
bool is_running (self)
 Return whether the application is currently running.
 
None launch (self, str remote_display, StatusCallback set_status=None)
 Launch the application for normal presentation.
 
None prepare (self)
 Start the Streamlit server without opening its browser.
 
None stop (self, str remote_display, StatusCallback set_status=None)
 Stop the application.
 
None close_browser (self, str remote_display, StatusCallback set_status=None)
 Close the browser while leaving the Streamlit server warm.
 
bool toggle (self, str remote_display, StatusCallback set_status=None)
 Toggle the application's running state.
 

Detailed Description

Launch a Streamlit server and its kiosk browser.

Member Function Documentation

◆ is_running()

bool apps.launchers.streamlit_launcher.StreamlitLauncher.is_running (   self)

Return whether the application is currently running.

Returns
True when the application is running, otherwise False.

Reimplemented from ui.system.app_launcher_if.AppLauncherIf.

◆ launch()

None apps.launchers.streamlit_launcher.StreamlitLauncher.launch (   self,
str  remote_display,
StatusCallback   set_status = None 
)

Launch the application for normal presentation.

Parameters
remote_displayDisplay identifier used for the application presentation.
set_statusOptional callback used to report launcher status text.

Reimplemented from ui.system.app_launcher_if.AppLauncherIf.

Reimplemented in apps.launchers.weather_dash_launcher.WeatherDashLauncher.

◆ stop()

None apps.launchers.streamlit_launcher.StreamlitLauncher.stop (   self,
str  remote_display,
StatusCallback   set_status = None 
)

Stop the application.

Parameters
remote_displayDisplay identifier associated with the application.
set_statusOptional callback used to report launcher status text.

Reimplemented from ui.system.app_launcher_if.AppLauncherIf.

◆ toggle()

bool apps.launchers.streamlit_launcher.StreamlitLauncher.toggle (   self,
str  remote_display,
StatusCallback   set_status = None 
)

Toggle the application's running state.

Parameters
remote_displayDisplay identifier used for the application presentation.
set_statusOptional callback used to report launcher status text.
Returns
True when the application is running after the toggle, otherwise False.

Reimplemented from ui.system.app_launcher_if.AppLauncherIf.


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