• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

Factory default parameters

When the STB is being produced in the factory, a set of default parameters are programmed into its flash memory. These parameters include boot up information such as the boot protocol to use, the boot server address to boot with, whether to use static or dynamic IP addressing, the color for the progress bar and status messsages, and so on. These parameters are known as the factory default configuration parameters.

For an additional cost (and a minimum volume) ARRIS can write your own custom settings into the STB flash memory when manufacturing it. If you are not using this service, we recommend you replace the standard ARRIS factory default configuration parameters in the STB flash memory with your own custom "factory default" parameters, according to the procedures below, before shipping the STB to the end-user.

Having custom factory default parameters means that when the end-user unboxes and powers up the STB, it already knows which boot server to contact. Should the end-user go into the boot loader menu and perform a factory reset, the configuration parameters will be restored to the custom ones you've set.

In addition to boot up parameters, certain security parameters can also be set (such as disabling access to the boot loader menus).

Changing the Factory Default Configuration Parameters

To change the ARRIS defaults to your own defaults, you need to first create an XML file containing the configuration parameters and values. This XML file is provided as an argument to the kreatv-option-upgrade-boot-loader IIP when building a new boot image. When the STB boots with this new boot image, it will write the provided configuration parameters into its flash memory as the new factory default.

An example configuration parameter file can be found in the SDK:

<sdk_root>/examples/configuration_parameters_vip4302.xml

<?xml version="1.0"?>
<Configuration>
<VendorClassId>ARRIS_VIP4302WBT_DEV</VendorClassId>
<BootcastId>arris-vip4302wbt-dev</BootcastId>
<IPConfigMethod>DHCP</IPConfigMethod>
<CurrentColorCoding>PAL</CurrentColorCoding>
<FrontButtonCode>0x74</FrontButtonCode>
<FrontButtonHardReset>3</FrontButtonHardReset>
<StatusScreenColor>0,128,255</StatusScreenColor>
</Configuration>

Incorrect configuration parameters are one of the very few ways which you could lose contact with an STB in the field and be unable to remotely resolve the situation. You MUST verify and test that these options work exactly as expected before you deploy any changes! Please get in contact with the ARRIS support team if you have any doubts about this process.

A list of all possible parameters and their function is provided here. A valid configuration parameter upgrade XML file is defined using this DTD file.

Signing

The configuration parameter file needs to be signed (just like the splash screen) before it will be accepted. The necessary tool and key are located in the SDK and instructions can be found here. The process is identical to signing the splash image.

Building the boot image

The final step is to add the signed configuration parameter file into a boot image. Just add


kreatv-option-upgrade-boot-loader:config=configuration_file.xml.sec

Now boot the STB with this new boot image, and it will write the configuration parameters to the flash memory.

5.1.1.p8

Copyright (c) 2018 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.