RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
...
Table of Contents maxLevel 1
This page detailed details how to perform firmware upgrade via using RDKM XCONF XConf Server.
RDKM provides offers a reference XCONF XConf server which that is can be accessed publicly using accessible at the URL xconfXConf.rdkcentral.com. User can eirther Users have the option either use this XCONF XConf server or can create their own XCONF server.
For custom XCONF If you are interested in setting up a custom XConf server, Please please visit the page https://wiki.rdkcentral.com/display/RDK/XconfXConf+Server+-+User+guide+for+configuration+and+feature+validation provides the details of for detailed instructions on installation and a usage guide. This page details how to use the RDKM XCONF server
The primary focus of this page is to guide you through the process of firmware upgrade using the RDKM XConf server XConfxconf.rdkcentral.com.
User would be able to see two options in the landing page
User needs to can configure the firmware details firmware rules, configurations, Telemetry settings, RFC settings etc in the admin UI and in the dataservice 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/
. 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.
...
...
User also has the option to choose multiple mac address from a file. User can use a browse button on the right side of the UI to select the files which holds the mac addresses.
Note: All formats are not accepted here. each line holds only a single mac address
Code Block |
---|
Eg:
AA:AA:AA:AA:AA:AA
BB:BB:BB:BB:BB:BB |
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
...
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.
...
By default, rebootImmediately flag will be false. If we need to perform reboot immediately after writing the image to other partition, User can configure REBOOT_IMMEDIATELY_FILTER
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 has provides the option to upgrade perform the firmware upgrade. User can go to the option to Settings->Other Settings->Advanced Settings-> Device -> Firmware Update
Select Check for Update
Note |
---|
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
Note |
---|
Other state changes are not visible in the current screen, you need to go to the previous page and has to come back to see the state changes |
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 screenshoot, 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
Note |
---|
Other state changes are not visible in the current screen, you need to go to the previous page and has to come back to see the state changes |
...
As this being the reference UI, Current implementation is using only the API calls not the Events of plugin and API is invoked only when a page transition is done. So we may need to go to the previous screen's in order to see the transitions
STB will check for upgrade and downloads to the other partition and next time boots up with this image. If reboot immediately filter is set to true in the XConf server, STB will go for immediate reboot once the image write is successful in the other partition.
Show If | ||
---|---|---|
| ||
Validations performed in two video accelerator devices and details are captured in Validations - Firmware Upgrade using RDKM XCONF Server |