Broadband Forum

    DATA MODEL DEFINITION


TR-069 STBService:1.2 Service Object definition
tr-135-1-2-0.xml (changes)

License

Copyright (c) 2009-2017, Broadband Forum

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms <https://www.broadband-forum.org/ipr-policy>.

Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.

Summary

STBService:1.2 Service Object

Table of Contents

Data Types

The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.

Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MacAddress]). However, such parameters still indicate their SOAP data type.

Data Type Base Type Description
Alias string(64)

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
base64 -

Base64 encoded binary (no line-length limitation).

A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type.
hexBinary -

Hex encoded binary.

A minimum and maximum allowed length can be indicated using the form hexBinary(Min:Max), where Min and Max are the minimum and maximum length in characters before Hex Binary encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in hexBinary(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

int -

Integer in the range -2147483648 to +2147483647, inclusive.

For some int types, a value range is given using the form int[Min:Max] or int[Min:Max step Step] where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

long -

Long integer in the range -9223372036854775808 to 9223372036854775807, inclusive.

For some long types, a value range is given using the form long[Min:Max] or long[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

object - A container for parameters and/or other objects. The full Path Name of a parameter is given by the parameter name appended to the full Path Name of the object it is contained within.
string - For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges.
unsignedInt -

Unsigned integer in the range 0 to 4294967295, inclusive.

For some unsignedInt types, a value range is given using the form unsignedInt[Min:Max] or unsigned[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

unsignedLong -

Unsigned long integer in the range 0 to 18446744073709551615, inclusive.

For some unsignedLong types, a value range is given using the form unsignedLong[Min:Max] or unsignedLong[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

References

[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.

STBService:1.2 Data Model (changes)

For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent supports only a single parameter that was introduced in version 1.2, then it will indicate support for version 1.2. The version number associated with each object and parameter is shown in the Version column.

Name Type Write Description Object Default Version
STBService.{i}. object -

The top-level object for an STB CPE.

At most one entry in this table can exist with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Capabilities. object - The overall capabilities of the STB CPE. This is a constant read-only object, meaning that only a firmware update will cause these values to be altered. - 1.0
STBService.{i}.Capabilities.VideoDecoder. object - Video decoder capabilities. - 1.0
STBService.{i}.Capabilities.VideoDecoder.MPEG2Part2. object - Object describing the set of supported MPEG2 profiles and levels for this STB. It also describes the set of audio standards supported when MPEG2 Part 2 is used as the video standard. - 1.0
STBService.{i}.Capabilities.VideoDecoder.MPEG2Part2.ProfileLevel.{i}. object -

Table to describe the set of profiles and levels combinations supported by the STB when MPEG2 Part 2 is used as video standard.

At most one entry in this table can exist with the same values for Profile and Level, or with a given value for Alias. The table MUST include a distinct entry for each supported combination of these parameters.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Capabilities.VideoDecoder.MPEG4Part2. object - Object describing the set of supported profiles and levels for this STB. It also describes the set of audio standards supported when MPEG4 Part 2 is used as the video standard. - 1.0
STBService.{i}.Capabilities.VideoDecoder.MPEG4Part2.ProfileLevel.{i}. object -

Table to describe the set of profiles and levels combinations supported by the STB when MPEG4 Part 2 is used as video standard.

At most one entry in this table can exist with the same values for Profile and Level, or with a given value for Alias. The table MUST include a distinct entry for each supported combination of these parameters.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Capabilities.VideoDecoder.MPEG4Part10. object - Object describing the set of supported profiles and levels for this STB. It also describes the set of audio standards supported when MPEG4 Part 10 is used as the video standard. - 1.0
STBService.{i}.Capabilities.VideoDecoder.MPEG4Part10.ProfileLevel.{i}. object -

Table to describe the set of profiles and levels combinations supported by the STB when MPEG4 Part 10 is used as video standard.

  The table MUST include a distinct entry for each supported combination of these parameters.

At most one entry in this table can exist with the same values for Profile and Level, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Capabilities.VideoDecoder.SMPTEVC1. object - Object describing the set of supported SMPTE-VC-1 profiles and levels for this STB. It also describes the set of audio standards supported when SMPTE-VC-1 is used as the video standard. - 1.0
STBService.{i}.Capabilities.VideoDecoder.SMPTEVC1.ProfileLevel.{i}. object -

Table to describe the set of profiles and levels combinations supported by the STB when SMPTE-VC-1 is used as video standard.

At most one entry in this table can exist with the same values for Profile and Level, or with a given value for Alias. The table MUST include a distinct entry for each supported combination of these parameters.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components. object - Details of STB logical or physical internal components. Unlike the Capabilities object, which is read-only and which doesn't describe individual instances, this object contains some writeable parameters. - 1.0
STBService.{i}.Components.FrontEnd.{i}. object -

FrontEnd instance table. Each front-end instance, including vendor-specific front-end types, will normally have a sub-object that corresponds to the front-end type (e.g. DVB-T or IP).

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.FrontEnd.{i}.DVBT. object -

DVB-T front-end details. This object will normally be present if and only if this front-end is a DVB-T front-end.

Parameters are taken from the DGTVi D-Book [D-Book].

- 1.0
STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceListDatabase. object - DVB-T service list database. - 1.0
STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceListDatabase.LogicalChannel.{i}. object -

DVB-T logical channel information.

At most one entry in this table can exist with a given value for LogicalChannelNumber, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceListDatabase.LogicalChannel.{i}.Service.{i}. object -

DVB-T service information.

At most one entry in this table can exist with a given value for DvbId, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.FrontEnd.{i}.IP. object - IP front-end details. This object will normally be present if and only if the front-end is an IP front-end. - 1.0
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP. object - Parameters that are specific to IGMP clients when changing channels. - 1.0
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroup.{i}. object -

IGMP Group table. This is the database that is maintained by the IGMP client to reflect the current group membership.

The CPE MUST support at least MaximumNumberOfConcurrentGroups table entries.

At most one entry in this table can exist with a given value for GroupAddress, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroupStats.{i}. object -

IGMP Group statistics table. This stores per-group historical statistical data.

The CPE MUST support at least MaximumNumberOfTrackedGroups table entries. The CPE MAY reclaim entries based on the oldest membership reports.

At most one entry in this table can exist with a given value for GroupAddress, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.FrontEnd.{i}.IP.Inbound.{i}. object -

Inbound IP streams currently entering the STB via this front-end.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.FrontEnd.{i}.IP.Outbound.{i}. object -

Parameters related to an outbound IP stream.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.PVR. object - PVR details. This is a read-only object that exists only to reference PVR storage objects. - 1.0
STBService.{i}.Components.PVR.Storage.{i}. object -

PVR storage table. There MUST be an instance for each storage object that can be accessed by the PVR. Entries MAY be dynamically created and deleted as storage devices become available and unavailable.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.AudioDecoder.{i}. object -

Audio decoder instance table. It contains data representing the current status of the Audio decoder.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.VideoDecoder.{i}. object -

Video decoder instance table. It contains data representing the current status of the video decoder.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.AudioOutput.{i}. object -

Audio output instance table.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.SPDIF.{i}. object -

S/PDIF output instance table configuration. This object, if present, is connected to the audio ouput instance currently delivering S/PDIF audio format as described in [SPDIF].

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.1
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.VideoOutput.{i}. object -

Video output instance table.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.SCART.{i}. object -

SCART configuration. This object allows configuration of the STB's AV switching.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.HDMI.{i}. object -

HDMI instance table. This object allows configuration of the STB’s HDMI output.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.1
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.CA.{i}. object -

This object describes the characteristics of the Conditional Access, if any.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Components.DRM.{i}. object -

This object describes the characteristics of the Digital Rights Management, if any.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.AVStreams. object - AV Streams object. If more than one AV stream can be active at a time, it may contain several AVStream instances. - 1.0
STBService.{i}.AVStreams.AVStream.{i}. object -

Details of each AVStream. AV streams are created statically. Each AV stream corresponds to a valid {FrontEnd, AudioDecoder, VideoDecoder} instance combination (although if the PVR is active for this stream, only {FrontEnd} or {AudioDecoder, VideoDecoder} will be in use).

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.AVPlayers. object -

AV Players object. If more than one AV player can be active at a time, it may contain several AVPlayer instances.

AV players are created statically. Each AV player corresponds to a combination of several AV streams (one main screen video, several PIP, one audio) being connected to an AV presentation device (such as a TV set).

There is no guarantee that the STB has the resources to enable all of its AV players at the same time.

- 1.0
STBService.{i}.AVPlayers.AVPlayer.{i}. object -

List of AV Player objects. Each item is one particular AV player being processed by the STB.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.ServiceMonitoring. object -

Contains statistics relating to the QoS / QoE of Main AV streams. These statistics are broken down into categories, e.g. de-jittering and RTP, and for each category there are two types of statistics:

  • Total statistics, which count the number of occurrences of something.
  • Sample statistics, which are measured over a sample interval, and are made available to the ACS as a list of the most recent n samples.

Total statistics are always collected (collection cannot be disabled, but the values can be reset).

For Sample statistics, an STB uses a single sample interval and number of samples (n) for all MainStream instances. The sample interval can be aligned with absolute time.

When Sample statistics collection is enabled, statistics collection MUST proceed regardless of whether there are any active Main AV streams. For example, even when the STB is not receiving any data, sample intervals will continue to be timed as normal.

Refer to [I.3/TR-135] for non-normative explanation of the operation of the ServiceMonitoring object.

- 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}. object -

List of Main AV stream objects. Each instance is associated with a specified service type and will collect statistics only for the main stream that matches that service type.

Note that this means that streams that do not match an instance's service type MUST NOT contribute to the instance's Total and Sample statistics.

It is up to the STB to determine which AV stream should be regarded as the Main AV stream for a given service type at any given time. For example, if two active streams are associated with the same service type, the STB might prefer streams that are associated with an AV player, or if more than one stream is associated with an AV player, the STB might prefer a player that is outputting a DVI stream to a player that is outputting an RF stream.

Note that some parameters, e.g. Components.FrontEnd.{i}.IP.ServiceConnect.URI, include requirements that restrict the STB's freedom to determine which AV stream should be regarded as the Main AV stream for a given service.

At most one entry in this table can exist with a given value for ServiceType, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample. object -

Sample statistics collected since collection was last enabled or reset.

Most of the parameters in this object are comma-separated lists of individual statistics values, each of which corresponds to a sample interval.

The statistics values in these comma-separated lists MUST be in time order, with the oldest one first and the most recent one last.

Comma-separated list can contain up to ReportSamples statistics values. When the list is full, each new value causes the oldest one to be discarded.

Some comma-separated lists contains terms that are colon-separated lists and are used to store measurements on an event basis. These colon-separated lists can contain up to Capabilities.ServiceMonitoring.MaxEventsPerSampleInterval values.

If no data was collected for a statistic during a sample interval then the value for that sample interval MUST be zero unless otherwise specified in the description of the individual statistics parameter.

- 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.{i}. object -

High-level metric Sample statistics for this ServiceMonitoring main stream instance. One or more different high-level metrics can be supported; this is specified by ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStatsNumberOfEntries.

At most one entry in this table can exist with a given value for MetricName, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Applications. object - Applications. - 1.0
STBService.{i}.Applications.AudienceStats. object - Audience viewing statistics. - 1.0
STBService.{i}.Applications.AudienceStats.Channel.{i}. object -

Table to record what the STB has been receiving. Time durations are recorded only for an AVPlayer's main AVStream (i.e. for TV channels being displayed in the main screen).

Each entry corresponds to a given TV channel and is indexed by channel name (the instance number is chosen by the STB and is not related to the channel number).

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Applications.CDSPush. object - Details of STB CDS Push logical internal parameters. - 1.1
STBService.{i}.Applications.CDSPush.ContentItem.{i}. object -

Content Item instance table.

At most one entry in this table can exist with a given value for ContentReferenceId, or with a given value for Alias.

- 1.1
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Applications.CDSPull. object - Details of STB CDS Pull logical internal component. This object is present only if the user allowed (via his local STB UI) the remote management of the CDS Pull service. - 1.1
STBService.{i}.Applications.CDSPull.ContentItem.{i}. object -

Content Item instance table.

At most one entry in this table can exist with a given value for ContentReferenceId, or with a given value for Alias.

- 1.1
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2
STBService.{i}.Applications.ServiceProvider.{i}. object -

Service Provider instance table.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 1.1
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.2

Inform and Notification Requirements

Forced Inform Parameters

Parameter

Forced Active Notification Parameters

Parameter

Default Active Notification Parameters

Parameter

Parameters for which Active Notification MAY be Denied

Parameter
STBService.{i}.
Alias
STBService.{i}.Capabilities.VideoDecoder.MPEG2Part2.ProfileLevel.{i}.
Alias
STBService.{i}.Capabilities.VideoDecoder.MPEG4Part2.ProfileLevel.{i}.
Alias
STBService.{i}.Capabilities.VideoDecoder.MPEG4Part10.ProfileLevel.{i}.
Alias
STBService.{i}.Capabilities.VideoDecoder.SMPTEVC1.ProfileLevel.{i}.
Alias
STBService.{i}.Components.FrontEnd.{i}.
Alias
STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceListDatabase.LogicalChannel.{i}.
Alias
STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceListDatabase.LogicalChannel.{i}.Service.{i}.
Alias
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroup.{i}.
Alias
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroupStats.{i}.
Alias
STBService.{i}.Components.FrontEnd.{i}.IP.Inbound.{i}.
Alias
STBService.{i}.Components.FrontEnd.{i}.IP.Outbound.{i}.
Alias
STBService.{i}.Components.PVR.Storage.{i}.
Alias
STBService.{i}.Components.AudioDecoder.{i}.
Alias
STBService.{i}.Components.VideoDecoder.{i}.
Alias
STBService.{i}.Components.AudioOutput.{i}.
Alias
STBService.{i}.Components.SPDIF.{i}.
Alias
STBService.{i}.Components.VideoOutput.{i}.
Alias
STBService.{i}.Components.SCART.{i}.
Alias
STBService.{i}.Components.HDMI.{i}.
Alias
STBService.{i}.Components.CA.{i}.
Alias
STBService.{i}.Components.DRM.{i}.
Alias
STBService.{i}.AVStreams.AVStream.{i}.
Alias
STBService.{i}.AVPlayers.AVPlayer.{i}.
Alias
STBService.{i}.ServiceMonitoring.MainStream.{i}.
Alias
STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.{i}.
Alias
STBService.{i}.Applications.AudienceStats.Channel.{i}.
Alias
STBService.{i}.Applications.CDSPush.ContentItem.{i}.
Alias
STBService.{i}.Applications.CDSPull.ContentItem.{i}.
Alias
STBService.{i}.Applications.ServiceProvider.{i}.
Alias

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

Abbreviation Description
R Read support is REQUIRED.
W Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only.
P The object is REQUIRED to be present.
C Creation and deletion of instances of the object is REQUIRED.
A Creation of instances of the object is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object is REQUIRED, but creation is not REQUIRED.


Generated by Broadband Forum report.pl#422 (2018/03/28 version) on 2018/04/02 at 12:20:44.
report.pl --exitcode=fatals --cwmpindex=.. --nofontstyles --nowarnreport --quiet --lastonly --report=html --outfile=tr-135-1-2-0-diffs.html tr-135-1-2-0.xml