Skip to content

Commit

Permalink
Update test and fix configs
Browse files Browse the repository at this point in the history
  • Loading branch information
tsterbak committed Mar 23, 2023
1 parent c7706b9 commit 13a9751
Show file tree
Hide file tree
Showing 50 changed files with 197 additions and 128 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ All kinds of contributions are welcome. These include:

### How to contribute your own installation configurations

If you want to use the tool for a non-supported smartphone, the fastest way is to adapt an [existing config file](https://github.com/openandroidinstaller-dev/openandroidinstaller/tree/main/openandroidinstaller/assets/configs). The file should be named after the `device code` of your device. This is in general the output by `adb shell getprop | grep ro.product.device` when the devices is connected to the computer. You can also get the device code by connecting the device to the computer and run OpenAndroidInstaller to detect the device.
If you want to use the tool for a non-supported smartphone, the fastest way is to adapt an [existing config file](https://github.com/openandroidinstaller-dev/openandroidinstaller/tree/main/openandroidinstaller/assets/configs). The file should be named after the official `device code` of the device. Add the code output by `adb shell getprop | grep ro.product.device` (when the devices is connected to the computer) as well as the official device code to the `supported_device_codes` list in the config. You can also get the device code by connecting the device to the computer and run OpenAndroidInstaller to detect the device.

**To test your config file with the executable** without using the developer setup, place it in the same directory as the executable. There it will be detected by name. After you created a config file and it works fine, you can open a pull request to make the file available to other users. Please also add the device to the supported devices table above.

Expand All @@ -196,8 +196,9 @@ A config file consists of two parts. The first part are some metadata about the
##### How to write Metadata
Every config file should have metadata with the following fields:
- `maintainer`: str; Maintainer and author of the config file.
- `devicename`: str; Name of the device.
- `devicecode`: str; The official device code.
- `device_name`: str; Name of the device.
- `device_code`: str; The official device code.
- `supported_device_codes`: List[str]; A list of supported device codes for the config. The config will be loaded based on this field.
- `twrp-link`: [OPTIONAL] str; name of the corresponding twrp page.

In addition to these metadata, every config can have optional requirements. If these are set, the user is asked to check if they are meet.
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/FP2.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Fairphone 2
devicecode: FP2
device_name: Fairphone 2
device_code: FP2
supported_device_codes:
- FP2
steps:
unlock_bootloader:
flash_recovery:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/FP3.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Fairphone 3
devicecode: FP3
device_name: Fairphone 3
device_code: FP3
supported_device_codes:
- FP3
steps:
unlock_bootloader:
- type: link_button_with_confirm
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/FP4.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Fairphone 4
devicecode: FP4
device_name: Fairphone 4
device_code: FP4
supported_device_codes:
- FP4
steps:
unlock_bootloader:
- type: link_button_with_confirm
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/a3y17lte.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Samsung Galaxy A3 (2017)
devicecode: a3y17lte
device_name: Samsung Galaxy A3 (2017)
device_code: a3y17lte
supported_device_codes:
- a3y17lte
steps:
unlock_bootloader:
flash_recovery:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/a5xelte.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Samsung Galaxy A5 (2016)
devicecode: a5xelte
device_name: Samsung Galaxy A5 (2016)
device_code: a5xelte
supported_device_codes:
- a5xelte
steps:
unlock_bootloader:
flash_recovery:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/a72q.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Samsung Galaxy A72
devicecode: a72q
device_name: Samsung Galaxy A72
device_code: a72q
supported_device_codes:
- a72q
steps:
unlock_bootloader:
flash_recovery:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/a7xelte.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Samsung Galaxy A7 (2016)
devicecode: a7xelte
device_name: Samsung Galaxy A7 (2016)
device_code: a7xelte
supported_device_codes:
- a7xelte
steps:
unlock_bootloader:
flash_recovery:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/akari.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Sony Xperia XZ2
devicecode: akari
device_name: Sony Xperia XZ2
device_code: akari
supported_device_codes:
- akari
requirements:
android: 10
steps:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/akatsuki.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Sony Xperia XZ3
devicecode: akatsuki
device_name: Sony Xperia XZ3
device_code: akatsuki
supported_device_codes:
- akatsuki
requirements:
android: 10
steps:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/barbet.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Pixel 5a
devicecode: barbet
device_name: Pixel 5a
device_code: barbet
supported_device_codes:
- barbet
requirements:
android: 12.1.0
steps:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/beyond0lte.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Samsung Galaxy S10e
devicecode: beyond0lte
device_name: Samsung Galaxy S10e
device_code: beyond0lte
supported_device_codes:
- beyond0lte
requirements:
android: 12
steps:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/beyond1lte.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Samsung Galaxy S10
devicecode: beyond1lte
device_name: Samsung Galaxy S10
device_code: beyond1lte
supported_device_codes:
- beyond1lte
requirements:
android: 12
steps:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/beyond2lte.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Samsung Galaxy S10+
devicecode: beyond2lte
device_name: Samsung Galaxy S10+
device_code: beyond2lte
supported_device_codes:
- beyond2lte
requirements:
android: 12
steps:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/blueline.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Google Pixel 3
devicecode: blueline
device_name: Google Pixel 3
device_code: blueline
supported_device_codes:
- blueline
requirements:
android: 12
steps:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/bonito.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Google Pixel 3a XL
devicecode: bonito
device_name: Google Pixel 3a XL
device_code: bonito
supported_device_codes:
- bonito
requirements:
android: 12.1.0
steps:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/cedric.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Motorola Moto G5
devicecode: cedric
device_name: Motorola Moto G5
device_code: cedric
supported_device_codes:
- cedric
steps:
unlock_bootloader:
- type: call_button
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/coral.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Google Pixel 4 XL
devicecode: coral
device_name: Google Pixel 4 XL
device_code: coral
supported_device_codes:
- coral
requirements:
android: 13
steps:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/crosshatch.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Google Pixel 3 XL
devicecode: crosshatch
device_name: Google Pixel 3 XL
device_code: crosshatch
supported_device_codes:
- crosshatch
requirements:
android: 12
steps:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/crownlte.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Samsung Galaxy Note 9
devicecode: crownlte
device_name: Samsung Galaxy Note 9
device_code: crownlte
supported_device_codes:
- crownlte
requirements:
android: 10
steps:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/d1.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Samsung Galaxy Note 10
devicecode: d1
device_name: Samsung Galaxy Note 10
device_code: d1
supported_device_codes:
- d1
requirements:
android: 12
steps:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/evert.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Motorola moto g6 plus
devicecode: evert
device_name: Motorola moto g6 plus
device_code: evert
supported_device_codes:
- evert
steps:
unlock_bootloader:
- type: call_button
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/flame.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Pixel 4
devicecode: flame
device_name: Pixel 4
device_code: flame
supported_device_codes:
- flame
requirements:
android: 13
steps:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/greatlte.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Michel Memeteau (freechelmi)
devicename: Samsung Galaxy note 8
devicecode: greatlte
device_name: Samsung Galaxy note 8
device_code: greatlte
supported_device_codes:
- greatlte
steps:
unlock_bootloader:
flash_recovery:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/griffin.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: SirRGB
devicename: Motorola Moto Z
devicecode: griffin
device_name: Motorola Moto Z
device_code: griffin
supported_device_codes:
- griffin
steps:
unlock_bootloader:
- type: call_button
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/hero2lte.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Samsung Galaxy S7 Edge
devicecode: hero2lte
device_name: Samsung Galaxy S7 Edge
device_code: hero2lte
supported_device_codes:
- hero2lte
steps:
unlock_bootloader:
flash_recovery:
Expand Down
7 changes: 5 additions & 2 deletions openandroidinstaller/assets/configs/herolte.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Samsung Galaxy S7
devicecode: herolte
device_name: Samsung Galaxy S7
device_code: herolte
supported_device_codes:
- herolte
- heroltexx
steps:
unlock_bootloader:
flash_recovery:
Expand Down
22 changes: 0 additions & 22 deletions openandroidinstaller/assets/configs/heroltexx.yaml

This file was deleted.

6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/hltetmo.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Samsung Galaxy Note 3 LTE (N900T/V/W8)
devicecode: hltetmo
device_name: Samsung Galaxy Note 3 LTE (N900T/V/W8)
device_code: hltetmo
supported_device_codes:
- hltetmo
steps:
unlock_bootloader:
flash_recovery:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/j7elte.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Samsung Galaxy J7 (2015)
devicecode: j7elte
device_name: Samsung Galaxy J7 (2015)
device_code: j7elte
supported_device_codes:
- j7elte
steps:
unlock_bootloader:
flash_recovery:
Expand Down
6 changes: 4 additions & 2 deletions openandroidinstaller/assets/configs/kiev.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
metadata:
maintainer: Tobias Sterbak (tsterbak)
devicename: Motorola moto g 5G / one 5G ace
devicecode: kiev
device_name: Motorola moto g 5G / one 5G ace
device_code: kiev
supported_device_codes:
- kiev
steps:
unlock_bootloader:
- type: call_button
Expand Down
Loading

0 comments on commit 13a9751

Please sign in to comment.