> For the complete documentation index, see [llms.txt](https://docs.spectralink.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.spectralink.net/amie-essentials/applications/sys-updater.md). # Sys Updater ![](https://3032864282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxfLF6IpyutR429bMnvvf%2Fuploads%2Fgit-blob-a0ba8cfba43312c7100a0b572f589cc4af0a694e%2Fimage174.png?alt=media) The factory-installed software in your Versity phones must be updated periodically. With SAM, you can send a notification to devices to contact an HTTP server and download updated software. {% hint style="warning" %} **Upgrade incrementally** SAM must be upgraded one revision at a time. If your SAM server is behind more than one revision, it must be upgraded to any intermediate released version before the most recent upgrade will be permitted. {% endhint %} Stagger the updating process so your APs are not overloaded. When updating more than 1000 devices at a time, SAM may display a spinning gear icon until the operation completes. Software releases are available at [Spectralink Support](https://support.spectralink.com/s/product-documents/products?type=handsets\&category=wifi). You must have a current service agreement to download updates. Complete information about the options offered by SAM can be found in the *Versity Applications Administration Guide*, available online at the Spectralink support site (see Appendix A: Spectralink References). Only a brief summary is provided here. {% hint style="info" %} **LTE Smartphones using VPN?** System updating is available by using a metered network but may not be advisable when LTE Versity smartphones are using VPN to connect to the update server. {% endhint %} ![](https://3032864282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxfLF6IpyutR429bMnvvf%2Fuploads%2Fgit-blob-52b4026b3200e76758c2aa18912f8b0540fd56c8%2Fimage175.png?alt=media) ## Trigger OTA Selecting this option and clicking **Save Configuration** will cause each phone’s Android OS to schedule a software update to be executed when Android determines optimal system resources are available. Updating options can be found in the *Versity Applications Administration Guide*, available online at the Spectralink support site. {% hint style="warning" %} **Don’t forget to click Save Configuration** The Trigger OTA command will not activate until you click **Save Configuration**. {% endhint %} **Entry criteria** | | | | ------------- | ------------------------------------------------- | | **Type** | Radio button | | **Default** | Disabled | | **Unique?** | No | | **Required?** | See above | | **Level** | Device | | **Notes** | See *Versity* *Applications Administration Guide* | ## Force Reboot After OTA Update When checked, the Versity smartphone will automatically reboot after an update is downloaded. When using SAM to trigger an update, the phone will download the version specified by SAM. After the code is delivered, the phone must be manually rebooted in order to apply the new version. This can be inconvenient when deploying a large number of phones, such as during initial deployment. **Force reboot** allows the administrator to choose to have the phone automatically reboot as soon as the update file is finished downloading. This option applies the update without any additional action by either the administrator or the user. {% hint style="warning" %} **Force Reboot is disruptive if used on a live system** If used on a live system this option will interrupt whatever a user is doing on their phone (phone call, EMR data entry, etc.). Therefore, the Force Reboot option must be used with careful consideration of the effect on users’ activities. {% endhint %} Because of its potential for disruption, the feature requires re-arming every time it is intended to be used. To re-arm, uncheck the **Force reboot** check box and click **SAVE**, then enable the check box and click **SAVE** again. **Entry criteria** | | | | ------------- | ----------------------------------------------------------- | | **Type** | Radio button | | **Default** | Off | | **Unique?** | No | | **Required?** | No | | **Level** | As needed | | **Notes** | See above and *Versity* *Applications Administration Guide* | ## Server Address The IP address or hostname of the OTA server. See the *Versity* *Applications Administration Guide* for additional information about configuring OTA server parameters. **Entry criteria** | | | | ------------- | ------------------------------------------------------------------- | | **Type** | Dotted-decimal IP address or FQDN | | **Default** | None | | **Unique?** | No | | **Required?** | Yes, for OTA update support | | **Level** | Enterprise | | **Notes** | Must be set manually at the Enterprise level for OTA update support | ## Server Port **Entry criteria** | | | | ------------- | ----------------------------------------------------------------------- | | **Type** | Numeric value; See above. | | **Default** | Leaving this value blank will enter the default value | | **Unique?** | No | | **Required?** | Yes, for OTA update support | | **Level** | Enterprise | | **Notes** | Must be enabled manually at the Enterprise level for OTA update support | ## \*Relative Path on Server \* {% hint style="info" %} **Use full file name for Sys Updater relative path setting** You must include the full filename in the relative path setting; for example: /apollo-ota\_update-signed-1.0.0.741-to-1.0.0.784.zip {% endhint %} If necessary, enter the relative path, which would be relative to the server name. {% hint style="info" %} **Are downgrades possible?** In the unlikely event you need to downgrade phones, contact Spectralink for a custom file. {% endhint %} **Entry criteria** | | | | ------------- | ----------------------------------------------- | | **Type** | Text field: full path name | | **Default** | None | | **Unique?** | No | | **Required?** | No | | **Level** | Enterprise usually, but may be set at any level | | **Notes** | See above | ## *Network Protocol* HTTP and HTTPS are available. **Entry criteria** | | | | ------------- | ----------------------------------------------- | | **Type** | Dropdown menu | | **Default** | HTTP | | **Unique?** | No | | **Required?** | See above | | **Level** | Enterprise usually, but may be set at any level | | **Notes** | | ## *Polling Interval* Polling Interval specifies when or how often the phone will check the specified server to determine if a new version of firmware (ota-update.bin file) is available. Three settings are available. * **SAM only**\ The phone will check for and download new firmware (if available) only when the upgrade process is initiated by an administrator through the **Trigger OTA** option (see section above). *NOTE for 97 Series:* Under this setting if a 97 Series phone is rebooted while downloading the update it will *not* resume the download after the reboot, and an administrator will need to retrigger the download. This behavior does not occur if the download is triggered using the *On Boot Only* or *Background* settings. * **On Boot Only**\ The phone will check for and download new firmware if available any time the device is rebooted. * **Background**\ The phone randomly checks any time within 24 hours. This option is designed to stagger updates to not overload the system. **Entry criteria** | | | | ------------- | ----------------------------------------------- | | **Type** | Dropdown menu | | **Default** | SAM only | | **Unique?** | No | | **Required?** | See above | | **Level** | Enterprise usually, but may be set at any level | | **Notes** | See above | {% hint style="info" %} **Dozing phone checks for updates** Smartphones in Doze mode check for updates at maintenance intervals. Doze is an Android-controlled feature to preserve battery life while the phone is not in use. {% endhint %} {% hint style="info" %} **Phone prompt overrides SAM settings** The manual **Check for update** button in the Sys Updater app on the phone will override SAM settings. When that button is clicked, the phone will check for a software update and download it no matter what settings are selected here. {% endhint %} {% hint style="info" %} **NOTE *****When are updates applied?*** The handset will check for and download the update but will not apply it until the handset is rebooted or the user initiates the update from the Notification bar. {% endhint %} ## Revert Last Upgrade Password This field records the password to be used if the “revert last upgrade” feature is activated. {% hint style="info" %} **Revert Last Upgrade is different on our Android 13 phones** *Revert Last Upgrade* requires a different procedure on our Android 13 phones compared to our previous Android 10 phones. See the *Versity Applications Administration Guide* for details. {% endhint %} **Entry criteria** | | | | ------------- | ----------------------------------------------- | | **Type** | Text field | | **Default** | None | | **Unique?** | No | | **Required?** | No | | **Level** | Enterprise usually, but may be set at any level | | **Notes** | See above | ## User Can Edit Wi-Fi Network Configuration This setting allows the administrator to select whether to allow a user to edit the “Allow on metered network” and “Wi-Fi Network Configuration” settings. **Entry criteria** | | | | ------------- | -------------------------------------------- | | **Type** | Dropdown menu | | **Default** | User cannot edit Wi-Fi network configuration | | **Unique?** | No | | **Required?** | See above | | **Level** | | | **Notes** | See above | ## Apply Update when Charging When this setting is enabled, if a phone is charging and a software update is available, a notification will appear on the screen displaying a 30-second countdown. If the user does not cancel the operation during the countdown, the phone will reboot and apply the update. This setting is disabled by default. **Entry criteria** | | | | ------------- | ------------ | | **Type** | Radio button | | **Default** | Disabled | | **Unique?** | No | | **Required?** | See above | | **Level** | Device | | **Notes** | See above | ## Allow on Metered Network This gives the phone access to metered networks. Charges may be incurred. **Entry criteria** | | | | ------------- | ------------ | | **Type** | Radio button | | **Default** | Disabled | | **Unique?** | No | | **Required?** | See above | | **Level** | Device | | **Notes** | See above | ## Wi-Fi Network Configuration The Wi-Fi Network Configuration setting allows the administrator to select whether to allow the phone to contact Sys Updater over the facility’s VPN network. **Entry criteria** | | | | ------------- | --------------------------------- | | **Type** | Dropdown menu | | **Default** | Use only unmetered Wi-Fi networks | | **Unique?** | No | | **Required?** | See above | | **Level** | | | **Notes** | See above | ## Delay OS Update 1. Navigate to **Sys Updater > Delay OS update**. Change that setting to **True**. 2. Enter all the other settings required to update the OS on device. 3. Click **Trigger OTA** to start the download process. Since in Step 1 the setting has been changed to True, the device will not show a notification of OS download in progress. While the Sys Updater app will show the status of the download, the user would typically not be aware of the updating process. {% hint style="info" %} **Cannot Revert Last Upgrade** The update process “stores” the previous version in a second “slot” in the phone. This feature of the phone allows the possibility of reverting to the previous version as detailed above. The Delay OS Update procedure uploads the version to be delayed into this same slot, overwriting the previous version. Therefore, once the upload is begun, the *Revert Last Upgrade* procedure is no longer available. {% endhint %} If the phone is rebooted after the download is complete, the OS will not update. You can check the OS build number by navigating to **Android settings> About phone**. 1. To apply the update, change **Delay OS update** to **False** 2. Click **Trigger OTA.** The update will be applied, and you will see a notification on the phone. 3. The user will see a Reboot notification and once the phone is rebooted, the device will have upgraded to the new OS. **Entry criteria** | | | | ------------- | ------------ | | **Type** | Radio button | | **Default** | Disabled | | **Unique?** | No | | **Required?** | See above | | **Level** | Device | | **Notes** | See above | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.spectralink.net/amie-essentials/applications/sys-updater.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.