Release 0.4.3-beta (#135)

This release adds:
- Support for Samsung Galaxy S4 mini (serranoltexx/serranolte) by
@freechelmi
- Allow Markdown to format text content of device configs (limited
markdown set)
- Support for Samsung Galaxy Grand Prime VE (grandprimevelte) by
@MagicLike
- Allow changing the logging location by `poetry run python
openandroidinstaller/openandroidinstaller.py -l <logging directory>`
- Support for Samsung Galaxy S8 (dreamlte) by @allaeddineomc 

Improvements:
- Make the Fairphone 2 config clearer
- removed an unneeded reboot instructions for the FPs
- added the TWRP image to every config
- reformatted the configs for more consistency

Fixes:
- A bug where not selecting any add-on leads to a failure of the app. If
no add-on is selected, now just reboot to OS at installation time.
- Improve the addons installer progress bars and fix issues
- Try `wipe data` if `format data` fails to enable the use of older TWRP
versions
- Improve logging for the run_command function

Todo:
- [x] Bump version numbers
- [x] Update website

openandroidinstaller/app_state.py

@@ -40,6 +40,7 @@ def __init__(
         # placeholders
         self.advanced = False
         self.install_addons = False
+        self.addon_paths = []
         self.config = None
         self.image_path = None
         self.recovery_path = None

openandroidinstaller/assets/configs/FP2.yaml

@@ -8,17 +8,15 @@ metadata:
 steps:
   unlock_bootloader:
   boot_recovery:
-    - type: confirm_button 
+    - type: call_button
       content: >
         Now you need to boot 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 and connected to the computer. Boot into the bootloader by pressing 'Confirm and run' here. Then continue.
       command: adb_reboot_bootloader
     - type: call_button
-      content: Boot a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
-      command: fastboot_boot_recovery
-    - type: confirm_button 
+      img: twrp-start.jpeg
       content: >
-        Now reboot into recovery to verify the installation. Do not reboot into the existing OS, since it will overwrite the recovery you just installed!
-        With the device powered off, hold 'Volume Up + Power'. Release when boot logo appears.
+        Boot a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
+      command: fastboot_boot_recovery

openandroidinstaller/assets/configs/FP3.yaml

@@ -15,35 +15,38 @@ steps:
         Once you've done that, continue.
       link: https://www.fairphone.com/en/bootloader-unlocking-code-for-fairphone-3/
     - type: call_button
-      content: Press 'Confirm and run' to reboot into the bootloader.
+      content: >
+        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.
+      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
     - type: confirm_button
       content: >
         Follow the instructions on the Fairphone screen. This command will wipe all the personal data on your phone.
     - type: call_button
-      content: To finish the unlocking, the phone needs to reboot. Just press 'Confirm and run' here to reboot. Then continue.
+      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 USB debugging to continue.
   boot_recovery:
     - type: confirm_button 
       content: >
         Now you need to boot 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: Turn on your device. Once the device is fully booted, you need to reboot into the bootloader again by pressing 'Confirm and run' here. Then continue.
+      content: >
+        Turn on your device. 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
     - type: call_button
-      content: Once the device is in fastboot mode, flash the custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
-      command: fastboot_boot_recovery
-    - type: confirm_button 
+      img: twrp-start.jpeg
       content: >
-        Now reboot into recovery to verify the installation. Do not reboot into the existing OS, since it will overwrite the recovery you just installed!
-        With the device powered off, hold 'Volume Up + Power'. Release when boot logo appears.
+        Once the device is in fastboot mode, flash the custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
+      command: fastboot_boot_recovery

openandroidinstaller/assets/configs/FP4.yaml

@@ -15,35 +15,38 @@ steps:
         Once you've done that, continue.
       link: https://support.fairphone.com/hc/en-us/articles/4405858258961-FP4-Manage-the-bootloader
     - type: call_button
-      content: Press 'Confirm and run' to reboot into the bootloader.
+      content: >
+        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.
+      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
     - type: confirm_button
       content: >
         Follow the instructions on the Fairphone screen. This command will wipe all the personal data on your phone.
     - type: call_button
-      content: To finish the unlocking, the phone needs to reboot. Just press 'Confirm and run' here to reboot. Then continue.
+      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 USB debugging to continue.
   boot_recovery:
     - type: confirm_button 
       content: >
         Now you need to boot 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: Turn on your device. Once the device is fully booted, you need to reboot into the bootloader again by pressing 'Confirm and run' here. Then continue.
+      content: >
+        Turn on your device. 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
     - type: call_button
-      content: Once the device is in fastboot mode, boot the custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
-      command: fastboot_boot_recovery
-    - type: confirm_button 
+      img: twrp-start.jpeg
       content: >
-        Now reboot into recovery to verify the installation. Do not reboot into the existing OS, since it will overwrite the recovery you just installed!
-        With the device powered off, hold 'Volume Up + Power'. Release when boot logo appears.
+        Once the device is in fastboot mode, boot the custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
+      command: fastboot_boot_recovery

openandroidinstaller/assets/configs/a3y17lte.yaml

@@ -11,12 +11,12 @@ steps:
     - type: call_button
       content: >
         As a first step, you need to boot into 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.
+        that tells your phone how to start and run an operating system (like Android). Your device should be turned on.
         Then press 'Confirm and run' to reboot into the bootloader. Continue once it's done.
       command: adb_reboot_download
     - type: call_button
       content: >
-        In this step, you need to boot a custom recovery on your device.
+        In this step, you need to flash a custom recovery on your device.
         Press 'Confirm and run' to start the process. Confirm afterwards to continue.
       command: heimdall_flash_recovery
     - type: confirm_button

openandroidinstaller/assets/configs/a5xelte.yaml

@@ -11,11 +11,13 @@ steps:
     - type: call_button
       content: >
         As a first step, you need to boot into 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. 
+        that tells your phone how to start and run an operating system (like Android). Your device should be turned on. 
         Then press 'Confirm and run' to reboot into the bootloader. Continue once it's done.
       command: adb_reboot_download
     - type: call_button
-      content: In this step, you need to boot a custom recovery on your device. Press 'Confirm and run' to start the process. Confirm afterwards to continue.
+      content: >
+        In this step, you need to flash a custom recovery on your device.
+        Press 'Confirm and run' to start the process. Confirm afterwards to continue.
       command: heimdall_flash_recovery
     - type: confirm_button
       img: samsung-buttons.png

openandroidinstaller/assets/configs/a72q.yaml

@@ -11,11 +11,13 @@ steps:
     - type: call_button
       content: >
         As a first step, you need to boot into 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. 
+        that tells your phone how to start and run an operating system (like Android). Your device should be turned on. 
         Then press 'Confirm and run' to reboot into the bootloader. Continue once it's done.
       command: adb_reboot_download
     - type: call_button
-      content: In this step, you need to boot a custom recovery on your device. Press 'Confirm and run' to start the process. Confirm afterwards to continue.
+      content: >
+        In this step, you need to flash a custom recovery on your device.
+        Press 'Confirm and run' to start the process. Confirm afterwards to continue.
       command: heimdall_flash_recovery
     - type: confirm_button
       img: samsung-buttons.png

openandroidinstaller/assets/configs/a7xelte.yaml

@@ -11,11 +11,13 @@ steps:
     - type: call_button
       content: >
         As a first step, you need to boot into 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. 
+        that tells your phone how to start and run an operating system (like Android). Your device should be turned on. 
         Then press 'Confirm and run' to reboot into the bootloader. Continue once it's done.
       command: adb_reboot_download
     - type: call_button
-      content: In this step, you need to boot a custom recovery on your device. Press 'Confirm and run' to start the process. Confirm afterwards to continue.
+      content: >
+        In this step, you need to flash a custom recovery on your device.
+        Press 'Confirm and run' to start the process. Confirm afterwards to continue.
       command: heimdall_flash_recovery
     - type: confirm_button
       img: samsung-buttons.png

openandroidinstaller/assets/configs/akari.yaml

@@ -10,9 +10,11 @@ requirements:
 steps:
   unlock_bootloader:
     - type: confirm_button
-      content: As a first step, you need to unlock the bootloader of your device. On the device, dial *#*#7378423#*#* (*#*#SERVICE#*#*) to launch the service menu.
+      content: >
+        As a first step, you need to unlock the bootloader of your device. On the device, dial *#*#7378423#*#* (*#*#SERVICE#*#*) to launch the service menu.
     - type: confirm_button
-      content: Go to service info > configuration and check rooting status - you can only continue if it says 'Bootloader unlock allowed":" Yes.'
+      content: >
+        Go to service info > configuration and check rooting status - you can only continue if it says 'Bootloader unlock allowed":" Yes.'
     - type: confirm_button
       content: >
         Now go to Settings 'About the phone' and then Status. Write down the IMEI of your device. You will need it in the next step.
@@ -22,9 +24,11 @@ steps:
         Once you got the code write it down somewhere and continue to input the code. 
       link: https://developer.sonymobile.com/unlockbootloader/unlock-yourboot-loader/
     - type: confirm_button
-      content: Connect the device to your PC via USB. And confirm to continue.
+      content: >
+        Connect the device to your PC via USB. And confirm to continue.
     - type: call_button
-      content: Press the button to reboot into the bootloader now. When the notification light turns blue, confirm to continue.
+      content: >
+        Press the button to reboot into the bootloader now. When the notification light turns blue, confirm to continue.
       command: adb_reboot_bootloader
     - type: call_button_with_input
       content: >
@@ -44,14 +48,15 @@ steps:
         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: call_button
-      content: Boot a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
+      content: >
+        Boot a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
       command: fastboot_flash_boot
     - type: call_button
-      command: adb_twrp_copy_partitions
       content: >
         In some cases, the inactive slot can be unpopulated or contain much older firmware than the active slot, leading to various issues including a potential hard-brick.
         We can ensure none of that will happen by copying the contents of the active slot to the inactive slot. Press 'confirm and run' to to this. Once you are in the bootloader again, continue.
+      command: adb_twrp_copy_partitions
     - type: call_button
-      command: fastboot_flash_boot
       content: >
-        Now we need to boot into recovery again. Press run and when you see the TWRP screen you can continue.
+        Now we need to boot into recovery again. Press run and when you see the TWRP screen you can continue.
+      command: fastboot_flash_boot

openandroidinstaller/assets/configs/akatsuki.yaml

@@ -10,9 +10,11 @@ requirements:
 steps:
   unlock_bootloader:
     - type: confirm_button
-      content: As a first step, you need to unlock the bootloader of your device. On the device, dial *#*#7378423#*#* (*#*#SERVICE#*#*) to launch the service menu.
+      content: >
+        As a first step, you need to unlock the bootloader of your device. On the device, dial *#*#7378423#*#* (*#*#SERVICE#*#*) to launch the service menu.
     - type: confirm_button
-      content: Go to service info > configuration and check rooting status - you can only continue if it says 'Bootloader unlock allowed":" Yes.'
+      content: >
+        Go to service info > configuration and check rooting status - you can only continue if it says 'Bootloader unlock allowed":" Yes.'
     - type: confirm_button
       content: >
         Now go to Settings 'About the phone' and then Status. Write down the IMEI of your device. You will need it in the next step.
@@ -22,9 +24,11 @@ steps:
         Once you got the code write it down somewhere and continue to input the code. 
       link: https://developer.sonymobile.com/unlockbootloader/unlock-yourboot-loader/
     - type: confirm_button
-      content: Connect the device to your PC via USB. And confirm to continue.
+      content: >
+        Connect the device to your PC via USB. And confirm to continue.
     - type: call_button
-      content: Press the button to reboot into the bootloader now. When the notification light turns blue, confirm to continue.
+      content: >
+        Press the button to reboot into the bootloader now. When the notification light turns blue, confirm to continue.
       command: adb_reboot_bootloader
     - type: call_button_with_input
       content: >
@@ -44,14 +48,15 @@ steps:
         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: call_button
-      content: Boot a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
+      content: >
+        Boot a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
       command: fastboot_flash_boot
     - type: call_button
-      command: adb_twrp_copy_partitions
       content: >
         In some cases, the inactive slot can be unpopulated or contain much older firmware than the active slot, leading to various issues including a potential hard-brick.
         We can ensure none of that will happen by copying the contents of the active slot to the inactive slot. Press 'confirm and run' to to this. Once you are in the bootloader again, continue.
+      command: adb_twrp_copy_partitions
     - type: call_button
-      command: fastboot_flash_boot
       content: >
-        Now we need to boot into recovery again. Press run and when you see the TWRP screen you can continue.
+        Now we need to boot into recovery again. Press run and when you see the TWRP screen you can continue.
+      command: fastboot_flash_boot

openandroidinstaller/assets/configs/avicii.yaml

@@ -32,6 +32,7 @@ steps:
         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: call_button
+      img: twrp-start.jpeg
       content: >
         Boot a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
       command: fastboot_boot_recovery
@@ -41,6 +42,7 @@ steps:
         We can ensure none of that will happen by copying the contents of the active slot to the inactive slot. Press 'confirm and run' to to this. Once you are in the bootloader again, continue.
       command: adb_twrp_copy_partitions
     - type: call_button
+      img: twrp-start.jpeg
       content: >
         Now we need to boot into recovery again. Press run and when you see the TWRP screen you can continue.
       command: fastboot_boot_recovery

openandroidinstaller/assets/configs/bacon.yaml

@@ -38,6 +38,7 @@ steps:
         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: call_button
+      img: twrp-start.jpeg
       content: >
         Boot a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
       command: fastboot_boot_recovery