Merge branch 'staging/ota-streaming'

features/updates-and-ota.md

@@ -14,44 +14,139 @@ If you have installed the OS using the Bootable USB installer, then you can also
 
 Once selected, the device will boot into the OEM installer and auto-update the existing OS on the device. 
 
+### OTA - Local Streaming
+
+The UpdateService AIDL allows us to stream an OTA zip from the local device or network attached endpoint. 
+
+The UpdaterSDK interface has three main parts: \
+
+#### IUpdater.aidl
+
+```
+interface IUpdater {
+   void setCallback(IUpdaterCallback cb);
+   void checkForUpdates();
+   List<UpdateItemInfo> getAvaliableUpdates();
+   void downloadUpdate(String id);
+   void pauseDownload(String id);
+   void resumeDownload(String id);
+   void installUpdate(String id);
+   void cancelUpdate();
+   void suspendUpdate();
+   void resumeUpdate();
+
+   void importUpdate(in ParcelFileDescriptor pfd);
+}
+```
+
+#### IUpdaterCallback.aidl
+
+```
+interface IUpdaterCallback {
+   void onUpdateCheckCompleted(boolean hasNewUpdates);
+
+   void onStatusChange(in UpdateItemInfo update);
+   void onDownloadProgressChange(in UpdateItemInfo update);
+   void onInstallProgress(in UpdateItemInfo update);
+
+   void onImportStarted();
+   void onImportCompleted(in UpdateItemInfo updateBase);
+}
+```
+
+#### UpdateItemInfo.aidl
+
+```
+parcelable UpdateItemInfo {
+   String name;
+   String downloadUrl;
+   String downloadId;
+   long timestamp;
+   String version;
+   long fileSize;
+
+   int status;
+   int persistentStatus;
+   int progress;
+   long eta;
+   long speed;
+   int installProgress;
+   boolean availableOnline;
+   boolean finalizing;
+}
+```
+
+You can use the BlissUpdaterSDK-debug.aar from your target app to stream all required update information to the BlissUpdater app and system update engine. 
+
+#### Example: UpdaterClient
+
+The UpdaterClient app acts as an example app for interfacing with the BlissUpdaterSDK. The apps MainActivity calls the AIDL methods with each button, and prints out the output in the textbox above. 
+
+![alt_text](images/image1.png "image_tooltip")
+
+Clicking **Select update file** will launch the `ACTION_GET_CONTENT` intent and then the `ParcelFileDescriptor` will be passed to the UpdaterManager.importUpdate. And the import process is triggered, import results can be observed from callbacks onImportStarted and onImportCompleted
+
+![alt_text](images/image2.png "image_tooltip")
+
+Once the import status is complete, the output will be the imported files information:
+
+![alt_text](images/image3.png "image_tooltip")
+
+Using the imported ID (in this case, **local**), we can enter the ID and initiate the Install process:
+
+![alt_text](images/image4.png "image_tooltip")
+
+From there, it will also register the updater service notification:
+
+![alt_text](images/image5.png "image_tooltip")
+
+Once the install process starts, it will have a status of **9** and you can track the **installProgress** percentage. 
+
+![alt_text](images/image6.png "image_tooltip")
+
+And after that is complete the **finalizing** process is started and set to **true** and the **installProgress** will track the process percentage.
+
+![alt_text](images/image7.png "image_tooltip")
+
+Then after receiving a status of **10 (Installed)** or **5 (tmp zip Deleted)**, then the updater service will trigger for a restart. And we can display that in the example by enabling that action
+
+
+![alt_text](images/image8.png "image_tooltip")
+
+The restart is carried out by the BlissPowerManager:
+
+```
+BlissPowerManager blissPowerManager = BlissPowerManager.getInstance(this);
+       mRebootBtn.setOnClickListener(v -> blissPowerManager.reboot());
+```
 
 ### OTA - Local Server
 
 By default, testing OTA on an unsecured HTTP server is disabled. In order to test OTA, you will need to setup a secured HTTPS nginx server, or change this line in the Updater package to **True**: [https://github.com/BlissRoms/platform_packages_apps_BlissUpdater/blob/arcadia-next/AndroidManifest.xml#L23](https://github.com/BlissRoms/platform_packages_apps_BlissUpdater/blob/arcadia-next/AndroidManifest.xml#L23)  \
 Then recompile BlissBass to disable this security measure. 
 
-
 #### Manually setting OTA URI address:
 
 We do allow the ability to manually set the OTA update URI via kernel cmdline interface. This allows you to set the value only when needed for added security. To do so, you should add the following value:
 
-
-
 * `SET_CUSTOM_OTA_URI` - Sets the custom URL for OTA updates
 
-
 ```
 SET_CUSTOM_OTA_URI=https://192.168.1.1/updates/update.json
 ```
 
-
 Or you can set the following system property via ADB:
 
-
-
 * `bliss.updater.uri`
 
-
 ```
 Setprop bliss.updater.uri https://192.168.1.1/updates/update.json
 ```
 
-
 Setting Up The Server:
 
 On the server, we will need to have it setup as a basic nginx web server, with the OTA update .zip located in the same folder as the update.json, with the updates/update.json file formatted like this:
 
-
 ```
 {
    "response": [
@@ -68,40 +163,28 @@ On the server, we will need to have it setup as a basic nginx web server, with t
 }
 ```
 
-
 The values are as follows:
 
-
-
 * “**datetime**” - is calculated using the date command. Example: 
 
-
 ```
 $ date --date='2023-10-31 19:00' +"%s"
 
 ```
 
-
-
 * “**id**” -  is the sha256 value. Example:
 
-
 ```
 $ sha256sum Bliss-Go-v15.8.6-x86_64-OFFICIAL-vanilla-20231031.zip
 
 ```
 
-
-
 * “**size**” - is the size in bytes. Example: 
 
-
 ```
 $ wc -c Bliss-Go-v15.8.6-x86_64-OFFICIAL-vanilla-20231031.zip
 ```
 
-
-
 ### OTA - Dedicated Update Server
 
 **ShipperStack**