RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
This page detailed how to perform firmware upgrade via RDKM XCONF Server. RDKM provides a reference XCONF server which can be accessed publicly using the URL xconf.rdkcentral.com. User can either use this XCONF server or can create their own XCONF server.
If you are interested for custom XCONF server, Please visit the page https://wiki.rdkcentral.com/display/RDK/Xconf+Server+-+User+guide+for+configuration+and+feature+validation provides the details of installation and usage guide.
Current page is mainly focusing on how to do firmware upgrade via RDKM XCONF server xconf.rdkcentral.com.
User would be able to see two options in the landing page
User needs to configure the firmware details 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
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 firmware upgrade configuration:
1. Firmware Config – The firmware details will be configured here.
Where : Go to Firmware - > Firmware Configs -> Create.
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 server.
2. Firmware rule – Rule is to map your device to the configuration created.
Where : Go to Firmware -> FirmwareRule - > Create.
How : Select one of the default template like MAC_RULE.
Enter name of the rule, build condition (you can add estbMacAddress i.e. )
select the firmware config from the drop down list to map it with the rule
3. Download Location Filter – Here we can specify the download location URL and it’s protocol.
Where : Go to Firmware-> Download Location Filter -> Edit.
How : An Http location will be returned by default for all the devices. Enter FQDN and Full URL of the location.
The configuration will be available through below Xconf data service API: https://xconf.rdkcentral.com:9092/xconf/swu/stb/
Before configuring Firmware essentials, Ensure application type is stb.
Admin can set up an alternative download location for hosting the firmware image using any local file server . To add alternative location for the device, we need to override it from firmware rules.
For setting up Local File Server refer section "Setup a local File-Server" under Support Section. Below setup shows using hfs as file server:
Host the upgrade image in File-Server and copy the link address of the file url. Below snapshot was taken with another setup hence there is mismatch with the URI. Use the uri which is obtained from section "Setup a local File-Server", "link address of the image" (http://192.168.1.106:8001)
Add the firmwareDownloadProtocol and copied link address as the firmwareLocation in Xconf server.
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.
RDKUI has the option to upgrade the firmware. User can go to the option
Settings->Other Settings->Advanced Settings-> Device -> Firmware Update
Select Check for Update
We need to configure local http server or hfs server for validation.
In this document, we are configuring local hfs server.
Validation performed in two devices. Amlogic skyworth and Sercomm realtek.
We need to follow the same steps as mentioned in the How to Prepare for XCONF Server
To view the configurations set, we can use the Firmware Test page available as part of UI.
You can specify any key value parameters here in this document Key value is used as "estbMac" and value as the <device mac address>
here download location filter is used. this is to configure for specifying local hfs server's ip and protocol
Initial screen
After clicking Check for Update the state will change to Downloading
Sercomm Realtek
The configuration used in Sercomm Realtek can be found same as the firmware test page as below. Here one more filter is configured which is rebootfilter this has rebootImmediately set to true , in addition to the Download filter.
Which means when user clicks for "Check for Update", downloaded this firmware information configured in the 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
Initial screen
After clicking Check for Update the state will change to Downloading