summaryrefslogtreecommitdiffstats
path: root/updater_sample
diff options
context:
space:
mode:
authorZhomart Mukhamejanov <zhomart@google.com>2018-06-05 01:19:05 +0200
committerGerrit Code Review <noreply-gerritcodereview@google.com>2018-06-05 01:19:05 +0200
commite36b6ec97cc055cc8ce0e7f8fab1892bd2ffecdf (patch)
treed583649314e9015dbbda825f37b383e38eb21339 /updater_sample
parentMerge "updater_sample: improve updater state handling" (diff)
parentupdater_sample: Add UI docs to README (diff)
downloadandroid_bootable_recovery-e36b6ec97cc055cc8ce0e7f8fab1892bd2ffecdf.tar
android_bootable_recovery-e36b6ec97cc055cc8ce0e7f8fab1892bd2ffecdf.tar.gz
android_bootable_recovery-e36b6ec97cc055cc8ce0e7f8fab1892bd2ffecdf.tar.bz2
android_bootable_recovery-e36b6ec97cc055cc8ce0e7f8fab1892bd2ffecdf.tar.lz
android_bootable_recovery-e36b6ec97cc055cc8ce0e7f8fab1892bd2ffecdf.tar.xz
android_bootable_recovery-e36b6ec97cc055cc8ce0e7f8fab1892bd2ffecdf.tar.zst
android_bootable_recovery-e36b6ec97cc055cc8ce0e7f8fab1892bd2ffecdf.zip
Diffstat (limited to 'updater_sample')
-rw-r--r--updater_sample/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/updater_sample/README.md b/updater_sample/README.md
index f6c63a7b6..8ec43d3c6 100644
--- a/updater_sample/README.md
+++ b/updater_sample/README.md
@@ -91,6 +91,31 @@ If they doesn't match, sample app calls `applyPayload` again with the same
parameters, and handles update completion properly using `onPayloadApplicationCompleted`
callback. The second problem is solved by adding `PAUSED` updater state.
+
+## Sample App UI
+
+### Text fields
+
+- `Current Build:` - shows current active build.
+- `Updater state:` - SystemUpdaterSample app state.
+- `Engine status:` - last reported update_engine status.
+- `Engine error:` - last reported payload application error.
+
+### Buttons
+
+- `Reload` - reloads update configs from device storage.
+- `View config` - shows selected update config.
+- `Apply` - applies selected update config.
+- `Stop` - cancel running update, calls `UpdateEngine#cancel`.
+- `Reset` - reset update, calls `UpdateEngine#resetStatus`, can be called
+ only when update is not running.
+- `Suspend` - suspend running update, uses `UpdateEngine#cancel`.
+- `Resume` - resumes suspended update, uses `UpdateEngine#applyPayload`.
+- `Switch Slot` - if `ab_config.force_switch_slot` config set true,
+ this button will be enabled after payload is applied,
+ to switch A/B slot on next reboot.
+
+
## Sending HTTP headers from UpdateEngine
Sometimes OTA package server might require some HTTP headers to be present,