Add a requirements view to inform and check requirements (#39)

This PR adds:
- another step for checking requirements and get them from config
- restructure the welcome page

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,19 +2,16 @@ metadata:
   maintainer: Tobias Sterbak (tsterbak)
   devicename: Pixel 3a
   devicecode: sargo 
+requirements:
+  android: 12.1.0
 steps:
   unlock_bootloader:
-    - type: confirm_button
+    - type: call_button
       content: >
         As a first step, you need to unlock the bootloader. A bootloader is the piece of software, that tells your phone
         how to start and run an operating system (like Android). Your device should be turned on.
-    - type: call_button
-      content: Press 'Confirm and run' to reboot into the bootloader.
+        Press 'Confirm and run' to reboot into the bootloader.
       command: adb_reboot_bootloader
-    - type: confirm_button
-      content: >
-        Select 'Restart bootloader' on your smartphone screen by pressing the volume button and the confirm by pushing the power button.
-        Then press 'Confirm and continue' here.
     - type: call_button
       content: In this step you actually unlock the bootloader. Just press 'Confirm and run' here. Once it's done, press continue here.
       command: fastboot_unlock
@@ -26,17 +23,14 @@ steps:
       content: To finish the unlocking, the phone needs to reboot. Just press 'Confirm and run' here to reboot. Then continue.
       command: fastboot_reboot
     - type: confirm_button
-      content: The bootloader is now unlocked. Since the device resets completely, you will need to re-enable USB debugging to continue.
+      content: The bootloader is now unlocked. Since the device resets completely, you will need to re-enable Developer Options and USB debugging to continue.
   flash_recovery:
-    - type: confirm_button 
+    - type: call_button
       content: >
         Now you need to flash a custom recovery system on the phone. A recovery is a small subsystem on your phone, that manages updating,
         adapting and repairing of the operating system.
-    - type: call_button
-      content: Once the device is fully booted, you need to reboot into the bootloader again by pressing 'Confirm and run' here. Then continue.
+        Make sure your device is turned on. You need to reboot into the bootloader again by pressing 'Confirm and run' here. Then continue.
       command: adb_reboot_bootloader
-    - type: confirm_button
-      content: Select 'Restart bootloader' on your smartphone screen. Then confirm to continue.
     - type: call_button
       content: Flash a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
       command: fastboot_flash_recovery

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/assets/imgs/requirements-default.png

@@ -23,21 +23,27 @@
 
 
 class Step:
+    """Class representing on step in the installer."""
+
+    default_images = {
+        "Unlock the bootloader": "unlock-bootloader-default.png",
+    }
+
     def __init__(
         self,
         title: str,
         type: str,
         content: str,
         command: str = None,
-        img: str = "placeholder.png",
+        img: str = None,
         allow_skip: bool = False,
         link: str = None,
     ):
         self.title = title
         self.type = type
         self.content = content
         self.command = command
-        self.img = img
+        self.img = img if img else self.default_images.get(title, "placeholder.png")
         self.allow_skip = allow_skip
         self.link = link
 
@@ -49,11 +55,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 +72,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 +95,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 +150,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/assets/imgs/unlock-bootloader-default.png

@@ -18,14 +18,15 @@
 import webbrowser
 from pathlib import Path
 
-import flet
+import flet as ft
 from app_state import AppState
 from flet import (
     AppBar,
     Banner,
     Column,
     Container,
     ElevatedButton,
+    CircleAvatar,
     FloatingActionButton,
     Icon,
     Image,
@@ -38,15 +39,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 = "sargo"  # "a3y17lte"  # "sargo"
 
 
 PLATFORM = sys.platform
@@ -75,16 +76,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 +129,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,10 +142,10 @@ 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
+    page.window_height = 820
     page.window_width = int(1.77 * page.window_height)
     page.window_top = 100
     page.window_left = 120
@@ -213,4 +218,4 @@ def restart_process(e):
     page.add(app)
 
 
-flet.app(target=main, assets_dir="assets")
+ft.app(target=main, assets_dir="assets")

openandroidinstaller/installer_config.py

@@ -159,7 +159,11 @@ def adb_twrp_wipe_and_install(bin_path: Path, target: str, config_path: Path) ->
         if (type(line) == bool) and not line:
             logger.error(f"Wiping {partition} failed.")
             # TODO: if this fails, a fix can be to just sideload something and then adb reboot
-            for line in run_command("adb", ["sideload", str(config_path.parent.parent) + "/helper.txt"], bin_path):
+            for line in run_command(
+                "adb",
+                ["sideload", str(config_path.parent.parent) + "/helper.txt"],
+                bin_path,
+            ):
                 yield line
             sleep(1)
             if (type(line) == bool) and not line:

openandroidinstaller/openandroidinstaller.py

@@ -21,12 +21,12 @@
 
 
 def get_download_link(devicecode: str) -> Optional[str]:
-    """Check if a lineageOS version for this device exists on lineageosroms.com and return the respective download link."""
+    """Check if a lineageOS version for this device exists on download.lineageos.com and return the respective download link."""
     url = f"https://download.lineageos.org/{devicecode.lower()}"
     try:
         logger.info(f"Checking {url}")
         # Get Url
-        res = requests.get(url)
+        res = requests.get(url, timeout=5)
         # if the request succeeds
         if res.status_code == 200:
             logger.info(f"{url} exists.")