Skip to content

Commit b2bbfa0

Browse files
committed
Update readme and fix some configs
1 parent bcad346 commit b2bbfa0

File tree

4 files changed

+6
-11
lines changed

4 files changed

+6
-11
lines changed

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ Sony | Xperia Z | yuga | C6603 | tested
4545
Sony | Xperia Z3 | z3 | | under development
4646
Sony | Xperia ZX | kagura | | planned
4747
Fairphone | Fairphone 2 | FP2 | | under development
48-
Fairphone | Fairphone 3 | FP3 | | under development
49-
Motorola | Moto G5 | cedric | | planned
48+
Fairphone | Fairphone 3 | FP3 | | tested
49+
Motorola | moto G5 | cedric | | planned
5050
Motorola | moto g7 power | ocean | | under development
5151

5252

@@ -87,18 +87,14 @@ If you want to use the tool for a non-supported smartphone, the fastest way is t
8787
#### Content of a config file
8888

8989
Every step in the config file corresponds to one view in the application. These steps should contain the following fields:
90-
- `title`: str; Describing the overall goal of the step. Will be displayed in the header of the view.
9190
- `type`: str; Corresponds to the type of view to generate. There are the following options:
9291
- `text`: Just display the text given in content.
9392
- `confirm_button`: Display the content, as well as a button to allow the user to go to the next step.
9493
- `call_button`: Display the content text and a button that runs a given command. After the command is run, a confirm button is displayed to allow the user to move to the next step.
9594
- `call_button_with_input`: Display the content text, an input field and a button that runs a given command. The inputtext, can be used in the command by using the `<inputtext>` placeholder in the command field. After the command is run, a confirm button is displayed to allow the user to move to the next step.
9695
- `link_button_with_confirm`: Display a button that opens a browser with a given link, confirm afterwards. Link is given in `link`.
9796
- `content`: str; The content text displayed alongside the action of the step. Used to inform the user about whats going on.
98-
- `command`: [ONLY for call_button* steps] str; This is a terminal command run in a shell. (For example fastboot or adb). There are three types of placeholders supported, that will be filled by the tool as soon as information is given.
99-
- `<image>`: The path of the ROM image file.
100-
- `<recovery>`: The path of the recovery file.
101-
- `<inputtext>`: Text from the user input from `call_button_with_input` views.
97+
- `command`: [ONLY for call_button* steps] str; The command to run. One of `adb_reboot`, `adb_reboot_bootloader`, `adb_reboot_download`, `adb_sideload`, `adb_twrp_wipe_and_install`, `fastboot_flash_recovery`, `fastboot_unlock_with_code`, `fastboot_unlock`, `fastboot_oem_unlock`, `fastboot_reboot`, `heimdall_flash_recovery`.
10298
- `img`: [OPTIONAL] Display an image on the left pane of the step view. Images are loaded from `openandroidinstaller/assets/imgs/`.
10399
- `allow_skip`: [OPTIONAL] boolean; If a skip button should be displayed to allow skipping this step. Can be useful when the bootloader is already unlocked.
104100
- `link`: [OPTIONAL] Link to use for the link button if type is `link_button_with_confirm`.

openandroidinstaller/assets/configs/FP3.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ metadata:
44
devicecode: FP3
55
steps:
66
unlock_bootloader:
7-
- title: "Unlock the bootloader"
8-
type: link_button_with_confirm
7+
- type: link_button_with_confirm
98
content: >
109
As a first step, you need to unlock the bootloader. A bootloader is the piece of software, that tells your phone
1110
how to start and run an operating system (like Android). Your device should be turned on.

openandroidinstaller/assets/configs/herolte.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ steps:
1010
As a first step, you need to boot into the bootloader. A bootloader is the piece of software,
1111
that tells your phone who to start and run an operating system (like Android). Your device should be turned on.
1212
Then press 'Confirm and run' to reboot into the bootloader. Continue once it's done.
13-
command: "adb reboot download"
13+
command: adb_reboot_download
1414
- type: call_button
1515
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.
1616
command: heimdall_flash_recovery

openandroidinstaller/installer_config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ def validate_config(config: str) -> bool:
119119
r"text|confirm_button|call_button|call_button_with_input|link_button_with_confirm"
120120
),
121121
"content": str,
122-
schema.Optional("command"): Regex(r"adb_reboot|adb_reboot_bootloader|adb_reboot_download|adb_sideload|adb_twrp_wipe_and_install|fastboot_flash_recovery|fastboot_unlock_with_code|fastboot_unlock|fastboot_reboot|heimdall_flash_recovery"),
122+
schema.Optional("command"): Regex(r"adb_reboot|adb_reboot_bootloader|adb_reboot_download|adb_sideload|adb_twrp_wipe_and_install|fastboot_flash_recovery|fastboot_unlock_with_code|fastboot_unlock|fastboot_oem_unlock|fastboot_reboot|heimdall_flash_recovery"),
123123
schema.Optional("allow_skip"): bool,
124124
schema.Optional("img"): str,
125125
schema.Optional("link"): str,

0 commit comments

Comments
 (0)