openandroidinstaller-dev · tsterbak · Jul 1, 2025 · Nov 19, 2023 · Jul 11, 2025 · Jul 12, 2025
diff --git a/.github/ISSUE_TEMPLATE/device-support-request.yaml b/.github/ISSUE_TEMPLATE/device-support-request.yaml
@@ -59,17 +59,16 @@ body:
   - type: textarea
     attributes:
       label: Device images
-      description: "Please provide links to any available images for the device, such as official stock firmware, Custom ROMs and Recoveries you would like to install."
+      description: "Please provide links to at least one Custom ROM and TWRP build. This is mandatory for OpenAndroidInstaller support."
       placeholder: |
         - Custom ROM: https://wiki.lineageos.org/devices/sargo
         - Recovery: https://twrp.me/google/googlepixel3a.html
       #value: |
       #  - Custom ROM:
       #  - Recovery:
-      #  - Stock firmware (if needed & existing):
       render: Markdown
     validations:
-      required: false
+      required: true
   - type: markdown
     attributes:
       value: "---"

diff --git a/.gitignore b/.gitignore
@@ -104,10 +104,13 @@ Control.ca-bundle
 Control.system-ca-bundle
 GitHub.sublime-settings
 
-# Visual Studio Code #
+# Visual Studio Code
 .vscode/*
 !.vscode/settings.json
 !.vscode/tasks.json
 !.vscode/launch.json
 !.vscode/extensions.json
 .history
+
+# Fleet
+.fleet
diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@
 
 ## Usage
 
-Linux is currently the best supported platform (tested with Ubuntu 20.04/22.04 LTS). Windows and macOS are also supported, but you might experience more issues.
+Linux is currently the best supported platform (tested with Ubuntu 24.04 LTS). Windows and macOS are also supported, but you might experience more issues.
 
 ### 1. Download OpenAndroidInstaller
 
@@ -197,13 +197,23 @@ Samsung | Galaxy Note 10+ | [d2s](https://wiki.lineageos.org/devices/d2s) | | te
 Vendor | Device Name | CodeName | Models | Status
 ---|---|---|---|---
 Sony | Xperia Z | [yuga](https://wiki.lineageos.org/devices/yuga) | C6603 | tested
-Sony | Xperia Z3 | [z3](https://wiki.lineageos.org/devices/z3) | | tested
-Sony | Xperia 10 | [kirin](https://wiki.lineageos.org/devices/kirin) | | tested
-Sony | Xperia 10 Plus | [mermaid](https://wiki.lineageos.org/devices/mermaid) | | tested
-Sony | Xperia XA2 | [pioneer](https://wiki.lineageos.org/devices/pioneer) | | tested
-Sony | Xperia XZ2 | [akari](https://wiki.lineageos.org/devices/akari) | | tested
-Sony | Xperia XZ3 | [akatsuki](https://wiki.lineageos.org/devices/akatsuki) | | tested
-Sony | Xperia XZ | kagura | | planned
+Sony | Xperia Z3 | [z3](https://wiki.lineageos.org/devices/z3) | D6603 | tested
+Sony | Xperia Z3 Compact | [z3c](https://wiki.lineageos.org/devices/z3c) | D5803, D5833 | untested
+Sony | Xperia 10 | [kirin](https://wiki.lineageos.org/devices/kirin) | I3113, I3123, I4113, I4193 | tested
+Sony | Xperia 10 Plus | [mermaid](https://wiki.lineageos.org/devices/mermaid) | I3213, I3223, I4213, I4293 | tested
+Sony | Xperia XA2 | [pioneer](https://wiki.lineageos.org/devices/pioneer) | H3113, H4113, H3133, H4133, H3123 | tested
+Sony | Xperia XZ Premium | maple | G8141 | untested
+Sony | Xperia XZ Premium Dual Sim | maple_dsds | G8142 | untested
+Sony | Xperia XZ1 | poplar | G8341 | tested
+Sony | Xperia XZ1 Dual Sim | poplar_dsds | G8342 | untested
+Sony | Xperia XZ1 Canada | poplar_canada | G8343 | untested
+Sony | Xperia XZ1 KDDI | poplar_kddi | SOV36 | untested
+Sony | Xperia XZ1 Compact | lilac | G8441, G8442 | untested
+Sony | Xperia XZ2 | [akari](https://wiki.lineageos.org/devices/akari) | H8216, H8266, H8276, H8296 | tested
+Sony | Xperia XZ2 Compact | [xz2c](https://wiki.lineageos.org/devices/xz2c) | H8314, H8324 | untested
+Sony | Xperia XZ2 Premium | [aurora](https://wiki.lineageos.org/devices/aurora) | H8116, H8166 | untested
+Sony | Xperia XZ3 | [akatsuki](https://wiki.lineageos.org/devices/akatsuki) | H8416, H9436, H9493 | tested
+Sony | Xperia XZ | kagura | F8331 | planned
 
 </details>
 

diff --git a/docs/building_the_application_for_your_platform.md b/docs/building_the_application_for_your_platform.md
@@ -9,5 +9,6 @@ If you build the application for your platform and want to contribute the build,
 Currently development is mainly done on Ubuntu Linux. MacOS, Windows, as well as other Linux distributions like Fedora should also work well. You might need to install additional USB-drivers on Windows.
 
 1. Clone the main branch of this repository
-2. Run `make poetry` and `make install` to install poetry to manage python and install the required dependencies like adb, fastboot and heimdall.
-3. Run `make app` to start the desktop app from the source.
+2. Set up [venv](https://docs.python.org/3/library/venv.html)
+3. Run `make poetry` and `make install` to install poetry to manage python and install the required dependencies like adb, fastboot and heimdall.
+4. Run `make app` to start the desktop app from the source.
diff --git a/openandroidinstaller/assets/configs/FP3.yaml b/openandroidinstaller/assets/configs/FP3.yaml
@@ -13,7 +13,7 @@ steps:
         how to start and run an operating system (like Android). Your device should be turned on.
         Click on the button to open the instructions on the Fairphone Support official unlocking website to generate an unlock code for your device.
         Once you've done that, continue.
-      link: https://www.fairphone.com/en/bootloader-unlocking-code-for-fairphone-3/
+      link: https://www.fairphone.com/en/bootloader-unlocking-code-for-fairphone
     - type: call_button
       content: >
         Press 'Confirm and run' to reboot into the bootloader.

diff --git a/openandroidinstaller/assets/configs/FP4.yaml b/openandroidinstaller/assets/configs/FP4.yaml
@@ -13,7 +13,7 @@ steps:
         how to start and run an operating system (like Android). Your device should be turned on.
         Click on the button to open the instructions on the Fairphone Support official unlocking website to generate an unlock code for your device.
         Once you've done that, continue.
-      link: https://www.fairphone.com/en/bootloader-unlocking-code-for-fairphone-3/
+      link: https://www.fairphone.com/en/bootloader-unlocking-code-for-fairphone
     - type: call_button
       content: >
         Press 'Confirm and run' to reboot into the bootloader.

diff --git a/openandroidinstaller/assets/configs/akari.yaml b/openandroidinstaller/assets/configs/akari.yaml
@@ -22,7 +22,7 @@ steps:
       content: >
         Click on the button to open the instructions on Sonys official unlocking website to generate an unlock code for your bootloader.
         Once you got the code write it down somewhere and continue to input the code.
-      link: https://developer.sonymobile.com/unlockbootloader/unlock-yourboot-loader/
+      link: https://developer.sony.com/open-source/aosp-on-xperia-open-devices/get-started/unlock-bootloader
     - type: confirm_button
       content: >
         Connect the device to your PC via USB. And confirm to continue.

diff --git a/openandroidinstaller/assets/configs/akatsuki.yaml b/openandroidinstaller/assets/configs/akatsuki.yaml
@@ -22,7 +22,7 @@ steps:
       content: >
         Click on the button to open the instructions on Sonys official unlocking website to generate an unlock code for your bootloader.
         Once you got the code write it down somewhere and continue to input the code.
-      link: https://developer.sonymobile.com/unlockbootloader/unlock-yourboot-loader/
+      link: https://developer.sony.com/open-source/aosp-on-xperia-open-devices/get-started/unlock-bootloader
     - type: confirm_button
       content: >
         Connect the device to your PC via USB. And confirm to continue.

diff --git a/openandroidinstaller/assets/configs/aurora.yaml b/openandroidinstaller/assets/configs/aurora.yaml
@@ -0,0 +1,63 @@
+metadata:
+  maintainer: Tobias Sterbak (tsterbak)/SirRGB
+  device_name: Sony Xperia XZ2 Premium
+  is_ab_device: true
+  device_code: aurora
+  supported_device_codes:
+    - aurora
+  untested: true
+requirements:
+  android: 10
+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.
+    - type: confirm_button
+      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.
+    - type: link_button_with_confirm
+      content: >
+        Click on the button to open the instructions on Sonys official unlocking website to generate an unlock code for your bootloader.
+        Once you got the code write it down somewhere and continue to input the code.
+      link: https://developer.sony.com/open-source/aosp-on-xperia-open-devices/get-started/unlock-bootloader
+    - type: confirm_button
+      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.
+      command: adb_reboot_bootloader
+    - type: call_button_with_input
+      content: >
+        Use your code to unlock the bootloader of your device. Type in the full 18 character code starting with 0x (Example: 0x3EC4F7AD6E0B32B6).
+        If you already did that, you can skip this step.
+      command: fastboot_unlock_with_code
+    - type: call_button
+      content: >
+        Press the button to reboot. Since the device resets completely, you will need to re-enable USB debugging to continue.
+        Connect your device to your PC via USB. Then confirm here to continue.
+      command: fastboot_reboot
+  boot_recovery:
+    - 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.
+        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.
+      command: fastboot_flash_boot
+    - type: call_button
+      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
+      content: >
+        Now we need to boot into recovery again. Press run and when you see the TWRP screen you can continue.
+      command: fastboot_flash_boot
diff --git a/openandroidinstaller/assets/configs/kirin.yaml b/openandroidinstaller/assets/configs/kirin.yaml
@@ -20,7 +20,7 @@ steps:
       content: >
         Click on the button to open the instructions on Sonys official unlocking website to generate an unlock code for your bootloader.
         Once you got the code write it down somewhere and continue to input the code.
-      link: https://developer.sonymobile.com/unlockbootloader/unlock-yourboot-loader/
+      link: https://developer.sony.com/open-source/aosp-on-xperia-open-devices/get-started/unlock-bootloader
     - type: confirm_button
       content: >
         Connect the device to your PC via USB. And confirm to continue.

diff --git a/openandroidinstaller/assets/configs/lilac.yaml b/openandroidinstaller/assets/configs/lilac.yaml
@@ -0,0 +1,54 @@
+metadata:
+  maintainer: Tobias Sterbak (tsterbak)/SirRGB
+  device_name: Sony Xperia XZ1 Compact
+  is_ab_device: false
+  device_code: lilac
+  supported_device_codes:
+    - lilac
+    - G8441
+  twrp-link: lilac
+  untested: true
+requirements:
+  android: 9
+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.
+    - type: confirm_button
+      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.
+    - type: link_button_with_confirm
+      content: >
+        Click on the button to open the instructions on Sonys official unlocking website to generate an unlock code for your bootloader.
+        Once you got the code write it down somewhere and continue to input the code.
+      link: https://developer.sony.com/open-source/aosp-on-xperia-open-devices/get-started/unlock-bootloader
+    - type: confirm_button
+      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.
+      command: adb_reboot_bootloader
+    - type: call_button_with_input
+      content: >
+        Use your code to unlock the bootloader of your device. Type in the full 18 character code starting with 0x (Example: 0x3EC4F7AD6E0B32B6).
+        If you already did that, you can skip this step.
+      command: fastboot_unlock_with_code
+    - type: call_button
+      content: >
+        Press the button to reboot. Since the device resets completely, you will need to re-enable USB debugging to continue.
+        Connect your device to your PC via USB. Then confirm here to continue.
+      command: fastboot_reboot
+  boot_recovery:
+    - type: call_button
+      content: >
+        Now you have to reboot into bootloader again. With your phone turned on, press the button to do so and continue once it is done.
+      command: adb_reboot_bootloader
+    - type: call_button
+      content: >
+        Next, you need to boot a custom recovery image. Press the button to flash the selected image. Then continue.
+      command: fastboot_flash_boot
diff --git a/openandroidinstaller/assets/configs/maple.yaml b/openandroidinstaller/assets/configs/maple.yaml
@@ -0,0 +1,54 @@
+metadata:
+  maintainer: Tobias Sterbak (tsterbak)/SirRGB
+  device_name: Sony Xperia XZ Premium
+  is_ab_device: false
+  device_code: maple
+  supported_device_codes:
+    - maple
+    - G8141
+  twrp-link: maple
+  untested: true
+requirements:
+  android: 9
+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.
+    - type: confirm_button
+      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.
+    - type: link_button_with_confirm
+      content: >
+        Click on the button to open the instructions on Sonys official unlocking website to generate an unlock code for your bootloader.
+        Once you got the code write it down somewhere and continue to input the code.
+      link: https://developer.sony.com/open-source/aosp-on-xperia-open-devices/get-started/unlock-bootloader
+    - type: confirm_button
+      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.
+      command: adb_reboot_bootloader
+    - type: call_button_with_input
+      content: >
+        Use your code to unlock the bootloader of your device. Type in the full 18 character code starting with 0x (Example: 0x3EC4F7AD6E0B32B6).
+        If you already did that, you can skip this step.
+      command: fastboot_unlock_with_code
+    - type: call_button
+      content: >
+        Press the button to reboot. Since the device resets completely, you will need to re-enable USB debugging to continue.
+        Connect your device to your PC via USB. Then confirm here to continue.
+      command: fastboot_reboot
+  boot_recovery:
+    - type: call_button
+      content: >
+        Now you have to reboot into bootloader again. With your phone turned on, press the button to do so and continue once it is done.
+      command: adb_reboot_bootloader
+    - type: call_button
+      content: >
+        Next, you need to boot a custom recovery image. Press the button to flash the selected image. Then continue.
+      command: fastboot_flash_boot
diff --git a/openandroidinstaller/assets/configs/maple_dsds.yaml b/openandroidinstaller/assets/configs/maple_dsds.yaml
@@ -0,0 +1,54 @@
+metadata:
+  maintainer: Tobias Sterbak (tsterbak)/SirRGB
+  device_name: Sony Xperia XZ Premium Dual Sim
+  is_ab_device: false
+  device_code: maple_dsds
+  supported_device_codes:
+    - maple_dsds
+    - G8142
+  twrp-link: maple_dsds
+  untested: true
+requirements:
+  android: 9
+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.
+    - type: confirm_button
+      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.
+    - type: link_button_with_confirm
+      content: >
+        Click on the button to open the instructions on Sonys official unlocking website to generate an unlock code for your bootloader.
+        Once you got the code write it down somewhere and continue to input the code.
+      link: https://developer.sony.com/open-source/aosp-on-xperia-open-devices/get-started/unlock-bootloader
+    - type: confirm_button
+      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.
+      command: adb_reboot_bootloader
+    - type: call_button_with_input
+      content: >
+        Use your code to unlock the bootloader of your device. Type in the full 18 character code starting with 0x (Example: 0x3EC4F7AD6E0B32B6).
+        If you already did that, you can skip this step.
+      command: fastboot_unlock_with_code
+    - type: call_button
+      content: >
+        Press the button to reboot. Since the device resets completely, you will need to re-enable USB debugging to continue.
+        Connect your device to your PC via USB. Then confirm here to continue.
+      command: fastboot_reboot
+  boot_recovery:
+    - type: call_button
+      content: >
+        Now you have to reboot into bootloader again. With your phone turned on, press the button to do so and continue once it is done.
+      command: adb_reboot_bootloader
+    - type: call_button
+      content: >
+        Next, you need to boot a custom recovery image. Press the button to flash the selected image. Then continue.
+      command: fastboot_flash_boot
diff --git a/openandroidinstaller/assets/configs/mermaid.yaml b/openandroidinstaller/assets/configs/mermaid.yaml
@@ -20,7 +20,7 @@ steps:
       content: >
         Click on the button to open the instructions on Sonys official unlocking website to generate an unlock code for your bootloader.
         Once you got the code write it down somewhere and continue to input the code.
-      link: https://developer.sonymobile.com/unlockbootloader/unlock-yourboot-loader/
+      link: https://developer.sony.com/open-source/aosp-on-xperia-open-devices/get-started/unlock-bootloader
     - type: confirm_button
       content: >
         Connect the device to your PC via USB. And confirm to continue.

diff --git a/openandroidinstaller/assets/configs/pioneer.yaml b/openandroidinstaller/assets/configs/pioneer.yaml
@@ -22,7 +22,7 @@ steps:
       content: >
         Click on the button to open the instructions on Sonys official unlocking website to generate an unlock code for your bootloader.
         Once you got the code write it down somewhere and continue to input the code.
-      link: https://developer.sonymobile.com/unlockbootloader/unlock-yourboot-loader/
+      link: https://developer.sony.com/open-source/aosp-on-xperia-open-devices/get-started/unlock-bootloader
     - type: confirm_button
       content: >
         Connect the device to your PC via USB. And confirm to continue.