Update config for google pixel 3a; improve rendering of views; add some dirty testing mode for now; fix the progressbar

Author: tsterbak

openandroidinstaller/assets/configs/Pixel 3a.yaml

@@ -1,59 +1,62 @@
 steps:
   - title: "Unlock the bootloader"
     type: confirm_button
-    content: "Turn on your device and wait until its fully booted."
+    content: "As a first step, you need to unlock the bootloader. A bootloader is the piece of software, that tells your phone who to start and run an operating system (like Android). Your device should be turned on."
   - title: "Unlock the bootloader"
     type: call_button
-    content: "Press 'Confirm' to reboot into the bootloader."
+    content: "Press 'Confirm and run' to reboot into the bootloader."
     command: "adb reboot bootloader"
   - title: "Unlock the 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' here."
+    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."
   - title: "Unlock the bootloader"
     type: call_button
-    content: "Unlock the bootloader now:"
+    content: "In this step you actually unlock the bootloader. Just press 'Confirm and run' here. Once it's done, press continue here."
     command: "fastboot flashing unlock"
     allow_skip: True
   - title: "Unlock the bootloader"
     type: confirm_button
     content: "At this point the device may display on-screen prompts which will require interaction to continue the process of unlocking the bootloader. Please take whatever actions the device asks you to to proceed."
   - title: "Unlock the bootloader"
     type: call_button
-    content: "Reboot the phone"
+    content: "To finish the unlocking, the phone needs to reboot. Just press 'Confirm and run' here to reboot. Then continue."
     command: "fastboot reboot"
   - title: "Unlock the bootloader"
     type: confirm_button
     content: "The bootloader is now unlocked. Since the device resets completely, you will need to re-enable USB debugging to continue."
-  - title: "Flash custom recovery"
+  - title: "Flash a custom recovery"
+    type: confirm_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."
+  - title: "Flash a custom recovery"
     type: call_button
-    content: "Once the device is fully booted, reboot into bootloader"
+    content: "Once the device is fully booted, you need to reboot into the bootloader again by pressing 'Confirm and run' here. Then continue."
     command: "adb reboot bootloader"
-  - title: "Flash custom recovery"
+  - title: "Flash a custom recovery"
     type: confirm_button
-    content: "Select 'Restart bootloader' on your smartphone screen. Then confirm"
-  - title: "Flash custom recovery"
+    content: "Select 'Restart bootloader' on your smartphone screen. Then confirm to continue."
+  - title: "Flash a custom recovery"
     type: call_button
-    content: "Flash custom recovery (temporarily)"
+    content: "Flash a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue."
     command: "fastboot flash boot <recovery>"
+  - title: "Flash LineageOS"
+    type: confirm_button 
+    content: "In this step, you finally flash LineageOS. Confirm to continue."
   - title: "Flash LineageOS"
     type: confirm_button
-    content: "Select 'Recovery Mode' on your smartphone screen. Then confirm"
+    content: "Select 'Recovery Mode' on your smartphone screen and press the Start-Button to confirm. Then confirm here."
   - title: "Flash LineageOS"
     type: confirm_button
-    content: "Now tap Factory Reset, then Format data / factory reset and continue with the formatting process. This will remove encryption and delete all files stored in the internal storage, as well as format your cache partition (if you have one)."
+    content: "Now tap Factory Reset, then Format data / Factory reset on your phone screen and continue with the formatting process. This will remove encryption and delete all files stored in the internal storage, as well as format your cache partition (if you have one)."
   - title: "Flash LineageOS"
     type: confirm_button
-    content: "Return to the main menu."
+    content: "Return to the main menu on the phone."
   - title: "Flash LineageOS"
     type: confirm_button
-    content: "On the device, select “Apply Update”, then “Apply from ADB” to begin sideload. Then confirm here"
+    content: "On the device, select “Apply Update”, then “Apply from ADB” to begin sideload. Then confirm here."
   - title: "Flash LineageOS"
     type: call_button
-    content: "Flash lineageOS image. Don't remove the USB-Cable!"
+    content: "Now it's time to flash the LineageOS image. Don't remove the USB-Cable and press 'Confirm and run' to start! Confirm after it's done."
     command: "adb sideload <image>"
   - title: "Flash LineageOS"
     type: confirm_button
-    content: "Flashing finished. Now press 'back' (arrow) and then 'Reboot system now' to finish the installation."
-  - title: "Successfully finished flashing"
-    type: text
-    content: "Have fun with LineageOS!"
+    content: "Flashing finished. Now press 'back' (arrow) and then 'Reboot system now' on the phone screen to finish the installation."

openandroidinstaller/assets/configs/Samsung Galaxy A3 2017.yaml

@@ -21,7 +21,7 @@ steps:
     content: "Return to the previous menu and tap 'Advanced Wipe', then select the 'Cache' and 'System' partitions and then 'Swipe to Wipe'."
   - title: "Flash LineageOS"
     type: confirm_button
-    content: "Now connect the phone to the computer again with the USB-cable. On the device, go back and select “Advanced”, “ADB Sideload”, then swipe to begin sideload. Then confirm here"
+    content: "Now connect the phone to the computer again with the USB-cable. On the device, go back and select “Advanced”, “ADB Sideload”, then swipe to begin sideload. Then confirm here."
   - title: "Flash LineageOS"
     type: call_button
     content: "Flash lineageOS image. Don't remove the USB-Cable!"

openandroidinstaller/openandroidinstaller.py

@@ -1,25 +1,47 @@
 """Main app code for openAndroidInstaller."""
 
-
 from ctypes import alignment
 import webbrowser
-from functools import partial
 from os import path
 from subprocess import STDOUT, CalledProcessError, call, check_output
 from time import sleep
-from turtle import width
-from typing import Callable, List
+from typing import Callable
 
 import flet
-from flet import (AppBar, Banner, Checkbox, Column, Container, Divider,
-                  ElevatedButton, FilePicker, FilePickerResultEvent, Icon,
-                  Image, Page, ProgressBar, ProgressRing, Row, Text,
-                  TextButton, TextField, UserControl, VerticalDivider, colors, FilledButton,
-                  AlertDialog,
-                  icons)
+from flet import (
+    AppBar,
+    Banner,
+    Checkbox,
+    Column,
+    Container,
+    Divider,
+    ElevatedButton,
+    FilePicker,
+    FilePickerResultEvent,
+    Icon,
+    Image,
+    Page,
+    ProgressBar,
+    ProgressRing,
+    Row,
+    Text,
+    TextButton,
+    TextField,
+    UserControl,
+    VerticalDivider,
+    colors,
+    FilledButton,
+    AlertDialog,
+    icons,
+)
 from installer_config import InstallerConfig, Step
 from widgets import call_button, confirm_button, get_title
 
+# Toggle to True for development purposes
+DEVELOPMENT = False 
+DEVELOPMENT_CONFIG = "Pixel 3a"
+
+
 CONFIG_PATH = path.abspath(path.join(path.dirname(__file__), "assets/configs/"))
 IMAGE_PATH = path.abspath(path.join(path.dirname(__file__), "assets/imgs/"))
 
@@ -29,7 +51,10 @@ def __init__(self, image: str = "placeholder.png"):
         super().__init__()
         self.right_view = Column(expand=True)
         self.left_view = Column(
-            width=480, controls=[Image(src=IMAGE_PATH + "/" + image)], expand=True, horizontal_alignment="center",
+            width=480,
+            controls=[Image(src=IMAGE_PATH + "/" + image)],
+            expand=True,
+            horizontal_alignment="center",
         )
         # main view row
         self.view = Row(
@@ -63,7 +88,9 @@ def build(self):
         self.dlg_help_developer_options = AlertDialog(
             modal=True,
             title=Text("How to enable developer options and OEM unlocking"),
-            content=Text("To do this, tap seven times on the build number in the System-Menu in Settings. Then in developer options, toggle OEM unlocking and USB-Debugging."),
+            content=Text(
+                "To do this, tap seven times on the build number in the System-Menu in Settings. Then in developer options, toggle OEM unlocking and USB-Debugging."
+            ),
             actions=[
                 TextButton("Close", on_click=self.close_developer_options_dlg),
             ],
@@ -77,13 +104,22 @@ def build(self):
                 ),
                 Divider(),
                 Text(
-                    "Before you continue, make sure your devices is on the latest system update."
+                    "Before you continue, make sure your devices is on the latest system update. Also make sure you have a backup of all your important data on the phone, since this procedure will erase all data from the phone. Note, that vendor specific back-ups might not work on LineageOS!"
                 ),
                 Divider(),
                 Text(
                     "Enable USB debugging and OEM unlocking on your device by enabling developer options."
                 ),
-                Row([FilledButton("How do I enable developer mode?", on_click=self.open_developer_options_dlg, expand=True, tooltip="Get help to enable developer options and OEM unlocking.")]),
+                Row(
+                    [
+                        FilledButton(
+                            "How do I enable developer mode?",
+                            on_click=self.open_developer_options_dlg,
+                            expand=True,
+                            tooltip="Get help to enable developer options and OEM unlocking.",
+                        )
+                    ]
+                ),
                 Divider(),
                 Text(
                     "Now connect your device to this computer via USB, then press 'Search device'."
@@ -102,7 +138,7 @@ def build(self):
                             on_click=self.search_devices,
                             icon=icons.PHONE_ANDROID,
                             expand=True,
-                            tooltip="Search for a connected device."
+                            tooltip="Search for a connected device.",
                         ),
                         self.continue_button,
                     ],
@@ -114,11 +150,10 @@ def build(self):
 
     def open_developer_options_dlg(self, e):
         """Open the dialog for help to developer mode."""
-        self.page.dialog = self.dlg_help_developer_options 
+        self.page.dialog = self.dlg_help_developer_options
         self.dlg_help_developer_options.open = True
         self.page.update()
 
-
     def close_developer_options_dlg(self, e):
         """Close the dialog for help to developer mode."""
         self.dlg_help_developer_options.open = False
@@ -154,7 +189,16 @@ def search_devices(self, e):
                 # select a new path and load again
                 pass
         except CalledProcessError:
-            self.device_name.value = "No device detected! Connect to USB and try again."
+            if DEVELOPMENT:
+                path = f"{CONFIG_PATH}/{DEVELOPMENT_CONFIG}.yaml"
+                load_config_success = self.load_config(path)
+                if load_config_success:
+                    self.config_found_box.value = True
+                    self.continue_button.disabled = False
+            else:
+                self.device_name.value = (
+                    "No device detected! Connect to USB and try again."
+                )
         self.view.update()
 
 
@@ -235,14 +279,27 @@ def enable_button_if_ready(self, e):
         else:
             self.confirm_button.disabled = True
 
+
 class SuccessView(BaseView):
-    def __init__(self, page: Page):
+    def __init__(self, progressbar: ProgressBar):
         super().__init__(image="success.png")
+        self.progressbar = progressbar
 
-    def build(self, ):
+    def build(
+        self,
+    ):
         self.right_view.controls = [
             get_title("Installation completed successfully!"),
-            Row([ElevatedButton("Finish and close", expand=True, on_click=lambda _: self.page.window_close())])
+            self.progressbar,
+            Row(
+                [
+                    ElevatedButton(
+                        "Finish and close",
+                        expand=True,
+                        on_click=lambda _: self.page.window_close(),
+                    )
+                ]
+            ),
         ]
         return self.view
 
@@ -276,9 +333,7 @@ def __init__(self, page: Page):
 
         # create default starter views
         welcome = WelcomeView(
-            on_confirm=self.confirm,
-            load_config=self.load_config,
-            page=self.page
+            on_confirm=self.confirm, load_config=self.load_config, page=self.page
         )
         select_files = SelectFilesView(
             on_confirm=self.confirm,
@@ -291,9 +346,9 @@ def __init__(self, page: Page):
         # ordered to allow for pop
         self.default_views = [select_files, welcome]
         # create the final success view
-        self.final_view = SuccessView(page)
+        self.final_view = SuccessView(progressbar=self.progress_bar)
         # keep track of the number of steps
-        self.num_steps = len(self.default_views)
+        self.num_steps = 2
 
     def build(self):
         self.view.controls.append(self.default_views.pop())
@@ -305,9 +360,7 @@ def confirm(self, e):
         self.view.controls = []
         # if a config is loaded, display a progress bar
         if self.config:
-            self.progress_bar.value = (self.num_steps - 1) / (
-                len(self.config.steps) + 2
-            )  # don't show on the first step
+            self.progress_bar.value = (self.num_steps - 1) / (self.num_total_steps + 2)  # don't show on the first step
             self.num_steps += 1  # increase the step counter
         # if there are default views left, display them first
         if self.default_views:
@@ -332,6 +385,7 @@ def load_config(self, path: str):
         """Function to load a config file from path."""
         try:
             self.config = InstallerConfig.from_file(path)
+            self.num_total_steps = len(self.config.steps)
             return True
         except FileNotFoundError:
             return False
@@ -398,7 +452,7 @@ def build(self):
             raise Exception(f"Unknown step type: {self.step.type}")
 
         # if skipping is allowed add a button to the view
-        if self.step.allow_skip:
+        if self.step.allow_skip or DEVELOPMENT:
             self.right_view.controls.append(
                 confirm_button("Already done?", self.on_confirm, confirm_text="Skip")
             )
@@ -431,8 +485,8 @@ def call_to_phone(self, e, command: str):
 def main(page: Page):
     # Configure the application base page
     page.title = "OpenAndroidInstaller"
-    page.window_width = 1080
     page.window_height = 720
+    page.window_width = int(1.5 * page.window_height)
     page.window_top = 100
     page.window_left = 720
     page.scroll = "adaptive"
@@ -481,7 +535,7 @@ def close_banner(e):
         ],
     )
     # TODO: disable the banner for now
-    #page.banner.open = True
+    # page.banner.open = True
 
     page.update()
 

openandroidinstaller/widgets.py

@@ -3,8 +3,7 @@
 from os import path
 from typing import Callable
 
-from flet import (Column, Container, ElevatedButton, Image, Row, Text,
-                  alignment, icons)
+from flet import Column, Container, ElevatedButton, Image, Row, Text, alignment, icons
 
 
 def get_title(title: str):
@@ -32,10 +31,15 @@ def confirm_button(
     return Column(
         [
             Text(f"{text}"),
-            ElevatedButton(
-                f"{confirm_text}",
-                on_click=confirm_func,
-                icon=icons.NEXT_PLAN_OUTLINED,
+            Row(
+                [
+                    ElevatedButton(
+                        f"{confirm_text}",
+                        on_click=confirm_func,
+                        icon=icons.NEXT_PLAN_OUTLINED,
+                        expand=True,
+                    )
+                ]
             ),
         ],
         horizontal_alignment="center",
@@ -48,8 +52,15 @@ def call_button(
     return Column(
         [
             Text(f"{text}"),
-            ElevatedButton(
-                f"{confirm_text}", on_click=partial(call_func, command=command)
+            Row(
+                [
+                    ElevatedButton(
+                        f"{confirm_text}",
+                        on_click=partial(call_func, command=command),
+                        expand=True,
+                        icon=icons.DIRECTIONS_RUN_OUTLINED,
+                    )
+                ]
             ),
         ],
         horizontal_alignment="center",