...

This page details how to perform firmware upgrade using RDKM XCONF XConf Server.

RDKM offers a reference XCONF XConf server that is publicly accessible at the URL xconfXConf.rdkcentral.com. Users have the option either use this XCONF XConf server or can create their own.

If you are interested in setting up a custom XCONF XConf server, please visit the page  https://wiki.rdkcentral.com/display/RDK/XconfXConf+Server+-+User+guide+for+configuration+and+feature+validation for detailed instructions on installation and a usage guide.

The primary focus of this page is to guide you through the process of firmware upgrade using the RDKM XCONF XConf server xconfXConf.rdkcentral.com. 

User would be able to see two options in the landing page

1.  Xconf  XConf Admin UI
2. Xconf XConf Data service

Image Added

User needs to can configure the  firmware details firmware rules, configurations, Telemetry settings, RFC settings etc in the admin UI and in the data service option it currently tells which XCONF version is currently running and when it was updated lastly.

 Below diagram show the process flow of firmware upgrade via XCONF server

Image Removed

• Admin: Responsible for configuring the XConf firmware control rules specific to the model and upload the stable release firmware image to the file server.
• File Server: It hosts the firmware upgrade package. Could be supporting various protocols (HTTP,HTTPS, FTP, SFTP, TFTP etc) but these are not coming under Xconf's scope. XConf provides a File Server to host the firmware upgrade package but it does not mandate to use the same.
• XConf Server: When an STB queries for details about any available update, XConf shares the available details of firmware update package to STB after matching against its configured rules for that STB make & model.
• STB: This could be any RDKV flavour (IP/Hybrid STB, TV Platforms etc).  

Configure the device in XCONF

. While  dataservice, currently tells the XConf version information - Which version is used, when was it updated lastly and the commit informations etc.

Configure the device in XConf

In order to configure the device information user needs to login to XConf admin UI . For getting the access details, refer this page XConf Reference Setup Credentials and fill the information in admin UI and press login button.

Image Added

Once logged in, Users need to do basic configuration like setting up the environment, Creating the model information, Saves the mac Lists, IP Lists. These configurations are required for all device management features like RFC, Firmware upgrade, Telemetry etc.

Common Configurations

Create Environment

• Select Environments option within Common list to enter Environment page.
• After entered Environments page press create button to add your device environment detail.
• Give ID and Description to setup Environment for your device and save those details in XConf server

Image Added

Create Model

• Select Models option within common list to enter Models page.
• After entered Models page press create button to add your device model detail.
• Give ID and Description to setup Model for your device and save those details in XConf server.

Image Added

Create Mac List

• Select MAC Lists option within common list to enter MAC Lists page.
• After entered MAC Lists page press create button to add your device MAC detail.
• Give Name and Data to set MAC detail for your device and save those details in XConf server.

Image Added

XConf Xconf server provide information to STB like which Firmware version, From where to download the image and how(protocol) to download.

There are 3 significant steps involved in the Xconf XConf firmware upgrade configuration:

...

    How : Add your firmware details - File name ( Upgrading image name ), Version( Upgrading image name) and select your model name and save the details in Xconf XConf server.

2. Firmware rule – Rule is to map your device to the configuration created.

...

The configuration will be available through below Xconf XConf data service API: https://xconfXConf.rdkcentral.com:9092/xconfXConf/swu/stb/ 

Xconf Authorization Module Details

...

...

Image Removed

Create Environment

• Select Environments option within common list to enter Environments page.
• After entered Environments page press create button to add your device environment detail.
• Give ID and Description to setup Environment for your device and save those details in Xconf server

Image Removed

Create

...

• Select Models option within common list to enter Models page.
• After entered Models page press create button to add your device model detail.
• Give ID and Description to setup Model for your device and save those details in Xconf server.

Image Removed

Create Mac List

• Select MAC Lists option within common list to enter MAC Lists page.
• After entered MAC Lists page press create button to add your device MAC detail.
• Give Name and Data to set MAC detail for your device and save those details in Xconf server.

Image Removed

Create Firmware Config

Before configuring Firmware essentials, Ensure application type is stb.

• Select Firmware Configs option within common list to enter Firmware Configs page.
• After entered Firmware Configs page press create button to add your device firmware configuration detail.
• Give Description, File name ( Upgrading image name ), Version( Upgrading image name) and select your model name and save the details in Xconf XConf server.

Create Firmware Rules

...

Add the firmwareDownloadProtocol and copied link address as the firmwareLocation in Xconf XConf server.

Verification via

...

XConf firmware Test page

After creating the Firmware configs and Firmware rules, go to Firmware->Test page and give a parameter that will match the one of the rules that you have created. Then matched rule will be displayed like below. 

...

We need to follow the same steps as mentioned in the How to Prepare for XCONF XConf Server

To view the configurations set, we can use the Firmware Test page available as part of UI. 

...

Which means when user clicks for "Check for Update", downloaded this firmware information configured in the XCONF XConf server and boots up the image with that.  In the screenshot, you would be able to see the image initially loaded was sercom-generic-mediaclient-image_FBT_6.0.0-rc4_20231107155246 to sercom-generic-mediaclient-image_FBT_6.0.0-rc3_20231011085623

...