Broadband Forum

    DATA MODEL DEFINITION


STBService:1.4 Service Object definition [USP]
tr-135-1-4-1-usp.xml (changes)

License

Copyright (c) 2009-2019, 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

August 2015:

September 2019: Corrigendum 1

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 unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an "cpe-" prefix.

The value MUST NOT change once it's been assigned.

IPAddress string(45)

IP address, i.e. IPv4 address (or IPv4 subnet mask) or IPv6 address.

All IPv4 addresses and subnet masks MUST be represented as strings in IPv4 dotted-decimal notation. Here are some examples of valid IPv4 address textual representations:

  • 216.52.29.100
  • 192.168.1.254

All IPv6 addresses MUST be represented using any of the 3 standard textual representations defined in [RFC4291] Sections 2.2.1, 2.2.2 and 2.2.3. Both lower-case and upper-case letters can be used, but use of lower-case letters is RECOMMENDED. Here are some examples of valid IPv6 address textual representations:

  • 1080:0:0:800:ba98:3210:11aa:12dd
  • 1080::800:ba98:3210:11aa:12dd
  • 0:0:0:0:0:0:13.1.68.3

IPv6 addresses MUST NOT include zone identifiers. Zone identifiers are discussed in [Section 6/RFC4007].

Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be represented as empty strings unless otherwise specified by the parameter definition.

UUID string(36:36)

Universally Unique Identifier. See [RFC4122]. Possible patterns:

  • [A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}
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.

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.

References

[AC-3] E-AC-3, Digital Audio Compression (AC-3) Standard, Rev. B, document number A/52B, ATSC, June 2005.
[D-Book] DGTVi D-Book v1.0, Compatible receivers for the Italian market, Sep 2004.
[HDMI] HDMI, High-Definition Multimedia Interface 1.4a, March 2010.
[ISO/IEC11172-1] ISO/IEC 11172-1 (1993), Information Technology - Coding of moving pictures and associated audio for digital storage media at up to about 1.5 Mbit/s - Part 1: System, ISO/IEC, 1993.
[ISO/IEC11172-3] ISO/IEC 11172-3 (1993), Information Technology - Coding of moving pictures and associated audio for digital storage media at up to about 1.5 Mbit/s - Part 3: Audio, ISO/IEC, 1993.
[ISO/IEC13818-1] ISO/IEC 13818-1 (2nd edition, 2000), Information technology - Generic coding of moving picture and associated audio information: Systems, ISO/IEC, 2000.
[ISO/IEC13818-3] ISO/IEC 13818-3 (2nd edition, 1998), Information technology - Generic coding of moving picture and associated audio information: Audio, ISO/IEC, 1998.
[ISO/IEC13818-6] ISO/IEC 13818-6 (2nd edition, 1998), Information technology - Generic coding of moving picture and associated audio information: Extensions for DSM-CC, ISO/IEC, 1998.
[ISO/IEC14496-3] ISO/IEC 14496-3:2001, Information technology - Coding of Audio-Visual objects - Part 3: Audio, ISO/IEC, 2001.
[ISO/IEC14496-10] ITU-T Rec. H.264 | ISO/IEC 14496-10:2004/AM 1, Part 10, Advanced Video Coding AMENDMENT 1: AVC fidelity range extensions, ISO/IEC, 2004.
[ISO/IEC23003-1] ISO/IEC 23003-1:2007, Information technology - MPEG audio technologies - Part 1: MPEG Surround, ISO/IEC, 2007.
[RFC1350] RFC 1350, The TFTP Protocol (Revision 2), IETF.
[RFC2228] RFC 2228, FTP Security Extensions, IETF.
[RFC2326] RFC 2326, Real Time Streaming Protocol (RTSP), IETF.
[RFC2960] RFC 2960, Stream Control Transmission Protocol (SCTP), IETF.
[RFC3066] RFC 3066, Tags for the Identification of Languages, IETF.
[RFC3376] RFC 3376, Internet Group Management Protocol (IGMP) Version 3, IETF.
[RFC3550] RFC 3550, RTP: A Transport Protocol for Real-Time Applications, IETF, July 2003.
[RFC4078] RFC 4078, The TV-Anytime Content Reference Identifier (CRID), IETF.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4340] RFC 4340, Datagram Congestion Control Protocol (DCCP), IETF.
[RFC4585] RFC 4585, Extended RTP Profile for Real-time Transport Control Protocol (RTCP)-Based Feedback (RTP/AVPF), IETF.
[RFC4588] RFC 4588, RTP Retransmission Packet Format, IETF.
[SMPTE20022-1] SMPTE 20022-1 Application Layer Forward Error Correction.
[SPDIF] S/PDIF, Sony/Philips Digital InterFace IEC-958, IEC.
[SSH-FTP] SSH File Transfer Protocol.
[TR-106a1] TR-106 Amendment 1, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2006.
[TR-135] TR-135 Amendment 3, Data Model for a TR-069 Enabled STB, Broadband Forum, November 2012.
[TR-140] TR-140, TR-069 Data Model for Storage Service Devices, Broadband Forum.
[TS102034] ETSI TS 102 034, Digital Video Broadcasting (DVB); Transport of MPEG-2 Based DVB Services, ETSI.
[TS102323] ETSI TS 102 323, Digital Video Broadcasting (DVB); Carriage and signalling of TV-Anytime information in DVB transport streams, ETSI.
[VC-1] SMPTE VC-1, Compressed Video Bitstream Format and Decoding Process, document number 421M, SMPTE, Television, 2006.

STBService:1.4 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.4, then it will indicate support for version 1.4. 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. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 1.0
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.ServiceMonitoring. object - This object describes the capabilities of the ServiceMonitoring object. - 1.0
MaxMainStreamEventLogEntries unsignedInt - Maximum number of event log entries that the STB is able to record for a MainStream object instance. - 1.4
STBService.{i}.ServiceMonitoring. object -

Records events and collects QoS / QoE related statistics for 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
EventCollectionEnable boolean W

Enables or disables the collection of the events for all main streams.

When the collection of events is enabled, any previously collected events are discarded and the collection of new events begins immediately.

- 1.4
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. The non-functional key parameters ServiceType and Alias are immutable and therefore MUST NOT change once they've been assigned.

- 1.0
SessionId string­(36:36) - [UUID] Time based UUID [Section 4.2/RFC4122] that is the identifier for the associated AVStream parameter when available to the device. - 1.4
STBService.{i}.ServiceMonitoring.MainStream.{i}.EventLog. object -

This object represents the log entries of events recorded by the MainStream object instance.

When the number of log entries in the EventLog exceeds the value of the ###.Capabilities.ServiceMonitoring.MaxMainStreamEventLogEntries parameter, the Entry object with the lowest SequenceNumber value is replaced by the new EventLog Entry object.

Log entries are persisted across reboots of the CPE.

- 1.4
Reset() command - Clears the events from the event log and the value of Entry.{i}.SequenceNumber parameter is reset to the parameter's minimum value. - 1.4
EntryNumberOfEntries unsignedInt - The number of entries in the Entry table. - 1.4
STBService.{i}.ServiceMonitoring.MainStream.{i}.EventLog.Entry.{i}. object -

This object represents an entry (e.g., start session, channel change) in the event log.

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

- 1.4
SequenceNumber unsignedInt­[1:] -

The sequence number of the event within the EventLog.

This parameter is incremented by one (1) for each entry within the EventLog.

When the value of the parameter exceeds the maximium range, the lowest value of this parameter that is not contained in current EventLog entries is used.

- 1.4
Type string - Type of the event. The values for this parameter are vendor specific. - 1.4
Time dateTime - Timestamp of the event. - 1.4
ParameterNumberOfEntries unsignedInt - The number of entries in the Parameter table. - 1.4
STBService.{i}.ServiceMonitoring.MainStream.{i}.EventLog.Entry.{i}.Parameter.{i}. object - This object represents an instance of a parameter that is associated with the Entry object Instance. - 1.4
Name string - Name of the parameter (vendor-specific). - 1.4
Value string - Value of the parameter. - 1.4


Generated by Broadband Forum report.pl#424 (2019-07-26 version) on 2019/09/04 at 16:22:51.
report.pl --exitcode=fatals --altnotifreqstyle --ignoreenableparameter --immutablenonfunctionalkeys --markmounttype --cwmpindex=.. --nofontstyles --nowarnreport --quiet --lastonly --report=html --outfile=tr-135-1-4-1-usp-diffs.html tr-135-1-4-1-usp.xml