Skip to content

Commit f781b84

Browse files
tsterbaktsterbak
authored
Release v.0.3.1-alpha (#44)
This Release adds: - Pop-up box to explain custom recovery and OS images. - Configs for new devices: - Sony Xperia 10 (kirin) - Sony Xperia 10 Plus (mermaid) - Sony Xperia XA2 (pioneer) - Sony Xperia XZ3 (akatsuki) - Sony Xperia XZ2 (akari) - new Images to guide in the process - Restructuring of views - dialog to help finding the android or firmware version - steps indicator header - Remove step-progressbar and move the header to different column container to keep it attached to the top
2 parents 27cb422 + ed58f27 commit f781b84

28 files changed

Lines changed: 1857 additions & 1287 deletions

‎README.md‎

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,22 @@ This also includes your DRM keys, which are stored in the Trim Area partition (a
3333
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.
3434
If you wish to backup the TA partition first, you can find tutorials related to your device on the internet.
3535

36+
37+
## Usage
38+
39+
Linux is currently the best supported platform (tested with Ubuntu 20.04 LTS). Windows and MacOS are also supported but you might experience more issues. So far there is no support for ARM-based systems.
40+
41+
1. Download the AppImage, .exe or appropriate executable file for your OS. You might need to change permissions to run the executable.
42+
- On Windows also [install the Universal USB Drivers](https://adb.clockworkmod.com/) and other potentially drivers needed for your device.
43+
2. Download the custom ROM image and the TWRP recovery image for your device. A source for files can be found on
44+
- [LineageOS](https://wiki.lineageos.org/devices/)
45+
- [TWRP recovery](https://twrp.me/Devices/)
46+
- [/e/OS](https://doc.e.foundation/devices)
47+
- [LineageOS for microg](https://download.lineage.microg.org/)
48+
- or you can just search the web for an appropriate version for your device.
49+
3. Start the desktop app and follow the instructions.
50+
51+
3652
## Officially supported devices
3753
Vendor | Device Name | CodeName | Models | Status
3854
---|---|---|---|---
@@ -52,6 +68,11 @@ Google | Pixel 5 | [redfin](https://wiki.lineageos.org/devices/redfin/) | redfin
5268
Google | Pixel 5a | [barbet](https://wiki.lineageos.org/devices/barbet/) | barbet | tested
5369
Sony | Xperia Z | [yuga](https://wiki.lineageos.org/devices/yuga/) | C6603 | tested
5470
Sony | Xperia Z3 | [z3](https://wiki.lineageos.org/devices/z3/) | | tested
71+
Sony | Xperia 10 | [kirin](https://wiki.lineageos.org/devices/kirin/) | | tested
72+
Sony | Xperia 10 Plus | [mermaid](https://wiki.lineageos.org/devices/mermaid/) | | tested
73+
Sony | Xperia XA2 | [pioneer](https://wiki.lineageos.org/devices/pioneer/) | | tested
74+
Sony | Xperia XZ2 | [akari](https://wiki.lineageos.org/devices/akari/) | | tested
75+
Sony | Xperia XZ3 | [akatsuki](https://wiki.lineageos.org/devices/akatsuki/) | | tested
5576
Sony | Xperia ZX | kagura | | planned
5677
Fairphone | Fairphone 2 | [FP2](https://wiki.lineageos.org/devices/FP2/) | | tested
5778
Fairphone | Fairphone 3 | [FP3](https://wiki.lineageos.org/devices/FP3/) | | tested
@@ -67,16 +88,6 @@ OnePlus | Nord N200 | [dre](https://wiki.lineageos.org/devices/dre/) | | tested
6788
OnePlus | 9 | lemonade | | under development
6889

6990

70-
## Usage
71-
72-
Linux is currently the best supported platform (tested with Ubuntu 20.04 LTS). Windows and MacOS are also supported but you might experience more issues. So far there is no support for ARM-based systems.
73-
74-
1. Download the AppImage, .exe or appropriate executable file for your OS. You might need to change permissions to run the executable.
75-
- On Windows also [install the Universal USB Drivers](https://adb.clockworkmod.com/) and other potentially drivers needed for your device.
76-
2. Download the lineageOS image and the custom recovery image. A source for files can be found on https://wiki.lineageos.org/devices/ or you can just search the web for an appropriate version for your device.
77-
3. Start the desktop app and follow the instructions.
78-
79-
8091
## Run OpenAndroidInstaller for development
8192

8293
Currently development is only supported on Ubuntu Linux. MacOS and Windows should also work fine. You might need to install additional USB-drivers on Windows.

‎openandroidinstaller/app_state.py‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515

1616
from pathlib import Path
1717

18-
from flet import ProgressBar
1918
from installer_config import _load_config
2019

2120

@@ -27,22 +26,15 @@ def __init__(
2726
platform: str,
2827
config_path: Path,
2928
bin_path: Path,
30-
progressbar: ProgressBar,
31-
num_steps: int,
3229
test: bool = False,
3330
test_config: str = None,
3431
):
3532
self.platform = platform
3633
self.config_path = config_path
3734
self.bin_path = bin_path
38-
self.progressbar = progressbar
39-
self.num_steps = num_steps # keep track of the steps already taken
4035
self.test = test
4136
self.test_config = test_config
4237

43-
# initialize the progress bar at 0
44-
self.progressbar.value = 0
45-
4638
# placeholders
4739
self.advanced = False
4840
self.config = None
@@ -61,11 +53,3 @@ def load_config(self, device_code: str):
6153
+ self.config.flash_recovery
6254
+ self.config.install_os
6355
)
64-
self.num_total_steps = len(self.steps)
65-
66-
def increment_progressbar(self):
67-
"""Increment the progressbar and step counter."""
68-
self.progressbar.value = (self.num_steps - 1) / (
69-
self.num_total_steps + 3
70-
) # don't show on the first step
71-
self.num_steps += 1 # increase the step counter

‎openandroidinstaller/assets/configs/akari.yaml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
metadata:
2+
maintainer: Tobias Sterbak (tsterbak)
3+
devicename: Sony Xperia XZ2
4+
devicecode: akari
5+
requirements:
6+
android: 10
7+
steps:
8+
unlock_bootloader:
9+
- type: confirm_button
10+
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.
11+
- type: confirm_button
12+
content: Go to service info > configuration and check rooting status - you can only continue if it says 'Bootloader unlock allowed":" Yes.'
13+
- type: confirm_button
14+
content: >
15+
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.
16+
- type: link_button_with_confirm
17+
content: >
18+
Click on the button to open the instructions on Sonys official unlocking website to generate an unlock code for your bootloader.
19+
Once you got the code write it down somewhere and continue to input the code.
20+
link: https://developer.sonymobile.com/unlockbootloader/unlock-yourboot-loader/
21+
- type: confirm_button
22+
content: Connect the device to your PC via USB. And confirm to continue.
23+
- type: call_button
24+
content: Press the button to reboot into the bootloader now. When the notification light turns blue, confirm to continue.
25+
command: adb_reboot_bootloader
26+
- type: call_button_with_input
27+
content: >
28+
Use your code to unlock the bootloader of your device. Type in the full 18 character code starting with 0x (Example: 0x3EC4F7AD6E0B32B6).
29+
If you already did that, you can skip this step.
30+
command: fastboot_unlock_with_code
31+
- type: call_button
32+
content: >
33+
Press the button to reboot. Since the device resets completely, you will need to re-enable USB debugging to continue.
34+
Connect your device to your PC via USB. Then confirm here to continue.
35+
command: fastboot_reboot
36+
flash_recovery:
37+
- type: call_button
38+
content: >
39+
Now you need to flash a custom recovery system on the phone. A recovery is a small subsystem on your phone, that manages updating,
40+
adapting and repairing of the operating system.
41+
Make sure your device is turned on. You need to reboot into the bootloader again by pressing 'Confirm and run' here. Then continue.
42+
command: adb_reboot_bootloader
43+
- type: call_button
44+
content: Flash a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
45+
command: fastboot_flash_recovery
46+
- type: call_button
47+
command: adb_twrp_copy_partitions
48+
content: >
49+
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.
50+
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.
51+
- type: call_button
52+
command: fastboot_flash_recovery
53+
content: >
54+
Now we need to boot into recovery again. Press run and when you see the TWRP screen you can continue.
55+
install_os:
56+
- type: call_button
57+
content: >
58+
In the next steps, you finally flash the selected OS image.
59+
Connect your device with your computer with the USB-Cable.
60+
This step will format your phone and wipe all the data. It will also remove encryption and delete all files stored
61+
in the internal storage. Then the OS image will be installed. Confirm to run. This might take a while. At the end your phone will boot into the new OS.
62+
command: adb_twrp_wipe_and_install

‎openandroidinstaller/assets/configs/akatsuki.yaml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
metadata:
2+
maintainer: Tobias Sterbak (tsterbak)
3+
devicename: Sony Xperia XZ3
4+
devicecode: akatsuki
5+
requirements:
6+
android: 10
7+
steps:
8+
unlock_bootloader:
9+
- type: confirm_button
10+
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.
11+
- type: confirm_button
12+
content: Go to service info > configuration and check rooting status - you can only continue if it says 'Bootloader unlock allowed":" Yes.'
13+
- type: confirm_button
14+
content: >
15+
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.
16+
- type: link_button_with_confirm
17+
content: >
18+
Click on the button to open the instructions on Sonys official unlocking website to generate an unlock code for your bootloader.
19+
Once you got the code write it down somewhere and continue to input the code.
20+
link: https://developer.sonymobile.com/unlockbootloader/unlock-yourboot-loader/
21+
- type: confirm_button
22+
content: Connect the device to your PC via USB. And confirm to continue.
23+
- type: call_button
24+
content: Press the button to reboot into the bootloader now. When the notification light turns blue, confirm to continue.
25+
command: adb_reboot_bootloader
26+
- type: call_button_with_input
27+
content: >
28+
Use your code to unlock the bootloader of your device. Type in the full 18 character code starting with 0x (Example: 0x3EC4F7AD6E0B32B6).
29+
If you already did that, you can skip this step.
30+
command: fastboot_unlock_with_code
31+
- type: call_button
32+
content: >
33+
Press the button to reboot. Since the device resets completely, you will need to re-enable USB debugging to continue.
34+
Connect your device to your PC via USB. Then confirm here to continue.
35+
command: fastboot_reboot
36+
flash_recovery:
37+
- type: call_button
38+
content: >
39+
Now you need to flash a custom recovery system on the phone. A recovery is a small subsystem on your phone, that manages updating,
40+
adapting and repairing of the operating system.
41+
Make sure your device is turned on. You need to reboot into the bootloader again by pressing 'Confirm and run' here. Then continue.
42+
command: adb_reboot_bootloader
43+
- type: call_button
44+
content: Flash a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
45+
command: fastboot_flash_recovery
46+
- type: call_button
47+
command: adb_twrp_copy_partitions
48+
content: >
49+
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.
50+
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.
51+
- type: call_button
52+
command: fastboot_flash_recovery
53+
content: >
54+
Now we need to boot into recovery again. Press run and when you see the TWRP screen you can continue.
55+
install_os:
56+
- type: call_button
57+
content: >
58+
In the next steps, you finally flash the selected OS image.
59+
Connect your device with your computer with the USB-Cable.
60+
This step will format your phone and wipe all the data. It will also remove encryption and delete all files stored
61+
in the internal storage. Then the OS image will be installed. Confirm to run. This might take a while. At the end your phone will boot into the new OS.
62+
command: adb_twrp_wipe_and_install

‎openandroidinstaller/assets/configs/kirin.yaml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
metadata:
2+
maintainer: Tobias Sterbak (tsterbak)
3+
devicename: Sony Xperia 10
4+
devicecode: kirin
5+
steps:
6+
unlock_bootloader:
7+
- type: confirm_button
8+
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.
9+
- type: confirm_button
10+
content: Go to service info > configuration and check rooting status - you can only continue if it says 'Bootloader unlock allowed":" Yes.'
11+
- type: confirm_button
12+
content: >
13+
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.
14+
- type: link_button_with_confirm
15+
content: >
16+
Click on the button to open the instructions on Sonys official unlocking website to generate an unlock code for your bootloader.
17+
Once you got the code write it down somewhere and continue to input the code.
18+
link: https://developer.sonymobile.com/unlockbootloader/unlock-yourboot-loader/
19+
- type: confirm_button
20+
content: Connect the device to your PC via USB. And confirm to continue.
21+
- type: call_button
22+
content: Press the button to reboot into the bootloader now. When the notification light turns blue, confirm to continue.
23+
command: adb_reboot_bootloader
24+
- type: call_button_with_input
25+
content: >
26+
Use your code to unlock the bootloader of your device. Type in the full 18 character code starting with 0x (Example: 0x3EC4F7AD6E0B32B6).
27+
If you already did that, you can skip this step.
28+
command: fastboot_unlock_with_code
29+
- type: call_button
30+
content: >
31+
Press the button to reboot. Since the device resets completely, you will need to re-enable USB debugging to continue.
32+
Connect your device to your PC via USB. Then confirm here to continue.
33+
command: fastboot_reboot
34+
flash_recovery:
35+
- type: call_button
36+
content: >
37+
Now you need to flash a custom recovery system on the phone. A recovery is a small subsystem on your phone, that manages updating,
38+
adapting and repairing of the operating system.
39+
Make sure your device is turned on. You need to reboot into the bootloader again by pressing 'Confirm and run' here. Then continue.
40+
command: adb_reboot_bootloader
41+
- type: call_button
42+
content: Flash a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
43+
command: fastboot_flash_recovery
44+
- type: call_button
45+
command: adb_twrp_copy_partitions
46+
content: >
47+
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.
48+
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.
49+
- type: call_button
50+
command: fastboot_flash_recovery
51+
content: >
52+
Now we need to boot into recovery again. Press run and when you see the TWRP screen you can continue.
53+
install_os:
54+
- type: call_button
55+
content: >
56+
In the next steps, you finally flash the selected OS image.
57+
Connect your device with your computer with the USB-Cable.
58+
This step will format your phone and wipe all the data. It will also remove encryption and delete all files stored
59+
in the internal storage. Then the OS image will be installed. Confirm to run. This might take a while. At the end your phone will boot into the new OS.
60+
command: adb_twrp_wipe_and_install

‎openandroidinstaller/assets/configs/mermaid.yaml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
metadata:
2+
maintainer: Tobias Sterbak (tsterbak)
3+
devicename: Sony Xperia 10 Plus
4+
devicecode: mermaid
5+
steps:
6+
unlock_bootloader:
7+
- type: confirm_button
8+
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.
9+
- type: confirm_button
10+
content: Go to service info > configuration and check rooting status - you can only continue if it says 'Bootloader unlock allowed":" Yes.'
11+
- type: confirm_button
12+
content: >
13+
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.
14+
- type: link_button_with_confirm
15+
content: >
16+
Click on the button to open the instructions on Sonys official unlocking website to generate an unlock code for your bootloader.
17+
Once you got the code write it down somewhere and continue to input the code.
18+
link: https://developer.sonymobile.com/unlockbootloader/unlock-yourboot-loader/
19+
- type: confirm_button
20+
content: Connect the device to your PC via USB. And confirm to continue.
21+
- type: call_button
22+
content: Press the button to reboot into the bootloader now. When the notification light turns blue, confirm to continue.
23+
command: adb_reboot_bootloader
24+
- type: call_button_with_input
25+
content: >
26+
Use your code to unlock the bootloader of your device. Type in the full 18 character code starting with 0x (Example: 0x3EC4F7AD6E0B32B6).
27+
If you already did that, you can skip this step.
28+
command: fastboot_unlock_with_code
29+
- type: call_button
30+
content: >
31+
Press the button to reboot. Since the device resets completely, you will need to re-enable USB debugging to continue.
32+
Connect your device to your PC via USB. Then confirm here to continue.
33+
command: fastboot_reboot
34+
flash_recovery:
35+
- type: call_button
36+
content: >
37+
Now you need to flash a custom recovery system on the phone. A recovery is a small subsystem on your phone, that manages updating,
38+
adapting and repairing of the operating system.
39+
Make sure your device is turned on. You need to reboot into the bootloader again by pressing 'Confirm and run' here. Then continue.
40+
command: adb_reboot_bootloader
41+
- type: call_button
42+
content: Flash a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
43+
command: fastboot_flash_recovery
44+
- type: call_button
45+
command: adb_twrp_copy_partitions
46+
content: >
47+
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.
48+
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.
49+
- type: call_button
50+
command: fastboot_flash_recovery
51+
content: >
52+
Now we need to boot into recovery again. Press run and when you see the TWRP screen you can continue.
53+
install_os:
54+
- type: call_button
55+
content: >
56+
In the next steps, you finally flash the selected OS image.
57+
Connect your device with your computer with the USB-Cable.
58+
This step will format your phone and wipe all the data. It will also remove encryption and delete all files stored
59+
in the internal storage. Then the OS image will be installed. Confirm to run. This might take a while. At the end your phone will boot into the new OS.
60+
command: adb_twrp_wipe_and_install

0 commit comments

Comments
 (0)