iOS OTA APP

The iOS OTA APP User Manual provides comprehensive guidance on using the application to update Realtek devices, utilizing Bluetooth Low Energy connections to deliver software updates, configuration settings, and patches. Prior to deploying the application, it is crucial to have an iPhone running iOS 11.0 or above, along with the latest upgrade files, to guarantee a smooth and successful update process.

To help users fully grasp the application’s functionalities, this manual includes annotated figures for clarity, ensuring users can follow visual aids to complete each step effectively.

  • The Getting Started section provides an effective step-by-step guide, directing users on how to use this tool.

  • The FAQ section is a valuable resource for addressing common questions and troubleshooting potential issues.

Getting Started

This chapter instructs users on how to check the application version, adjust the upgrade settings, connect the device, select the upgrade file and confirm the upgrade result. It details the stages of OTA to ensure a successful upgrade.

User Interface Overview

  1. Upon launching, the following interface will be displayed, divided into six sections:

    • OPERATION: Requires user interaction. Once the device and file are selected, the Upgrade option will appear.

    • DEVICE FEATURE, ACTIVE IMAGE and INACTIVE IMAGE: These details will be automatically populated after a device is selected.

    • FILE INFORMATION: After the user selects the upgrade file package, all images and version information within the package will be parsed and shown here.

    • SETTINGS: Before the upgrade, users can configure options in this section as needed.

    ../../../_images/HomePage1.png

    Home Page 1

    ../../../_images/HomePage2.png

    Home Page 2

  2. Clicking the button in the upper left corner will bring up the About option. Click it to check the current application version information, as shown in About Page and Version Info.

    ../../../_images/AboutUI.png

    About Page

    ../../../_images/VersionInfo.png

    Version Info

Settings

The application offers the following options to make OTA more efficient and secure.

../../../_images/Settings.png

Settings

  1. Check File Version

    Check whether the upgrade file is newer than the current firmware. Whether the check is enabled or not, lower version files are not allowed.

    • Disabled: Do not verify the version, the application will send all images to the device. If the device is single bank, all images will take effect after OTA. If the device is dual bank and there is no image higher than the current images, the device will not switch the bank.

    • Enabled: The check mechanism can be configured. Strict will check each image, while lenient will stop checking as soon as it encounters a higher version image. Both strict and lenient check mechanisms can ensure the effectiveness of OTA. It is recommended to use the strict mechanism.

  2. Check Battery

    Set battery check threshold. If the battery is less than the threshold, then cannot upgrade. The recommended threshold is thirty.

  3. Check Image Feature

    Check whether the features of the upgrade file match the features of the firmware. If this function is enabled, a warning will appear for any feature inconsistencies, but the upgrade process will not be affected.

Connect the Bluetooth Low Energy Device

  1. Click Select Device to enter the Device interface, which lists the names and RSSI of Bluetooth Low Energy devices that can be connected. Click the icon in the upper right corner to reorder the Nearby peripherals list by RSSI, as shown in Search Devices.

    • My GATT peripherals: Bluetooth Low Energy devices that are currently connected.

    • iAP accessories: Devices connected to the phone that follow the com.rtk.datapath protocol.

    • Nearby peripherals: Discovered Bluetooth Low Energy devices.

    ../../../_images/SearchDevices.png

    Search Devices

  2. Select the target device, the connecting status will be displayed on the Home Page, as shown in Connecting.

    ../../../_images/Connecting.png

    Connecting

  3. Connection Status

    1. If the connection is successful, the DEVICE NAME, DEVICE FEATURE and ACTIVE/INACTIVE IMAGE will be filled on the page, as shown in Connect Successfully.

      • DEVICE FEATURE: Refers to the characteristic or capability of the device. Here includes if encryption is supported, buffer check is supported, the device’s Bluetooth address and valid bank information.

      • ACTIVE/INACTIVE IMAGE: If the active bank is single, there are no inactive images. If the active bank is Bank 0, the ACTIVE IMAGE section shows the image names and versions in Bank 0, while the INACTIVE IMAGE section shows the image names and versions in Bank 1, and vice versa.

    2. If the connection fails, the failure cause will be displayed, as shown in Fail to Connect. It is necessary to confirm whether the target device supports the OTA service and whether the device is connectable.

    ../../../_images/ConnectSuccessfully.png

    Connect Successfully

    ../../../_images/ConnectFailure.png

    Fail to Connect

Select the Upgrade File

  1. After a successful connection, click Select File to enter the optional file list, as shown in The File List. If the list is empty, please refer to How to Copy Firmware Files to This Application. This step cannot be performed if the device is not connected, as shown in No Connected Devices.

    ../../../_images/FileList.png

    The File List

    ../../../_images/NoConnectedDevices.png

    No Connected Devices

  2. File Confirmation

    After selecting the target file, it will navigate back to the Home Page.

    1. Correct File: Users can view the parsed file information, such as image names and versions, under the FILE INFORMATION section, as shown in The Correct File.

    2. Incorrect File: An error message will appear, as shown in The Incorrect File.

      • Confirm Version: Low version files are not allowed. If users want to upgrade the same version file, can disable the Check File Version in SETTINGS, which is enabled by default.

      • Confirm Type: Only the combine file can be upgraded for a RWS device, while a pack file or a single bin can be upgraded for a device which is not RWS.

      • Confirm Compatibility: The upgrade file must match the current device.

    ../../../_images/CorrectFile.png

    The Correct File

    ../../../_images/IncorrectFile.png

    The Incorrect File

Start the Upgrade

  1. Prerequisites: Connect the device (see Connect the Bluetooth Low Energy Device), select the appropriate upgrade file (see Select the Upgrade File), then adjust the version check and battery level in the Settings.

  2. Click the Upgrade option. If the device supports both Normal and Silent modes, a dialog box will appear, allowing users to choose the upgrade mode. If not, the upgrade will proceed using the currently supported mode automatically.

    • Normal Mode: The device will transition into OTA mode, leading to a brief disconnection and reconnection between the APP and the device.

    • Silent Mode: The upgrade starts immediately without any interruption.

  3. Once the upgrade starts, the progress and result will be displayed, as shown in Upgrading and Successful Upgrade.

    ../../../_images/Upgrading.png

    Upgrading

    ../../../_images/SuccessfulUpgrade.png

    Successful Upgrade

  4. After the upgrade is complete, reconnect the device to verify that the versions of the active images are correct.

    ../../../_images/ActiveImages.png

    Active Images

  5. If the upgrade fails, please provide logs for analysis. See How to Capture Logs for guidance.

FAQ

This chapter lists potential issues that may arise when using the application and provides solutions for reference.

How to Copy Firmware Files to This Application

  1. Download and install the software iFunbox or iTools on PC (Windows/Mac).

  2. Connect an iOS device to a PC and launch iTools. Follow the annotations in iTools UI and Copy File for guidance.

    ../../../_images/iToolsUI.png

    iTools UI

    ../../../_images/CopyFile.png

    Copy File

Potential Causes and Solutions for Upgrade Failures

Potential Causes and Solutions for Upgrade Failures

Potential Causes

Solutions

The upgrade file is not legal.

  1. Ensure the upgrade file is compatible with the device.

  2. Confirm the correct type of the upgrade file.

  3. Verify that the file format is accurate.

  4. If version check is enabled, confirm that the version meets the specified requirements.

The application’s AES key does not match the key on the device.

If the AES key has been changed on the device, users should develop the application based on the SDK and reset the key.

The connection is interrupted, or an issue arises during the upgrade.

Users should provide both application and device logs to facilitate analysis.

How to Capture Logs

The logs involved include three types: application logs, HCI logs, and crash logs.

  1. Application Logs: Focus on operations, interactions, flow, and other runtime information generated by the application. They provide broad insights into how an application functions during typical use. These logs with names similar to RtkOTA2_2024.06.06.log can be obtained using iTools, as shown in iTools UI and Log Path.

    ../../../_images/LogPath.png

    Log Path

  2. HCI Logs: Offer specific details about Bluetooth communication processes, helping to resolve connectivity and interoperability issues. Refer to Bluetooth_Logging_Instructions to capture these logs.

  3. Crash Logs: Provide precise data regarding application failures, including stack traces and error codes, which are essential for fixing critical bugs that cause the application to crash. These logs can be accessed at Phone Settings ‣ Privacy & Security ‣ Analytics & Improvements ‣ Analytics Data.