You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Next »


Pre-requisites

  • The user must configure a local TFTP (Trivial File Transfer Protocol) or HTTP (Hypertext Transfer Protocol) server.
  • Ensure that both the local HTTP/TFTP server and the device are on the same network

Overview

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

  1.  XConf Admin UI
  2. XConf Data service


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.



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.

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


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.


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.


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/ 

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

Create Firmware Rules

  • Select Firmware Rule option within common list to enter Firmware Rule page.
  • After entered Firmware Rule page press create button to add your device firmware Rule detail.
  • After entered firmware Rule page you can see list of default templates(ENV_MODEL_RULE, IP_RULE, MAC_RULE etc.)
    Note: If we need to create new custom template, go to Firmware → Firmware templates. Enter the ID name. Select priority from the 'Priority' drop down menu. Add conditions. Once saved s    elect the new template to create firmware rule
  • Choose MAC_RULE(any required template) in this list of Template to add your device MAC list in Firmware Configuration.
  • After we select the required template, 'Add firmware Rule' page will be displayed. Here the build conditions will be present from the 'template' that we added and in addition to that we can add additional Build Conditions also.
  • Add your device specific eStbMac under build condition option.
  • Select your firmware config under Action option and save your Firmware rule in XConf server.


Edit Download Location Round Robin Filter

  • Place the upgrading image in download location file server.
  • Select Download Location Filter option within common list to enter into Download Location Filter page.
  • After entered Download Location Filter page press edit button to add your Download Location details.
  • Enter FQDN and Full URL of the location. This location will be applied by default for all the devices.

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.

  •  Go to Firmware -> Firmware Rules -> Define Properties -> Create
  •  A page will be displayed with options to select the template. Select ‘DOWNLOAD_LOCATION_FILTER’ from the list
  • In this 'firmware rule' page with type 'DOWNLOAD_LOCATION_FILTER', we can specify the firmwareDownloadProtocol and firmware location . This property will override the default value set from ‘Download Round Robin location filter’.

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.


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. 


     



How to upgrade the Firmware 

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. 

Validations 


Validation performed in two devices. Amlogic skyworth and Sercomm realtek. 

Amlogic skyworth

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


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


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



  • No labels

DISCLAIMER: Please note that the use of the RDK Wiki is subject to its Privacy Policy & Terms of Use. In addition, this Wiki may be accessed by all RDK licensees and their contractors.