Fix config for google pixal 3a; change the way image and recovery names are replaced from the config file; Update the readme with warnings and supported devices

Author: tsterbak

README.md

@@ -21,6 +21,20 @@
   </p>
 </div>
 
+
+## Warning: Unlocking the bootloader will erase all data on your device!
+This also includes your DRM keys, which are stored in the Trim Area partition (also called TA).
+Before proceeding, ensure the data you would like to retain is backed up to your PC and/or your Google account, or equivalent. Please note that OEM backup solutions like Samsung and Motorola backup may not be accessible from LineageOS once installed.
+If you wish to backup the TA partition first, you can find tutorials related to your device on the internet.
+
+## Officially supported devices
+Vendor | Device Name | CodeName | Models | Status
+---|---|---|---|---
+Samsung | Galaxy A3 2017 | a3y17lte | SM-A320FL | tested
+Samsung | Galaxy A5 2016 | a5xelte |  | under development
+Google | Pixel 3a | sargo | sargo | tested
+Sony | Xperia Z | yuga | | tested
+
 ## Installation
 
 1. Download the AppImage, .exe or appropriate file for your OS. 

openandroidinstaller/assets/configs/Pixel 3a.yaml

@@ -1,10 +1,4 @@
 steps:
-  - title: "Enable developer options and OEM unlocking"
-    type: confirm_button
-    content: "Enable USB debugging on your device by enabling developer options. To do this, tap 5 times on the build number in the System-Menu in Settings. Then in developer options, toggle OEM unlocking and USB-Debugging."
-  - title: "Unlock the bootloader"
-    type: confirm_button
-    content: "Turn on developer options and OEM Unlock on your phone."
   - title: "Unlock the bootloader"
     type: confirm_button
     content: "Turn on your device and wait until its fully booted."
@@ -19,13 +13,15 @@ steps:
     type: call_button
     content: "Unlock the bootloader now:"
     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"
-    command: "adb reboot"
+    command: "fastboot reboot"
+    allow_skip: True
   - 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."
@@ -39,7 +35,7 @@ steps:
   - title: "Flash custom recovery"
     type: call_button
     content: "Flash custom recovery (temporarily)"
-    command: "fastboot flash boot recovery"
+    command: "fastboot flash boot <recovery>"
   - title: "Flash LineageOS"
     type: call_button
     content: "Boot into recovery"
@@ -56,7 +52,7 @@ steps:
   - title: "Flash LineageOS"
     type: call_button
     content: "Flash lineageOS image. Don't remove the USB-Cable!"
-    command: "adb sideload image"
+    command: "adb sideload <image>"
   - title: "Reboot"
     type: call_button
     content: "Reboot into OS"

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

@@ -1,7 +1,4 @@
 steps:
-  - title: "Unlock the bootloader"
-    type: confirm_button
-    content: "Turn on developer options and OEM Unlock on your phone."
   - title: "Boot into recovery"
     type: confirm_button
     content: "Turn on your device and wait until its fully booted."
@@ -12,7 +9,7 @@ steps:
   - title: "Boot into recovery"
     type: call_button
     content: "Flash custom recovery"
-    command: "heimdall flash --no-reboot --RECOVERY recovery"
+    command: "heimdall flash --no-reboot --RECOVERY <recovery>"
   - title: "Boot into recovery"
     type: confirm_button
     content: "Unplug the USB cable from your device. Manually reboot into recovery. Press the Volume Down + Power buttons for 8~10 seconds until the screen turns black & release the buttons immediately when it does, then boot to recovery with the device powered off, hold Volume Up + Home + Power."
@@ -28,7 +25,7 @@ steps:
   - title: "Flash LineageOS"
     type: call_button
     content: "Flash lineageOS image. Don't remove the USB-Cable!"
-    command: "adb sideload image"
+    command: "adb sideload <image>"
   - title: "Reboot"
     type: call_button
     content: "Reboot into OS"

openandroidinstaller/assets/configs/Xperia Z.yaml

@@ -1,7 +1,4 @@
 steps:
-  - title: "Unlock the bootloader"
-    type: confirm_button
-    content: "Enable USB debugging on your device by enabling developer options. To do this, tap 5 times on the build number in the System-Menu in Settings. Then in developer options, toggle OEM unlocking and USB-Debugging."
   - title: "Unlock the bootloader"
     type: confirm_button
     content: "On the device, dial *#*#7378423#*#* (*#*#SERVICE#*#*) to launch the service menu."
@@ -21,7 +18,7 @@ steps:
   - title: "Unlock the bootloader"
     type: call_button_with_input
     content: "Use your code to unlock the bootloader of your device:"
-    command: "fastboot oem unlock inputtext"
+    command: "fastboot oem unlock <inputtext>"
     allow_skip: True
   - title: "Flash temporary recovery"
     type: confirm_button
@@ -34,7 +31,7 @@ steps:
   - title: "Flash temporary recovery"
     type: call_button
     content: "Flash recovery image"
-    command: "fastboot flash boot recovery"
+    command: "fastboot flash boot <recovery>"
   - title: "Flash LineageOS"
     type: call_button
     content: "Boot into recovery"
@@ -51,7 +48,7 @@ steps:
   - title: "Flash LineageOS"
     type: call_button
     content: "Flash lineageOS image. Don't remove the USB-Cable!"
-    command: "adb sideload image"
+    command: "adb sideload <image>"
   - title: "Reboot"
     type: call_button
     content: "Reboot into OS"

openandroidinstaller/openandroidinstaller.py

@@ -130,9 +130,9 @@ def views_from_config(config: InstallerConfig) -> List[View]:
         return new_views
 
     def call_to_phone(e, command: str):
-        command = command.replace("recovery", recovery_path)
-        command = command.replace("image", image_path)
-        command = command.replace("inputtext", inputtext.value)
+        command = command.replace("<recovery>", recovery_path)
+        command = command.replace("<image>", image_path)
+        command = command.replace("<inputtext>", inputtext.value)
         page.views[-1].controls.append(ProgressRing())
         page.update()
         res = call(f"{command}", shell=True)
@@ -256,6 +256,9 @@ def get_new_view(title: str, index: int, content: List = []) -> View:
         get_new_view(
             title="Welcome to OpenAndroidInstaller!",
             content=[
+                Text("Enable USB debugging on your device by enabling developer options."),
+                Text("To do this, tap 5 times on the build number in the System-Menu in Settings."),
+                Text("Then in developer options, toggle OEM unlocking and USB-Debugging."), 
                 ElevatedButton(
                     "Search device", on_click=search_devices, icon=icons.PHONE_ANDROID
                 )