Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

UI initiates Bluetooth scan for HID profile to connect and pair with at this point with a configured time-out. How to put the RCU in Bluetooth pairing mode is dependent on the RCU design which is not within UI scope.

UIv3.9 onwards Navigator UI will prefer to use Remote Control plugin on supported platforms to pair with RCU instead of classic Bluetooth plugin. Only one plugin shall be used to onboard the RCU - if preferred Remote Control plugin is available it will not fall back to use Bluetooth plugin to scan and pair with RCU.

...

Alexa support

Preview Mode: Navigator UIv3 UI supports basic Alexa skills on aligning to Alexa Voice Integration Manual on a supported platform using Voice Control plugin.

...

  •  Note: "App Catalog & Manage Apps" are supporting only the minimal basic LISA API features. In future it will have the extended features of details of apps, view memory usage etc.

...

Known supported RDKV machine configurations:

FamilyPlatform/Machine Name
RDKV Generic Reference Devices

raspberrypi3

raspberrypi4

RDKV Reference Devices

Amlogic

  • ah212
  • ap222

Broadcom 

  • brcm972180hbc
  • m393

Realtek

  • mediabox


Navigator UI supports ASMS Cloud based app store out of the box without any manual configuration if proper configuration is embedded within the device firmware at build time. LISA metadata API shall confirm if the platform supports ASMS App Store if it has auxMetadatahas proper auxMetadata information matching following template.


Code Block
languagejs
curl -X POST http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc": "2.0", "id": 1, "method": "LISA.1.getMetadata", "params": {"id": "lisa.dac.config", "type": "application/LISA", "version": "0"}}'

{"jsonrpc":"2.0","id":1,"result":{"appName":"","category":"","url":"","auxMetadata":[{"key":"dacBundlePlatformNameOverride","value":"<UnequeASMSRegisteredPlatformName>"},{"key":"dacBundleFirmwareCompatibilityKey","value":"<UniqueUnequeASMSRegisteredPlatformFirmwareKey>"},{"key":"asmsUrl","value":"<ASMSAppStoreConfigurationUri>"}]}}

...

  • Network Interface - This page allows the user to change current network configuration - option to choose between Wi-Fi and Ethernet. If Wi-Fi is selected, next page will allow user to join with a wireless network. Join Another Option from Wi-Fi page gives user an option to connect to hidden networks around them - User has to provide Network name, select the proper security and password.
  • Note: Previously connected SSID will not ask for password again and it will get connected if we click on previous connected SSID, and only connect with SSID that is saved [3.8 NEW FEATURE]. Only last saved one SSID is remembered.

...

  1. Local Device Discovery - This feature allows user to control (enables/disable) the DIAL casting support of the device - YouTube app. If enabled; user shall be able to see the device in his mobile App(under casting option in YouTube mobile app) which is in the same local network. Upon selecting it will directly link your mobile to device and open the YouTube app in the UI.
  2. USB Media Device - User shall be able to enable or disable USB external media support. If enabled and media device is connected with the device then the USB icon will appear in Featured Content section as detailed in "USB Feature" section.
  3. Audio Input/Clear Cookies and App Data - [Updated in UIv3.9] User  User shall be able to clear the ResidentApp's cache and local storage without triggering a system reboot. This section allows user to reset the Alexa authentication details as well on a supported platform.
  4. Privacy Policy and License - This provides a template for future integration. Gives Information about Privacy and License policy which user shall be abiding to.

...

The Scan section exposes various DVB tuner sub-systems; DVB-S, DVB-T and DVB-C based on respective stack integration support.

  •  New Feature: UIv3UIv4.X - DVB T/T2: Upcoming
  •  New Feature: UIv3UIv4.X - DVB-C: Upcoming

DVB-S/S2

...

Code Block
$ DISTRO_FEATURES_append = " offline_apps build_rne "

...

API Documentation

This section details the average loading time, CPU and memory utilization for this version of the UI alone. It has been measured by loading the offline version of the UI on a pre-activated webkitbrowser instance.

TBD

...

Web Version

To experience UIv3.X on a firebolt compliant RDK stack, below url can be used. Moving forward it shall get deprecated.

Current Stable Version(3.12): https://apps.rdkcentral.com/rdk-apps/accelerator-home-ui/index.html#splash

Previous Stable Version(3.9): https://apps.rdkcentral.com/rdk-apps/device-ui/index.html#splash

API Documentation

This section details the necessary platform integration support required to ensure the smooth functionality of UI version 3. Below are the details of RDKServices provided methods and notifications used in each UI feature or page implementation which shall the necessary platform integration support required to ensure the smooth functionality of Navigator UI. Below are the details of RDKServices provided methods and notifications used in each UI feature or page implementation which shall aid debugging any functionality and integration or modification of the same. The Featured Video Player - UVE is used for Video-On-Demand sample streams.

  • Home Screen

    App Lifecycle Management

FunctionalityPluginMethodEvents
Launching Premium appsorg.rdk.RDKShelllaunch, launchApplication
Hide Resident Apporg.rdk.RDKShellsetVisibility
Hot Plug and Unplug of USBorg.rdk.UsbAccess

OnUSBMountChanged

Dynamic listing of Appsorg.rdk.RDKShell, Controller, LISAgetAvailableTypes, status, getList
Suspening / Terminating Appsorg.rdk.RDKShellsuspend, destroy, kill
  • Network Configuration

FunctionalityPluginMethodEvents
Get Default Network Interfaceorg.rdk.NetworkgetDefaultInterface
Test Internet Connectionorg.rdk.NetworkisConnectedToInternet
Current IP settingsorg.rdk.NetworkgetIpSettings
Get Interfacesorg.rdk.NetworkgetInterfaces
Get Connected SSIDsorg.rdk.WifigetConnectedSSID
Set Default Interfaceorg.rdk.NetworksetDefaultInterface
Discover SSIDorg.rdk.WifistartScan
Stop Scanorg.rdk.WifistopScan
Connect to SSIDorg.rdk.Wificonnect
Disconnect SSIDorg.rdk.Wifidisconnect
Wifi Stateorg.rdk.WifigetCurrentState
Enable/Disable Wifiorg.rdk.WifisetEnabled
Paired SSIDsorg.rdk.WifigetPairedSSID
Save SSIDorg.rdk.WifisaveSSID
Activate Wifi PluginControlleractivate
Wifi state changeorg.rdk.Wifi
onWifiStateChanged
Errororg.rdk.Wifi
onError
Available SSIDorg.rdk.Wifi
onAvailableSSIDs
Wifi state changeorg.rdk.Wifi
onWifiStateChanged

...

FunctionalityPluginMethodEvents
Activate BluetoothControlleractivate
Disable Bluetoothorg.rdk.Bluetoothdisable
Enable Bluetoothorg.rdk.Bluetoothenable
Start Scanorg.rdk.BluetoothstartScan
Stop Scanorg.rdk.BluetoothstopScan
Discovered Devicesorg.rdk.BluetoothgetDiscoveredDevices
Paired Deviceorg.rdk.BluetoothgetPairedDevice
Connected Deviceorg.rdk.BluetoothgetConnectedDevices
Connect to Bluetooth deviceorg.rdk.Bluetoothconnect
Disconnected to Bluetooth deviceorg.rdk.Bluetoothdisconnect
Unpair a deviceorg.rdk.Bluetoothunpair
Pair a deviceorg.rdk.Bluetoothpair
Discovered Deviceorg.rdk.Bluetooth
onDiscoveredDevice
Pairing Requestorg.rdk.Bluetooth
onPairingRequest
Connection Changeorg.rdk.Bluetooth
onConnectionChange
Discovery Completeorg.rdk.Bluetooth
onDiscoveryCompleted
Discovery Startedorg.rdk.Bluetooth
onDiscoveryStarted
Request Failedorg.rdk.Bluetooth
onRequestFailed
Remote Control Auto-Pairing

org.rdk.RemoteControl

startPairing


Remote Control Statusorg.rdk.RemoteControlgetNetStatus
Remote Control Statusorg.rdk.RemoteControl
onStatus
  • Video

FunctionalityPluginMethodEvents
Enable Display Setting pluginControllerorg.rdk.DisplaySettings
Get Resolutionorg.rdk.DisplaySettingsgetCurrentResolution
Get HDCP Statusorg.rdk.HdcpProfilegetHDCPStatusonDisplayConnectionChanged, 
Get HRD SettingsDisplayInfohdrsetting
Supported Resolutionsorg.rdk.DisplaySettingsgetSupportedResolutions
Set Resolutionsorg.rdk.DisplaySettingssetCurrentResolutionresolutionPreChange, resolutionChanged
  • Audio

FunctionalityPluginMethodEvents
Sound modeorg.rdk.DisplaySettingsgetSoundMode
Supported Sound Modesorg.rdk.DisplaySettingsgetSupportedAudioModes
Set Sound Modeorg.rdk.DisplaySettingssetSoundMode

...

FunctionalityPluginMethodEvents
Creates a symbolic linkorg.rdk.UsbAccesscreateLink
Clears or removes the symbolic linkorg.rdk.UsbAccessclearLink
Gets a list of files and foldersorg.rdk.UsbAccessgetFileList
Gets a list of files and foldersorg.rdk.UsbAccessgetFileList
Triggered when a USB drive is mounted or unmountedorg.rdk.UsbAccess
onUSBMountChanged
  • App Catalog

FunctionalityPluginMethodEvent
Get App Catalog Details, list of appsLISAgetMetadata, getList
Install/uninstall AppLISAinstall, uninstall
Show the progress of installation / uninstallationLISAgetProgress

operationStatus

  • Live TV

FunctionalityPluginMethodEvent
Get available countriesDTVnumberOfCountries
Get list of countryDTVcountryList
Get list of services(channels with name, uri and other details)DTVserviceList@dvbs
Get list of available satellitesDTVserviceList@dvbs
Initiates a service searchDTVstartServiceSearch
Get available servicesDTVnumberOfServices
Get schedule for given channelDTVscheduleEvents@PARAMS
Get current and next event details for channelDTVnowNextEvents@PARAMS

...