Add another steptype for requirements and get them from config.

Author: tsterbak

openandroidinstaller/app_state.py

@@ -66,6 +66,6 @@ def load_config(self, device_code: str):
     def increment_progressbar(self):
         """Increment the progressbar and step counter."""
         self.progressbar.value = (self.num_steps - 1) / (
-            self.num_total_steps + 2
+            self.num_total_steps + 3
         )  # don't show on the first step
         self.num_steps += 1  # increase the step counter

openandroidinstaller/assets/configs/sargo.yaml

@@ -2,6 +2,8 @@ metadata:
   maintainer: Tobias Sterbak (tsterbak)
   devicename: Pixel 3a
   devicecode: sargo 
+requirements:
+  android: 12.1.0
 steps:
   unlock_bootloader:
     - type: confirm_button

openandroidinstaller/assets/configs/starlte.yaml

@@ -2,6 +2,8 @@ metadata:
   maintainer: Tobias Sterbak (tsterbak)
   devicename: Samsung Galaxy S9
   devicecode: starlte
+requirements:
+  android: 10
 steps:
   unlock_bootloader:
   flash_recovery:

openandroidinstaller/assets/configs/z3.yaml

@@ -2,6 +2,8 @@ metadata:
   maintainer: Tobias Sterbak (tsterbak)
   devicename: Sony Xperia Z3
   devicecode: z3 
+requirements:
+  firmware: 23.5.A.1.291
 steps:
   unlock_bootloader:
     - type: confirm_button

openandroidinstaller/installer_config.py

@@ -49,11 +49,13 @@ def __init__(
         flash_recovery: List[Step],
         install_os: List[Step],
         metadata: dict,
+        requirements: dict,
     ):
         self.unlock_bootloader = unlock_bootloader
         self.flash_recovery = flash_recovery
         self.install_os = install_os
         self.metadata = metadata
+        self.requirements = requirements
 
     @classmethod
     def from_file(cls, path):
@@ -64,6 +66,7 @@ def from_file(cls, path):
                     config = dict(raw_config)
                     raw_steps = config["steps"]
                     metadata = config["metadata"]
+                    requirements = config.get("requirements", None)
                 else:
                     logger.info("Validation of config failed.")
                     return None
@@ -86,7 +89,9 @@ def from_file(cls, path):
             Step(**raw_step, title="Install OS")
             for raw_step in raw_steps.get("install_os", [])
         ]
-        return cls(unlock_bootloader, flash_recovery, install_os, metadata)
+        return cls(
+            unlock_bootloader, flash_recovery, install_os, metadata, requirements
+        )
 
 
 def _load_config(device_code: str, config_path: Path) -> Optional[InstallerConfig]:
@@ -139,6 +144,10 @@ def validate_config(config: str) -> bool:
                 "devicename": str,
                 "devicecode": str,
             },
+            schema.Optional("requirements"): {
+                schema.Optional("android"): str,
+                schema.Optional("firmware"): str,
+            },
             "steps": {
                 "unlock_bootloader": schema.Or(None, [step_schema]),
                 "flash_recovery": [step_schema],

openandroidinstaller/openandroidinstaller.py

@@ -38,15 +38,15 @@
     icons,
 )
 from loguru import logger
-from views import SelectFilesView, StepView, SuccessView, WelcomeView
+from views import SelectFilesView, StepView, SuccessView, WelcomeView, RequirementsView
 from tool_utils import run_command
 
 # where to write the logs
 logger.add("openandroidinstaller.log")
 
 # Toggle to True for development purposes
-DEVELOPMENT = False
-DEVELOPMENT_CONFIG = "yuga"  # "a3y17lte"  # "sargo"
+DEVELOPMENT = True
+DEVELOPMENT_CONFIG = "z3"  # "a3y17lte"  # "sargo"
 
 
 PLATFORM = sys.platform
@@ -75,16 +75,20 @@ def __init__(self):
         self.view = Column(expand=True, width=1200)
 
         # create default starter views
-        welcome = WelcomeView(
+        welcome_view = WelcomeView(
             on_confirm=self.confirm,
             state=self.state,
         )
-        select_files = SelectFilesView(
+        requirements_view = RequirementsView(
+            on_confirm=self.confirm,
+            state=self.state,
+        )
+        select_files_view = SelectFilesView(
             on_confirm=self.confirm,
             state=self.state,
         )
         # ordered to allow for pop
-        self.default_views = [select_files, welcome]
+        self.default_views = [select_files_view, requirements_view, welcome_view]
         # create the final success view
         self.final_view = SuccessView(state=self.state)
 
@@ -124,7 +128,7 @@ def log_version_infos(bin_path):
     """Log the version infos of adb, fastboot and heimdall."""
     # adb
     adbversion = [line for line in run_command("adb", ["version"], bin_path)]
-    adbversion = '\n'.join(adbversion[:1])
+    adbversion = "\n".join(adbversion[:1])
     logger.info(f"{adbversion}")
     # fastboot
     fbversion = [line for line in run_command("fastboot", ["--version"], bin_path)]
@@ -137,7 +141,7 @@ def log_version_infos(bin_path):
 def main(page: Page):
     logger.info(f"Running OpenAndroidInstaller on {PLATFORM}")
     log_version_infos(bin_path=BIN_PATH)
-    logger.info(20*"-")
+    logger.info(100 * "-")
     # Configure the application base page
     page.title = "OpenAndroidInstaller"
     page.window_height = 780

openandroidinstaller/views.py

@@ -67,7 +67,9 @@ class BaseView(UserControl):
     def __init__(self, state: AppState, image: str = "placeholder.png"):
         super().__init__()
         self.state = state
+        # right part of the display, add content here.
         self.right_view = Column(expand=True)
+        # left part of the display: used for displaying the images
         self.left_view = Column(
             width=600,
             controls=[Image(src=f"/assets/imgs/{image}")],
@@ -81,6 +83,140 @@ def __init__(self, state: AppState, image: str = "placeholder.png"):
         )
 
 
+class RequirementsView(BaseView):
+    """View to display requirements and ask for confirmation."""
+
+    def __init__(
+        self,
+        state: AppState,
+        on_confirm: Callable,
+    ):
+        super().__init__(state=state)
+        self.on_confirm = on_confirm
+
+    def build(self):
+        self.continue_button = ElevatedButton(
+            "Continue",
+            on_click=self.on_confirm,
+            icon=icons.NEXT_PLAN_OUTLINED,
+            disabled=True,
+            expand=True,
+        )
+
+        # build up the main view
+        self.right_view.controls.extend(
+            [
+                get_title("Check the Requirements"),
+                Text(
+                    "Before continuing you need to check some requirements to progress. Please read the instructions and check the boxes if everything is fine."
+                ),
+                Divider(),
+            ]
+        )
+        self.checkboxes = []
+
+        def enable_continue_button(e):
+            """Enable the continue button if all checkboxes are ticked."""
+            for checkbox in self.checkboxes:
+                if not checkbox.value:
+                    logger.info(checkbox)
+                    self.continue_button.disabled = True
+                    return
+            logger.info("All requirements ticked. Allow to continue")
+            self.continue_button.disabled = False
+            self.right_view.update()
+
+        # check if there are additional requirements given in the config
+        if self.state.config.requirements:
+            # android version
+            required_android_version = self.state.config.requirements.get("android")
+            if required_android_version:
+                android_checkbox = Checkbox(
+                    label="The required android version is installed. (Or I know the risk of continuing)",
+                    on_change=enable_continue_button,
+                )
+                android_version_check = Column(
+                    [
+                        Markdown(
+                            f"""
+#### Android Version {required_android_version}:
+Before following these instructions please ensure that the device is currently using Android {required_android_version} firmware.
+If the vendor provided multiple updates for that version, e.g. security updates, make sure you are on the latest!
+If your current installation is newer or older than Android {required_android_version}, please upgrade or downgrade to the required
+version before proceeding (guides can be found on the internet!).
+                    """
+                        ),
+                        android_checkbox,
+                    ]
+                )
+                self.checkboxes.append(android_checkbox)
+                self.right_view.controls.append(android_version_check)
+
+            # firmware version
+            required_firmware_version = self.state.config.requirements.get("firmware")
+            if required_firmware_version:
+                firmware_checkbox = Checkbox(
+                    label="The required firmware version is installed. (Or I know the risk of continuing)",
+                    on_change=enable_continue_button,
+                )
+                firmware_version_check = Column(
+                    [
+                        Markdown(
+                            f"""
+#### Firmware Version {required_firmware_version}:
+Before following these instructions please ensure that the device is on firmware version {required_firmware_version}.
+To discern this, you can run the command `adb shell getprop ro.build.display.id` on the stock ROM.
+If the device is not on the specified version, please follow the instructions below to install it.
+                    """
+                        ),
+                        firmware_checkbox,
+                    ]
+                )
+                self.checkboxes.append(firmware_checkbox)
+                self.right_view.controls.append(firmware_version_check)
+
+        # default requirements: battery level
+        battery_checkbox = Checkbox(
+            label="The battery level is over 80%.",
+            on_change=enable_continue_button,
+        )
+        battery_version_check = Column(
+            [
+                Markdown(
+                    f"""
+#### Battery level over 80%
+Before continuing make sure your device battery level is above 80%.
+            """
+                ),
+                battery_checkbox,
+            ]
+        )
+        self.checkboxes.append(battery_checkbox)
+        self.right_view.controls.append(battery_version_check)
+
+        # default requirement: disable lock code and fingerprint
+        lock_checkbox = Checkbox(
+            label="No lock code or fingerprint lock enabled.",
+            on_change=enable_continue_button,
+        )
+        lock_check = Column(
+            [
+                Markdown(
+                    f"""
+#### Disable all device lock codes and fingerprint locks.
+            """
+                ),
+                lock_checkbox,
+            ]
+        )
+        self.checkboxes.append(lock_checkbox)
+        self.right_view.controls.append(lock_check)
+
+        # add the final confirm and continue button
+        self.right_view.controls.append(Row([self.continue_button], alignment="center"))
+        return self.view
+
+
 class WelcomeView(BaseView):
     def __init__(
         self,