RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
This page details how to perform firmware upgrade using RDKM XConf Server.
RDKM offers a reference XConf server that is publicly accessible at the URL XConf.rdkcentral.com. Users have the option either use this XConf server or can create their own.
If you are interested in setting up a custom XConf server, please visit the page https://wiki.rdkcentral.com/display/RDK/XConf+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 server XConf.rdkcentral.com.
User would be able to see two options in the landing page
User can configure firmware rules, configurations, Telemetry settings, RFC settings etc in the admin UI. While dataservice, currently tells the XConf version information - Which version is used, when was it updated lastly and the commit informations etc.
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.
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.
As our requirement is to perform firmware upgrade, User need to configure the information 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 can be configured here.
Where : Go to Firmware - > Firmware Configs -> Create.
How : Add your firmware details - File name ( Upgrading image name ), Version( Upgrading image version) and select your model name and save the details in XConf server.
Before configuring Firmware essentials, Ensure application type is stb.
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.
There is a by default location available in Download Round Robin location filter’, but 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.
Now we have everything configured in the XCONF server side. we can validate in the XConf Firmware test page to see the configurations set.
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 provides the option to perform the firmware upgrade. User can go to Settings->Other Settings->Advanced Settings-> Device -> Firmware Update
Select Check for Update
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