Hot update

Official hot-update service

• Official hot update

What is hot update?

• Hot update lets you refresh critical code without reinstalling the app
• EC hot update is mainly for packaged automation test scripts
• Note: keep update.json version in sync with your server response, or unexpected behavior may occur

How EC hot update works

• Prefer the official service: Official hot update

Open update.json in your project:

1
{
2
 "update_url": "http://baidu.com/update",
3
 "version": "1.0.0",
4
 "appendDeviceInfo": true,
5
 "timeout": 30000
6
}

• Parameters
• update_url: your server update endpoint — implement this yourself
• version: current script version
• timeout: 9.13.0+ request timeout in ms (minimum 1000)
• appendDeviceInfo: 9.23.0+ append basic device info to the request
• When true, these query params are added automatically (existing URL params remain):

EC loads the new package

Client request

• After configuration, build and run — the app sends a GET to update_url with parameters, e.g. http://baidu.com/update?version=1.0.0. Compare versions on your server.

Server response

Expected response format:

• Standard update

1
{
2
  "download_url": "http://baidu.com/aaa.iec",
3
  "version": "1.1.0",
4
  "dialog": true,
5
  "msg": "Bug fixes and improvements",
6
  "force": false
7
}

• Strict mode — MD5 check to prevent failed updates

1
{
2
  "download_url": "http://baidu.com/aaa.iec",
3
  "version": "1.1.0",
4
  "dialog": true,
5
  "msg": "Bug fixes and improvements",
6
  "force": false,
7
  "md5": "MD5 of the IEC file computed on your server",
8
  "download_timeout": 60
9
}

• download_url: URL of the new package
• version: new package version
• md5: IEC file MD5 — when present, EC verifies file integrity
• EC downloads and loads the new IEC when this JSON is returned
• dialog: show a dialog (true) or silent update (false)
• msg: message shown in the dialog
• force: in dialog mode, force update (true = cannot cancel)
• download_timeout: 7.11.0+ download timeout in seconds (default 60)

UI startup update

• With the above configured, the UI checks for updates on launch

In-script hot update

• You can trigger hot update during script execution using the APIs below

hotupdater.updateReq — request update

• Calls the hot-update endpoint. false may mean no update is needed — use getErrorMsg() for details.
• @param updateUrl Update URL — omit to use update.json
• @param version Current version as an integer, e.g. 1
• @param appendDeviceInfo Append device info — true or false
• @param timeout Request timeout in ms
• @return {bool} true = update available; false = no update

1
function main() {
2
    // Read version from update.json in the project
3
    let version = JSON.parse(readIECFileAsString("update.json")).version
4
    // Or define version manually:
5
    // let version = 7;
6
    toast("Hello World - " + version);
7
    // Check server for a new version
8
    // Using update.json:
9
    //let updateResult = hotupdater.updateReq("",version,true,9000);
10
    // Custom URL:
11
    let updateResult = hotupdater.updateReq("http://baidu.com", version, true, 9000);
12
    logd("Update check result: " + updateResult);
13
    if (!updateResult) {
14
        logw("Request failed: " + hotupdater.getErrorMsg());
15
    } else {
16
        logd("Update response: " + hotupdater.getUpdateResp());
17
        // Download new version when an update is available
18
        let path = hotupdater.updateDownload();
19
        logd("Download path: " + path);
20
        if (!path) {
21
            logw("IEC download error: " + hotupdater.getErrorMsg());
22
        } else {
23
            restartScript(path, true, 3)
24
            return;
25
        }
26
    }
27
    sleep(1000);
28
    for (var i = 0; i < 10; i++) {
29
        logd(time() + " " + version);
30
        sleep(5000)
31
    }
32
}
33

34
main();

hotupdater.updateDownload — download IEC

• Downloads the IEC from the hot-update response
• EC 5.20.0+
• @return {string} Path to the downloaded hot-update file; empty if no update
• See example

hotupdater.getUpdateResp — get response

• Returns the hot-update request response
• EC 5.20.0+
• @return {string} Response string
• See example

hotupdater.getErrorMsg — get error message

• Returns hot-update error details
• EC 5.20.0+
• @return {string} Error string
• See example