RDK Resources

[*RDK Preferred*]

Code Management Facility

Code Releases

RDK Forums

[RDK Conferences]

RDK Support


Papers & Presentations Archive

In the News!

Skip to end of metadata
Go to start of metadata


The RDK Accelerator Home UI version 3 is the latest version (rdk-next/accelerator-home-ui/settings.json platformSettings version) of the RDK reference UI which provides a full featured UI with a modern minimalistic design using a dark theme.

This single UI currently supports IP-STB, Hybrid-STB and TV profile RDK stacks. UI uses DTV Plugin and HDMIInput plugins to distinguish the platform profile; UI will consider the platform as TV if stack has HDMIInput plugin support, Hybrid STB if DTV plugin is present else the default IP-STB.

The UI uses Lightning SDK Plugins such as  Language, Router, Storage and supports Premium apps such as Amazon, YouTube, Xumo along with a selection of Lightning apps from the Metrological App Store.  It also includes a wide section of settings which allow a user to take full advantage of the device features such as Audio, Video, Network, Language and more.

The sequential flow this UI provides to the user is listed in below sections.

In summary, the features includes in version 3 are:

  • OEM logo with color accents which are customizable
  • Multiple Language Support
  • Casting Feature from mobile phones to premium apps such as YouTube
  • Overlay Screen
  • Extensive settings pages to interact with various Video, Audio, Connectivity options
  • Generic UI Keymap option
  • On-screen Keyboard Component for Bluetooth & Wi-Fi
  • Partner-App side loading
  • Downloadable application bundles (DAC Apps) from DAC App-store

Splash Screen

The app loads a new splash logo when the device boots up which remains for a few seconds and then leads to user on-boarding screens if device is booting up afresh.

Note: The Gracenote logo will be visible only on the device where required keys are provisioned.

User on-boarding

This screens shall appear only once the device is booting up.  Criteria used to detect the fresh boot is by verifying whether any previous Remote Control Unit (hereafter RCU) pairing information is available or not. If yes, device shall skip these on-boarding screens and land at the Home screen.

Same features and functionalities are exposed under Settings menu as well for the user to interact later.

Remote Pairing

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.

RCU Pairing using RemoteControl plugin

Note: this feature of automatic RCU pairing requires RCU model support integrated with BLERCUDaemon at platform firmware build time and RemoteControl plugin enabled. If your RCU and platform does not support this feature yet, you can still pair your RCU using the Classic Bluetooth plugin based RCU pairing through "Settings" menu detailed in later section - "Pair Remote Control".

The UI uses Remote Control Plugin to pair with the device if it catches any error while pairing then Bluetooth plug will be activated.

RCU Pairing using classic Bluetooth plugin

The updated UI uses classic Bluetooth plugin to pair with the very first HID input device appearing in the scan response.

Language Selection

The UI currently supports two languages, English and Spanish. New language support can be integrated with proper resource files added along with the defaults as detailed in upcoming sections. UI will reload to refresh the entire settings and during that time user may see display going blank and a spinner appearing for the reload time.

Based on user selection; active language shall be saved as user preference in platform configuration.

Note: this spinner is being spawned as a separate app instance.


Network Selection

Network selection screen allows the user to configure connectivity method for internet access to the device.

Preferred interface shall be ETHERNET and if selected, user shall be taken directly to home screen and set default interface to ETHERNET.

Upon selecting Wi-Fi interface, user shall be presented with a list of available wireless networks or an option to connect to the hidden network. Upon selection of a Wi-Fi network user shall be presented a page where he can enter the network credentials.

Added skip section to test the offline mode where UI shall not initiate any network configuration. If the ethernet cable is connected or Wi-Fi is factory configured while selecting the skip button the device's backend may automatically try to connect to the network via respective interface which is not initiated by UI.

Below snapshots details related screens.

Note: (Limitation) Only DHCP mode is supported at the moment.

Keyboard seen in above snapshot is implemented using Lightning UI Components and has been customized to fit with present Keyboard layout.

Home Screen

This new app has redesigned ‘Home UI’ screen with new background, shadow and animation effects. It contains sections for Featured content, Lightning Apps, Featured Video on Demand, and Voice and Settings icons displayed on top section.

Prime Video, YouTube, Xumo and the metrological apps can be launched from app listings if the device has respective support integrated.

Sample Video contents including HLS & DASH FOG Live Streams can be played from the Featured Video section.

User can access the device settings by interacting with the Settings icon which will redirect him on to dedicated settings screen. Time display is also available in the home UI.

Alexa support

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

  • Reporting application state and device settings changes to Alexa (ApplicationStateReport, PlaybackStateReport, Volume change, Language & TimeZone change reporting)
  • Support for Search & Play voice query redirection to YouTube.

RDK's OOBE for Alexa authentication will be activated only when user is at HOME page and internet is available. User shall have an option to disable this support by selecting "Skip" button. Later onwards UI shall deny all the Alexa related notifications until a Clear Cache or Factory reset is done through the UI.

UI shall display following Alexa SDK status[DISCONNECTED, CONNECTING, CONNECTED] if enabled and authenticated. The following screen shall be displayed to user on each SDK status change and shall time out itself without any need for user interaction.

Home Screen for Set-Top-Box Profile

Featured Content row will display app icons based on platform capability. 

Note: The web apps will now auto-exit in case if the http status code is not 200.

The UI can display popular movies in Home screen with the help of Gracenote metadata if platform support is enabled. UI upon detecting required runtime configuration shall display "Popular Movies" row at the top as detailed below.

On selecting an asset; its details screen shall be presented and User shall be able to launch the selected content on platform supported Apps (Note: Currently YouTube only is added with deeplink feature).

Precondition: Platform shall have support for PersistentStore plugin and Gracenote API key should be added to Persistent Store of the DUT prior to UI startup. Use below commands to save and confirm the same.

curl -X POST -d '{"jsonrpc":"2.0","id":"3","method":"org.rdk.PersistentStore.1.setValue","params":{"namespace":"gracenote","key":"apiKey","value":"SecretAPIKey"}}'
curl -X POST -d '{"jsonrpc":"2.0","id":"3","method":"org.rdk.PersistentStore.1.getValue","params":{"namespace":"gracenote","key":"apiKey"}}'

Home Screen for TV Profile

Featured Content row will display app icons based on platform capability. 

  • Upcoming Feature: Extend support for Composite Input and HDMI CEC Sink.

Here it is! This new feature allows users to select HDMI inputs connected your TV. It allows seamless switching between the UI and HDMI inputs.

Guide Screen

  •  EPG guide is a continuous updating menu that shows scheduling information for current and upcoming programs.
  •  EPG/Guide can be invoked by clicking on the second icon of the side panel.
  •  EPG Guide will show list of channels and shows which are currently airing. It will also show user the upcoming programs.
  •  One can scroll through channels by using up and down arrow keys and through shows by using left and right arrow keys.

  • One can watch a show by clicking on it(Provided it's currently playing).
  • To bring up the controls as shown in the figure, can be achieved by pressing up key. where as down key is used to hide them. 

  • if one clicks on a show which supposedly airs in the future then its airing time comes up on the screen instead of the video player.

  • When playing the content user has the ability to view all the channels as an overlay.
  • This feature allows user to change channels while playing the content.

  • Apps (Amazon , Netflix and YouTube etc) can be launched from the guide screen.
  • In presence of DTV plugin other channels will follow these three apps.
  • In absence of a DTV plugin , the guide screen will still openable with these three items populated.

Apps Screen

My Apps, App Catalog, Manage Apps tabs now is dedicated for supporting DAC Apps or app-store on a supported device and firmware with provisioned ASMR Cloud app-store functionality.

On selecting the Apps Icon from left banner; User shall be presented a new page with 3 tabs highlighted with "My Apps" which shall list the list of all installed app bundles on that particular platform. If no installed app bundles are found; user shall be presented with the "App Catalog" tab which will display all available downloadable app bundles from remote server from which user shall be able to install selected app. Installation progress shall be displayed when user interacts with that selected App Icon. After installation competes; that app will be displayed under "My Apps" as well as "Manage Apps" tabs. From "My Apps"; user shall be able to launch the App. To "EXIT" from that app instance; user need to press HOME key which will redirect him to UI HOME page. From "Manage Apps"; user shall be able to uninstall the installed App.

Respective snapshots are listed below for reference.

  • Note: "App Catalog & Manage Apps" are supporting only the minimal LISA API features. In future it will have the extended features of details of apps, view memory usage etc. Also the App bundle hosting shall not be covered in this section as it is not under the scope of UI.

Device configuration for fetching ASMR DAC App Catalog details:

UI supports ASMR Cloud based app store if proper configuration is available. Firmware need to have the following JSON format with proper details matching below template.

root@raspberrypi4-64-rdk-android-mc:~# cat /opt/appmanagerregistry.conf
  "app-catalog-cloud": {
    "url": "<ASMS Cloud Base URL>",
    "firmwareVersions": [
        "platform": "rpi4",
        "ver": "1.0.0-aabbccddeeffgghhiijjkkllmmnnooppqq112233-dbg"
        "platform": "ah212",
        "ver": "1.0.0-aabbccddeeffgghhiijjkkllmmnnooppqqrrsstt-dbg"

Note: Each platform should configure appmanagerregistry.conf (above template) with proper "url", "platform" and "ver" keys since those are platform specific.

Reference: https://github.com/stagingrdkm/lgpub/blob/master/dac/labci/dactest.py#L36 shall have the ASMS Cloud Base URL and matching platform VER.

Featured Video Player

The redesigned video player utilizes UVE implementation and has kept the minimal controls such as a progress bar with pause and play buttons. Various player controls are detailed below.

  • Navigation
    • The overlay screen has timeout of 5 sec. You can bring up the overlay by pressing Arrow UP key.
    • Enter to pause and play.
    • Back and Home key will take you back to home screen from Featured video player instance.

Settings Screen

Settings screen has several new options which allows user to interact with device capabilities.

Native Frame State:

Network Configuration

This page contains three subsections detailed below:

  • Network Info - This page presents the current network interface status details to user such as Connection type and status, IP address, MAC address, signal strength etc.

  • 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.


  • Check Internet Access - This allows the user to confirm that the device has internet connectivity

Pair Remote Control

Allows user to connect to Human Interface devices like Remote, Bluetooth keyboard etc.

  1. To add a device navigate to add a device option and press enter.
  2. User will be directed to pairing screen where you will list of devices scanned by the UI. Press enter to setup connection.
  3. Notification message will be shown to confirm the connection.

Below Images shows the flow.


Voice Remote Control

UI now uses Remote Control plugin to display connected remote control unit's details.

On a Remote Control plugin supported platform following section will activate the remote control plugin if not activated previously and pairs the RCU and shall expose the current information of the paired Remote Control Unit.

Video Settings

Video settings provide users to change resolution of the screen. HDR and HDCP options are read only fields which confirms certain requirements for premium apps.

Note: Transparent(advanced settings) contents are currently work in progress

  • Resolution

This screen presents the common resolutions supported by both source(device) and sink(display).


Provides option to change Output mode of the device.

Note: Transparent contents are currently work in progress

  • Output Mode

Other Settings

  • Sleep Timer

Sleep Timer turns off the screen upon selecting a particular time frame from the options provided. Device will be in Light Sleep mode by default. User can change the default sleep(standby) mode from Energy Saver section.

  • Screen Saver

Screen saver is activated if user inactivity is detected for selected time frame . The screen saver is cancelled and returns to the previous screen when the remote control is operated.

Note: To reduce the UI size and to comply with repo management rules the screensaver video file is not checked in along with the the UI code. Please install Screensaver.mp4 video file in the locally hosted UI at ${DOCROOT}/lxresui/static/images/Screensaver.mp4 in the device.

  • Energy Saver

Energy Saver page allows user to configure the default sleep mode from the supported standby modes.

  1. Deep Sleep - Which releases the resources in the device and suspend the UI. Lowest power consumption mode except power off.
  2. Light Sleep - Turns off the display but the background processes remain active.

  • Language

Allows user to change the menu language of the UI. If changed, the UI will reload to refresh the entire settings and in that process user may see display going blank and a spinner appearing for the reload time.

Note: this spinner is being spawned as a separate app instance.

youtube languages changes with respect to device support

  • Privacy

  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 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.

  • Advanced Settings 

  1. CEC Control - This plugin allows user to configure HDMI Consumer Electronic Control on a device. This will enable user to control TV and set-top box using one remote provided same is enabled and supported by the display device also.
  2. Device Details - The basic device specific details page which presents details of the platform, manages firmware details and helps user to trigger a system reboot.

  • Device Details - Info - Lists down information about device like chipset, location, supported DRM systems, Firmware version etc.

  • Device Details - Time Zone - This page allows the User to change the device TimeZone settings
    Dependent on System plugin feature support. Note: this does not change the device's time. Only the UI displayed time is affected. This configuration will be persisted.

  • Device Details - Check for Updates - This page shows the current firmware version and also allows user to trigger a check for new firmware availability (download and install happens without UI involvement).

  • Device Details - Reboot - Rebooting of the device within the UI.

  • Factory Reset - This section allows the User to trigger a complete factory reset on the supported platform. This is followed by a device Reboot. It will reset the Alexa authentication as well on supported platform. Following are the Confirmation Screens


Live TV

Dependent on DTV Plugin. This feature enables user to interact with the Tuner configuration and related features such a as Live TV - scan, channel tuning, Guide population, its playback etc.

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

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


This subpage exposes various DVB-S Tuner parameters such as Satellite selection, Frequency, Polarity, Symbol rate etc. Each section allows user to select respective predefined option or enter a custom value(for selected parameters).


Based on the scan response, Guide screen shall get populated with actual live channel listing. User shall b e able to interact with the current available channels to initiate playback. From playback screen, user shall be able to change the channel also by bringing up the channel listing overlay.

Sample snapshots from DVB-S2 supported Device

Settings page tuner scan configurations and status:


Guide population:


USB Media Support Feature

In this version you will get full access to USB Media device related features if the device has required support integrated. To name a few - viewing images, playing audio and video file, accessing internal folders of the USB Media device.

Note: only the multimedia files are exposed through UI which are supported by UVE Player.

When the USB is plugged in UI will show USB icon on Featured Content row as shown in below content. New design allows the user to disable and enable USB Media support feature from Privacy Setting.

User can view the contents by pressing enter and he will see contents sorted based on Video, Audio, Photo, Folder.

You can traverse using Left/Right/Up/Down and to access the content - press Enter. File format supported is limited only by UVE support and USBAccess plugin filter.

  • Video Content shall be accessible using the same UVE player. Seek bar gives timeline of video, Next and Previous icons will allow user to switch to respective content.

  • Audio Content - UI shows a static image to indicate audio file is playing.

  • Image Content - When viewing images Left/Right key presses will change images.

  • Folder Content - The contents of USB will replace when the user traverse a particular directory.

Related RFC: 


Overlay Screen

Generic Settings Overlay

In this new release settings are added as a overlay through widgets where user shall be able to launch settings though hot keypress on remote. Settings Hot-Key is Settings_Shortcut (Reference: accelerator-home-ui/src/Config/Keymap.js).

Overlay Screen for Set Top Box Profile

New widget for overlay - to display notifications such as volume change etc.

Below snapshot shares how the overlay appears on various sections; At Home page, At Apps page and on a Playback screen.

Overlay Screen for TV Profile

TV profile supported stack has overlay for Volume change. Adding to that; it adds additional overlay screens for changing TV related settings as detailed below.

Input Selection Overlay

This overlay allows the user to switch between available Input options while enjoying an Input option.

Supported Hotkey is Inputs_Shortcut (Reference: accelerator-home-ui/src/Config/Keymap.js).

Picture Settings Overlay

Numeric value settings like brightness backlight, contrast etc can only be changed when picture mode is set to custom and color temperature is set to user defined.

Supported Hotkey is Picture_Setting_Shortcut (Reference: accelerator-home-ui/src/Config/Keymap.js).

PartnerApp Support

This feature allows the app developers to quickly test any app without modifying the Accelerator UI source code by adding details of the custom app in app manager registry file present in device(if not present; can be created one with valid json content inside it). After updating this restart the device or residentapp service to reload the Home page which shall display a new row at home page with the Icon image. A sample app manager registry configuration and resulting UI screen will be as given below.

root@HP44HRDK:~# cat /opt/appmanagerregistry.conf

List of supported launch type for apps(applicationType)

Application TypeSample appmanagerregistry.confStatus
For HTMLApps (online)
{ "applications":[ { "displayName":"Bluetooth", "uri":"https://keycode.info/", "applicationType":"HtmlApp", "url":"" } ] }
For Native/ResidentApps (offline)
{ "applications":[ { "displayName":"Native App", "uri":"http://localhost:50050/lxresui/static/loaderApp/index.html", "applicationType":"applciation/native", "url":"" } ] }
For LightningApps (online)
{ "applications":[ { "displayName":"Lightning App", "uri":"<hostedURL>", "applicationType":"LightningApp", "url":"" } ] }

Key Mapping

The version 3 UI supports a configurable keymap. Below lists the general functionality and keycode of keys. Detailed information of the default keycode mappings can found here in Keymap.js.

Keycode - 37,39,38,40 (Left/Right/Up/Down Key)To Move between the Contents Tiles
To Navigate between settings screen
Keycode - 13 (Enter Key)To launch app from App list
To launch Video Player
To Enable/Disable Features
To Play/Pause Video
Keycode - 36 (Home)To Navigate to home screen
To return back to home screen from other apps
Keycode - 116 (Power Key, F5)To Power off the device
Keycode - 174 (AudioVolumeDown Key)To decrease the volume of the STB
Keycode - 175 (AudioVolumeUp Key)To increase the volume of the STB
Keycode - 173 (AudioVolumeMute Key)To mute the STB
Keycode - 113 (Inputs_Shortcut, F2)To bring up the INPUT list overlay on TV profile device
Keycode - 114 (Picture_Setting_Shortcut, F3)To bring up the Picture Settings overlay on TV profile device
Keycode - 117 (Prime App Hotkey, F6)Dedicated key to launch Prime Video App
Keycode - 118 (Netflix App Hotkey, F7)Dedicated key to launch Netflix App
Keycode - 119 (YouTube App Hotkey, F8)Dedicated key to launch YouTube App
Keycode - 121 (Settings key, F10)To launch the Settings Overlay over other apps
Keycode - 120 (Guide_Shortcut, F9)To go to EPG screen
Keycode - 122 (AppCarousel, F11)To bring up the app carousel overlay on top of a child app

Customization (Theme and Logo)

One among the new feature in this version of UI is it allows to change the focus color, background color and logo if an operator wishes to by making necessary changes in config.js. Default config.js for reference is as below.

const themeOptions = {
    partnerOne: {
      hex: 0xfff58233,
      logo: 'RDKLogo.png',
      background: '0xff000000'
    partnerTwo: {
      hex: 0xff91c848,
      logo: 'RDKLogo.png',
      background: '0xff000000'

User can define an object inside theme options which need three parameters:

hex - Color accents on the UI. Default one is shade of orange.
logo - Logo at the splash and top left side on the home screen.
background - background color of the components.

User has to export a specific theme for it to apply through the UI and rebuild or re-gernerate the app bundle.

export var CONFIG = {
    theme: themeOptions['partnerOne'],
    language: localStorage.getItem('Language')!=null ? language[localStorage.getItem('Language')] : language['english']

Clone and Build Instructions

This section details about how to customize the current UI source code and develop further.

Follow the commands to run the application on you laptop.

  • Firstly install Lightning CLI
  • Type lng to confirm the installation. You will see the below output.

    $ npm install -g @lightningjs/cli
    $ lng
    Usage: index lightning-cli <command> [options]
      -V, --version   output the version number
      -h, --help      display help for command
      create - Create a new Lightning App
      build - Build a local development version of the Lightning App
      serve - Start a local webserver and run a built Lightning App in a web browser
      watch - Watch for file changes and automatically rebuild the App
      dev - Build a local Lightning App, start a local webserver, run a built Lightning App in a web browser and watch for changes
      docs - Open the Lightning-SDK documentation
      dist [options] - Create a standalone distributable version of the Lightning App
      upload - Upload the Lightning App to the Metrological Back Office to be published in an App Store
      update - Update the Lightning-CLI to the latest version
      help [command] - display help for command
  • Clone repo

    $ git clone "https://code.rdkcentral.com/r/components/opensource/RDK_apps"
    $ cd RDK_apps
    $ git checkout rdk-next
    $ cd accelerator-home-ui
    Note: if you are not able to launch offline UI, add .env file inside accelerator-home-ui/ and add 'LNG_BUNDLER=esbuild' to force the bundler. Make sure you have esbuild dependency (npm install esbuild)
    $ npm install
  • Build

    $ lng build
  • Install as offline-app

    $ cd RDK_apps/accelerator-home-ui/dist/<es6>/Replace the dummy icons with original and then tar the entire contents to deploy on the offline UI location on device.

    Note: On a RDKV reference device; the lighttpd webserver is configured to load the offline UI from DOCROOT which includes the alias of the above dist file mapped for loading. Usually the dist directory contents are placed in the STB's /home/root/lxresui/

  • Host the app locally to test

    $ lng serve

    It will print the local url as : which can be loaded as url to the residentApp.sh which is responsible for offline UI url loading on STB.


The UI uses localstorage feature of WebkitBrowser's ResidentApp configuration for storing the user preferences. PLUGIN_RESIDENT_APP_LOCALSTORAGE and PLUGIN_RESIDENT_APP_PERSISTENTPATHPOSTFIX variables need to be configured build-time itself.

Note: the localstorage directory shall be pointed to a persistent ReadWrite section on device.

Steps to make Accelerator Home UI v3 as Device UI

Packages that are needed for Accelerator UI v3 are from meta-rdk-video layer. They will get installed into the final rootfs with necessary startup and configuration scripts if the machine configuration is enabled with below mentioned DISTRO_FEATURES.

$ DISTRO_FEATURES_append = " offline_apps build_rne "

Performance Matrix

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.


PlatformCPU (%‾)Memory (MB‾)Home page loading time [#menu] (in ms‾)
Raspberry Pi

Reference VA(IP) - HX44X

Reference VA(IP) - AH212

Reference VA(Hyb) - EKT

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 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

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


Dynamic listing of Appsorg.rdk.RDKShell, ControllergetAvailableTypes, status
  • Network Configuration

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
Activate Wifi PluginControlleractivate
Wifi state changeorg.rdk.Wifi
Available SSIDorg.rdk.Wifi
Wifi state changeorg.rdk.Wifi
  • Bluetooth

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
Pairing Requestorg.rdk.Bluetooth
Connection Changeorg.rdk.Bluetooth
Discovery Completeorg.rdk.Bluetooth
Discovery Startedorg.rdk.Bluetooth
Request Failedorg.rdk.Bluetooth
Remote Control Auto-Pairing



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

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

Sound modeorg.rdk.DisplaySettingsgetSoundMode
Supported Sound Modesorg.rdk.DisplaySettingsgetSupportedAudioModes
Set Sound Modeorg.rdk.DisplaySettingssetSoundMode
  • Sleep Timer

Set Power Stateorg.rdk.SystemsetPowerState
Inactivity Intervalorg.rdk.RDKShellsetInactivityInterval
Enable/Disable Inactivity Reportingorg.rdk.RDKShellenableInactivityReporting
  •  Screen Saver









  • Energy Saver

Get preferred Standby Modeorg.rdk.SystemgetPreferredStandbyMode
Set preferred Standby Modeorg.rdk.SystemsetPreferredStandbyMode
  • Privacy Settings - USB

Activate USB PluginController (org.rdk.UsbAccess)activate
Deactivate USB PluginController (org.rdk.UsbAccess)deactivate
  • Privacy Settings - Local Device Discovery

Activate Xcast PluginController (org.rdk.Xcast)activate
Deactivate Xcast Pluginorg.rdk.XcastsetEnabled
  • CEC Activation

Activate CEC PluginController (org.rdk.HdmiCec_2)activate
Deactivate CEC PluginController (org.rdk.HdmiCec_2)deactivate
Check Enabled/Disabledorg.rdk.HdmiCec_2getEnabled
Set Enabled/Disabledorg.rdk.HdmiCec_2setEnabled
For Active HDMI port selected by Sinkorg.rdk.HdmiCec_2
  • Device Screen

Serial Numberorg.rdk.SystemgetSerialNumber
System Versionorg.rdk.SystemgetSystemVersions
Activate OCDM PluginController (OCDM)activate
DRMs infoOCDMdrms
Location infoLocationSynclocation
Device InfoDeviceIdentificationdeviceidentification
Location changeLocationSync
Firmware Stateorg.rdk.SystemgetFirmwareUpdateState
Downloaded Firmware Infoorg.rdk.SystemgetDownloadedFirmwareInfo
Get Firmware Download Percentageorg.rdk.SystemgetFirmwareDownloadPercent
Update Firmwareorg.rdk.SystemupdateFirmware
Reboot deviceorg.rdk.Systemreboot
  • Global APIs

Deactivate apporg.rdk.RDKShelldestroy
Suspend apporg.rdk.RDKShellsuspend
Focus Apporg.rdk.RDKShellsetFocus
Move app to top of zorderorg.rdk.RDKShellmoveToFront
State change of application eventController
Add key interceptsorg.rdk.RDKShelladdKeyIntercept
Install Downloadable App bundleLISAinstall
To populate & manage the installed Downloaded App bundlesLISA
getStorageDetails, getList

Uninstall Downloadable App bundleLISAuninstall
Launch/resume Downloaded App bundleorg.rdk.RDKShelllaunchApplication, 

Suspend/Kill Downloaded App bundleorg.rdk.RDKShellkill
User Preferences such as current languageorg.rdk.UserPreferencessetUILanguage
  • Xcast Feature

Activate Xcast PluginController (org.rdk.Xcast)activate
Deactivate Xcast PluginController (org.rdk.Xcast)deactivate
Enable/Disable Xcast Statusorg.rdk.XcastgetEnabled
Set Enable/Disable Xcast Statusorg.rdk.XcastsetEnabled
Notify Application Stateorg.rdk.XcastonApplicationStateChanged
Launch Request eventorg.rdk.Xcast
Hide Request eventorg.rdk.Xcast
Resume Request eventorg.rdk.Xcast
Stop Request eventorg.rdk.Xcast
State Request eventorg.rdk.Xcast
  • USB Screen

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
  • Live TV

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
  • Voice Remote Control





Details of Voice Remote Control



  • HDMI Input





Returns an array of available HDMI Input ports



Provides access to the current configured video output port resolution.

PlayerInfo.1.resolution (read only )

Activates the specified HDMI Input port as the primary video source.



Deactivates the HDMI Input port currently selected as the primary video source.



Triggered whenever the status changes for an HDMI Input.



Triggered whenever a new HDMI device is connected to an HDMI Input.



Triggered whenever the signal status changes for an HDMI Input.



  • Picture Settings





Get/Set Supported Picture Modes


setSupportedPictureModes / getSupportedPictureModes

Get/Set Picture Modes


setPictureMode / getPictureMode

Get/Set Brightness


setBrightness / getBrightness

Get/Set Contrast


setContrast / getContrast

Get/Set Sharpness


setSharpness /getSharpness

Get/Set Color Temperature


setColorTemperature /getColorTemperature

Get/Set Saturation


setSaturation /getSaturation

Get/Set Backlight


setBacklight /getBacklight

Reset Values


resetBrightness / resetContrast / resetSharpness / resetColorTemperature / resetSaturation / resetBacklight

  • TimeZone





Gets the available timezones from the system’s time zone database



Get the configured time zone from the file



Sets the system time zone



  • Volume





Returns connected audio output ports



Returns the current volume level



Returns whether audio is muted on a given port



Adjusts the Volume Level on a specific port



Mutes or unmutes audio on a specific port



  • Voice





To manage VoiceSDK status and responseorg.rdk.VoiceControl

To provide visual feedback matching audio capture stateorg.rdk.VoiceControl
To provide visual feedback matching audio capture stateorg.rdk.VoiceControl
To provide visual feedback matching audio capture stateorg.rdk.VoiceControl

How To...

The following section details about few debug steps to confirm some generic issues and doubts when working with an RDK-V stack and this UI.

How to confirm platform key press events are reaching UI

Platform keymap could be differing from the UI keymap which could result in unexpected behaviors or UI not responding to key press events.

In general; UI receives the key press events through webkit browser when user interacts with STB using RCU or connected keyboard.

How to check the browser is able to receive the key events and which keyCode its being received from platform:

  1. Using Controller UI(a.k.a. ThunderUI); activate HtmlApp and load https://keycode.info/ as url. Controller UI is only available on a development build RDK-V image and it can be accessed from a local network connected computer where RDK-V device is connected. Note down the RDK-V deviceIP (Eg: let it be Then from the same network connected computer; open any web-browser and type in deviceIP:9998 in the address bar.
  2. Press any keys and confirm the keyCode being reported by https://keycode.info/.

How to check UI is able to receive the key events and which keyCode its being received at UI:

  1. Using Controller UI(a.k.a. ThunderUI) from any local network connected computer; open ResidentApp's webinspector and go to console tab.
  2. While pressing any key; corresponding keyCode will be printed at ResidentApp's webinspector console

How to debug UI not responding to key press events

  1. Verify that UI is able to receive the key events
  2. Verify the received key event is matching with UI specific keymap detailed at section "Key Mapping".

If the above two are not working or matching; please verify the platform integration.

If UI is not responding for the received key event and is matching with UI defined "Key Mapping"; please create a UI bug ticket or reach out to us. We'll be happy to help and resolve it for you.

  • No labels