xTVFusion 5.2

Troubleshooting the STBJuly 2011

10843-00 Rev. A

IMPORTANTBefore proceeding, check the Minerva Networks Technical Support Web site to ensure that you have the latest version of this document. Minerva Networks occasionally revises its documentation to update content and correct errors.

This documents revision (Rev) is listed at the bottom of this page.

Contacting Minerva Networks

For more information about Minerva Networks, see http://www.minervanetworks.com.

Minerva Networks, Inc. 2150 Gold StreetAlviso, CA 95002USA Tel: 408.567.9400Fax: 408.567.0747Toll Free: 800.806.9594

Minerva Networks Support Services 800-9-MINERVA800-964-6378408-904-1299Support Request: http://support.minervanetworks.com

Minerva Networks Product Information 800-806-9594408-567-9400http://www.minervanetworks.com

Copyright 2011 Minerva Networks, Inc. All rights reserved, also protected by patents granted/pending in US/China/Others. Printed in the USA. Minerva is a registered trademark of Minerva Networks, Inc. All other trademarks or registered trademarks are the property of their respective companies.This document and the software/hardware described in it are copyrighted with all rights reserved world-wide. Under the copyright laws, neither this document nor related software may be copied, in whole or in part, without written consent of Minerva Networks, Inc., except in the normal use acceptable to Minerva Networks. Under the law, copying includes translating into another language or format. Minerva Networks, Inc., provides this publication as is without warranty of any kind, either express or implied, including but not limited to the implied warranties or conditions or merchantability or fitness for a particular purpose. In no event shall Minerva Networks be liable for any loss of profits, loss of business, loss of use or data, interruption of business, or for indirect, special, incidental, or consequential damages of any kind, even if Minerva Networks has been advised of the possibility of such damages arising from any defect or error in this publication. Minerva Networks may revise this publication from time to time without notice. Some states or jurisdictions do not allow disclaimer of express or implied warranties in certain transactions; therefore, this statement may not apply to you. Minerva Networks is not obligated to update or upgrade any hardware product (whether or not a Minerva Networks product) that may be required to run this software release or upgrade. This release or upgrade is licensed on the same terms as apply to the software program to which this release or upgrade relates. You may be viewing this document via electronic means. While every effort has been taken to ensure the highest quality, some forms of electronic transmission can degrade the quality of both print and illustra-tions. The quality of documentation is best when a printout is generated from a native source (e.g., floppy disk or CD-ROM) and printed on a high-quality laser printer.

xTVFusion 5.2 Troubleshooting the STBDocument History

Document Version Date

Software Version Description

00-A 11/21/2011 5.2 Initial release.www.minervanetworks.com 3

xTVFusion 5.2 Troubleshooting the STBwww.minervanetworks.com 4

November 2011 xTVFusion 5.2 Troubleshooting the STB

Contents

Introduction.........................................................................................................................7Audience ...................................................................................................................................7Document Conventions.............................................................................................................7Glossary ....................................................................................................................................7

xTVClient Boot Sequence..................................................................................................9Configuring the Boot Screen.....................................................................................................9Version Information .................................................................................................................10Boot Steps...............................................................................................................................12Error Codes.............................................................................................................................14Boot Timings ...........................................................................................................................14www.minervanetworks.com 5

xTVFusion 5.2 Troubleshooting the STB Contentswww.minervanetworks.com 6

Glossary

For a list of terms, acronyms, adocument xTVFusion 5.2 Technnd initialisms that are used by xTVFusion 5.2, see the Glossary chapter of ical Overview.November 2011 xTVFusion 5.2 Troubleshooting the STB

Introduction

This document describes the software version strings and error messages that are displayed in the STBs boot screen while the device is booting.

Audience

This book is intended to be used by system integrators and technical support personnel who are troubleshooting xTVBackOffice/STB communication problems.

Document Conventions

General Typography

The table below describes the typography thats used throughout the Minerva documentation.

Typeface UseAbcdef Used for interface labels, both in the xTVBackOffice Console and on the STB. For example:

Channel Management (xTVBackOffice Console), Share Rental (STBs Buy Dialog panel).Abcdef Used for messages that are displayed on the STB. For example: Blocked Movie, Blocked

Program.abcdef Used for filenames, literal command line input, and API keywords. For example:

datafile.dat (file), itvmgrctl (command), md_cst.add_customer() (xTVBackOffice API stored procedure), vaultCategoryListRect (Thinkstuff statement).

abcdef Used for non-literal command line input. For example: itvmgrPassword. abcdef Used for command line output and file contents. For example: Password:. Abcdef Used for references to other books and chapters. For example: See the Think Application

Arguments chapter of the sTVFusion 5.1 Client Configuration Guide for details.www.minervanetworks.com 7

xTVFusion 5.2 Troubleshooting the STB Introductionwww.minervanetworks.com 8

November 2011 xTVFusion 5.2 Troubleshooting the STB

xTVClient Boot Sequence

During the boot sequence, the xTVClient application displays a boot screen that provides information about the STBs software versions, and that describes the current boot step. If the boot sequence fails, a dialog displays an error message. This chapter looks at the content of the version information, boot sequence, and error messages. A final section provides information about the amount of time it typically takes for xtvClient to execute each boot step.

Configuring the Boot Screen

You can use boot arguments to specify whether to display boot steps in integer format (the default) or in text format in the boot screen. These modes are shown below:

Integer Format

Text Format

Note that the software version information is the same regardless of the boot screen mode, although, as shown above, its presented in different parts of the screen.

Error messages are also presented as codes or as text:www.minervanetworks.com 9

xTVFusion 5.2 Troubleshooting the STB xTVClient Boot SequenceError Message as Code

Error Message as Text

You declare which mode you want (integer codes or text) through the Use Integer Boot Status Display xtvClient argument (-uib). For details, see the xtvClient Application Arguments chapter of document xTVFusion 5.2 xTVClient Configuration Guide.

The boot and error text messages are not localizable.

Version Information

As mentioned above, the software version information is the same regardless of the boot screen mode. Figure 3-3. shows the version information as it appears in integer mode:

Software Version Information in Boot Screen

The version information describes four components:

First line below the spinning wait icon. Version information about the xtvClient application. See xtvClient Version String, below, for more information.

Firm Info. Version information about the STB firmware, as provided by the implementer of the STB-specific part of xtvClient. Typically, the firmware is provided by the STB manufacturer.

OS: Info. The name and version of the STBs operating system. This is also provided by the implementer of the STB-specific part of xtvClient.

BRP: Info. Version information about the Bandwidth Reservation Protocol software, as provided by Minerva. If BRP isnt used, the information isnt displayed. Bandwidth reservation is used during VOD transmission (only) to help guarantee problem-free playback. Currently xTVFusion only recognizes the Calix BRP. For more on Calix, go to www.calix.com.www.minervanetworks.com 10

xTVFusion 5.2 Troubleshooting the STB xTVClient Boot SequencextvClient Version String

The form of the xtvClient application version string is:

Major.Minor.Build.FlavorVerid.Production.CA

In the image above, the xtvClient application version string is 3.0.98.Tverid.D.CAVersion. With reference to this string as an example, the parts are:

Major (3). The xTVFusion major release number. Minor (0). The xTVFusion minor release number. Build (98). The xTVFusion build number. Flavor (T). A special build flavor designation. The exact value has no particular significance, its simply

another disambiguating symbol. Verid (verid). A value that you can supply through xtvClients Version ID argument (-verid). See the

xtvClient Application Arguments chapter of the xTVFusion 5.2 xTVClient Configuration Guide book for details. Production (D). Designates the production quality of the software: D if its still being developed, or R if

it has been released for deployment. CA (CAVersion). If the build includes Conditional Access client software, this gives the version of that

software. Boot Icons

As xTVClient is booting, the boot screen shows a spinning flower icon, as shown here:

As long as the flower is spinning, xTVClient is booting. However, the spin isnt continuous: If the spinning pauses, that doesnt mean that xTVClient has died. The amount of time that the spin can pause depends on the type of STB. On the slowest STBs, the icon might stop spinning for as long as a minute, particularly as xTVClient is retrieving the resources that it needs to operate (boot steps 6 and 11, as described in section Boot Steps below).

If the boot process finds an error, xTVClient replaces the spinning flower with the warning icon shown here:

The type of error is represented by an error code or described textually, as described in section Error Codes below.

IMPORTANT: If xTVClient cant spawn the Announcement Listener thread the warning icon isnt displayed. Instead, the STB will automatically reboot. This is described in the next section (boot step 13).www.minervanetworks.com 11

xTVFusion 5.2 Troubleshooting the STB xTVClient Boot SequenceBoot Steps

As xTVClient is starting, it announces its progress through boot messages that are displayed in the boot screen. In integer mode, the boot screen announces the current boot sequence stage (or boot step) through the M/N display, where M is the current step, and N is the total number of steps. In text mode, individual boot steps are described textually.

The integer boot step sequence isnt linear, and not all steps are taken each time the STB boots. Most of the time, the STB only performs five or six boot steps.

The table, below, lists and describes the main boot steps in the order in which theyre typically performed. Because some of the steps are performed in parallel, the exact order is indeterminate. The error codes (referred to some descriptions in the Description column) are described in the next section.

Table 1:

Integer Code(-uib = 1)

Text(-uib = 0) Description

4 Booting... xTVClient is beginning the boot process.

3 Initializing xTVClient is still beginning the boot process. Nothing significant happens between the previous step and this one.

19 Receiving Boot String xTVClient is downloading its arguments from the Multicast Server. See the Multicast Argument String entry (-mcast_arg_grp) in the xTVClient Application Arguments chapter of the xTVFusion 5.2 xTVClient Configuration Guide book for details.

1 Version Upgrade The information in NVRAM is being updated. This should only happen the first time the STB is booted after a xTVClient application upgrade.

2 Waiting for CA Init... xTVClient is waiting for the Conditional Access software (on the STB) to initialize itself. If the CA PIN needs to be reset, the user is told that the STB will need to be rebooted (see error R0025). If CA isnt used, this step is skipped.

none none System information is being retrieved from NVRAM or from the server. If the system info couldnt be retrieved, error E0040 is raised.

IMPORTANT: Theres no boot message to announce this step in the sequence.

6 Loading Resources xTVClient is retrieving resources from the Primary Dispatcher. This includes the graphics that are displayed in the xTVClient UI, localized strings, Thinktuff files, truncated versions of the EPG and the VOD catalog, and so on. If xTVClient cant reach the Primary Dispatcher, it will try the Redundant Dispatcher (if there is onesee the next boot step). www.minervanetworks.com 12

hdtelsur09Highlight

xTVFusion 5.2 Troubleshooting the STB xTVClient Boot Sequence11 Loading Resources: Redundant Dispatcher 1

xTVClient failed to find the Primary Dispatcher, and so is trying to retrieve resources from the Redundant Dispatcher (if a Redundant has been assigned).

If neither the Primary nor the Redundant Dispatcher can be found, xTVClient raises error E0046.

13 Spawning Announcement Listener

The thread that listens to the Boot Servers Announcement Stream is being spawned.

If the Announcement Listener thread cant be spawned, xTVClient doesnt raise an error. It will either automatically reboot or it will continue the current boot attempt, depending on the value of the Reboot on Announcement Stream Death xTVClient argument (-rboda). The maximum number of reboot attempts is set through the Number of Failed Boots Retry Threshold argument (-nfbrt). See the xTVClient Application Arguments chapter of the xTVFusion 5.2 xTVClient Configuration Guide book for details.

IMPORTANT: If xTVClient boots without an Announcement Listener thread, the STB will almost certainly be unusable. Currently, theres no way to determine if (or why) the spawn failed.

16 Getting Localized Strings The localized strings are unbundled and parsed. If the strings arent in the proper format, error E0043 is raised.

17 Getting Customer Info

IMPORTANT: The text of this message is misleading. It should be Reading Configuration

The Thinkstuff files are unbundled and parsed. If the Thinkstuff is in the wrong format or otherwise couldnt be read, error E0042 is raised.

18 Process Languages Strings

IMPORTANT: The text of this message is misleading. It should be Authenticating Customer

xTVClient checks the customers information to see if the account is authorized to use this STB. If the customer isnt authorized, the Authentication Screen is displayed.

20 Boot Done The boot sequence has finished. xTVClient will now either display the Login Screen or go immediately to live video.

Table 1:

Integer Code(-uib = 1)

Text(-uib = 0) Descriptionwww.minervanetworks.com 13

xTVFusion 5.2 Troubleshooting the STB xTVClient Boot SequenceError Codes

The table below lists and describes the error codes that are raised during the STB boot sequence.

Boot Timings

The tables, below, display the amount of time it takes xtvClient to execute each boot step on the various STBs. As described in the previous section, the exact order of the steps is indeterminate. In these tables, weve chosen a typical boot step sequence. The timings start when the STB is booted and end when the Login Screen or live video is displayed.

These timings are meant to be used as general guidelines, and not as guarantees of performance. The amount of time it actually takes an STB to boot depends on a number of factors, such as the number of other STBs that are booting at the same time, the number of channels in the EPG, the speed of the network, and so on.

Table 2:

ErrorCode

(-uib = 1)Text

(-uib = 0) Description

R0025 CA PIN Set: Reboot Needed The Conditional Access PIN has been reset, so the STB has to reboot.

E0028 Insufficient Memory Not enough free memory to boot the STB.

E0040 Boot error. Hit any key to retry.

IMPORTANT: The text of this message should be interpreted to mean Press any button on the remote control to retry.

System information couldnt be found. In a deployed system this could be because there was an interruption in the Boot Stream. If youre running the STB Simulator, make sure the Boot Mode xtvClient argument (-bm) is set to 1 or 2. See the xtvClient Application Arguments chapter of the xTVFusion 5.2 xTVClient Configuration Guide book for details.

E0042 Boot error. Hit any key to retry. The Thinkstuff files, which were successfully downloaded to the STB, couldnt be read.

E0043 Boot error. Hit any key to retry. The localized strings package, which was successfully downloaded to the STB, couldnt be read.

E0046 Boot error. Hit any key to retry. Resources werent successfully downloaded; NVRAM will be reset after which the STB will try again.

E0047 Boot error. Hit any key to reboot.

IMPORTANT: The text of this message should be interpreted to mean Press any button on the remote control to reboot.

The STB has given up trying to boot. The maximum number of retries is set through the Number of Failed Boots Retry Threshold argument (-nfbrt). See the xtvClient Application Arguments chapter of the xTVFusion 5.2 xTVClient Configuration Guide for details.www.minervanetworks.com 14

xTVFusion 5.2 Troubleshooting the STB xTVClient Boot SequenceCisco STB

The following table gives timings for two deployment configurations (small and large), each with and without a software version upgrade during the boot.

The small deployment is:

10 customers 6 devices 18 Live channels No PPV channels

The large deployment is:

6000 customers 5000 devices 688 Live channels 4 PPV channels

Table 3:

Boot Step Running Time (mm:ss)

Small/No upgrade Small/Upgrade Large/No upgrade Large/Upgrade

STB boots 00:00 00:00 00:00 00:00

Boot Screen appears 01:17 01:30 01:18 01:18

3 01:19 01:40 01:20 01:20

6 01:28 01:41 01:29 01:29

11 01:29 01:53 01:30 01:30

13 01.52 01.58 02.59 03:01

16 01:56 02:00 03:03 03:07

17 02:07 02:12 03:11 03:14

18 02:13 02:17 03:15 03:17

20 02:15 02:26 03:20 03:21

Login Screen orlive video is displayed

02:16 02:30 03:21 03:23www.minervanetworks.com 15

xTVFusion 5.2 Troubleshooting the STB xTVClient Boot Sequencewww.minervanetworks.com 16

ContentsIntroductionAudienceDocument ConventionsGeneral Typography

Glossary

xTVClient Boot SequenceConfiguring the Boot ScreenVersion InformationxtvClient Version String

Boot StepsError CodesBoot TimingsCisco STB