 |
STBService:1.4 Service Object definition [USP] (changes)tr-135-1-4-1-usp.xml |
||
DATA MODEL DEFINITION | |||
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:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- 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.
- 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.
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 types.
| Data Type | Base Type | Description |
|---|---|---|
| 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 [SOAP1.1]. |
| 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. |
| UUID | string(36) | Universally Unique Identifier. See [RFC4122]. Possible patterns:
|
References
| [D-Book] | DGTVi D-Book v1.0, Compatible receivers for the Italian market, Sep 2004. |
| [IANA-uri-schemes] | IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, IANA. |
| [IEEE_EUI64] | Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, IEEE, March 1997. |
| [RFC3986] | RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF. |
| [RFC4007] | RFC 4007, IPv6 Scoped Address Architecture, IETF. |
| [RFC4122] | RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005. |
| [RFC4291] | RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006. |
| [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. |
| [RFC4632] | RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006. |
| [RFC7159] | RFC7159, The JavaScript Object Notation (JSON) Data Interchange Format, IETF, March 2014. |
| [RFC7230] | RFC 7230, Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing, IETF, June 2014. |
| [RFC7252] | RFC 7252, The Constrained Application Protocol (CoAP), IETF, June 2014. |
| [RFC8141] | RFC 8141, Uniform Resource Names (URNs), IETF, April 2017. |
| [SOAP1.1] | Simple Object Access Protocol (SOAP) 1.1, W3C. |
| [TR-069] | TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018. |
| [TR-135] | TR-135 Amendment 3, Data Model for a TR-069 Enabled STB, Broadband Forum, November 2012. |
| [ZigBee2007] | ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007. |
Legend
| Object definition. |
| Mount point definition. |
| Parameter definition. |
| Command or Event definition. |
| Command Input / Output Arguments container. |
| Command or Event Object Input / Output Argument definition. |
| Command or Event Parameter Input / Output Argument definition. |
STBService:1.4 Data Model
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.
Changes in 1.4:
- Changed attribute name = STBService:1.3 ⇒ STBService:1.4
| Name | Type | Write | Description | Object Default | Version |
|---|---|---|---|---|---|
| STBService.{i}. | object(0:) | R | 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 |
| STBService.{i}.Capabilities. | object | R | 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 | R | Video decoder capabilities. | - | 1.0 |
| STBService.{i}.Capabilities.VideoDecoder.MPEG4Part10. | object | R | 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(0:) | R | Table to describe the set of profiles and levels combinations supported by the STB when MPEG4 Part 10 is used as video standard. |enum| At most one entry in this table can exist with the same values for both 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 |
| STBService.{i}.Capabilities.ServiceMonitoring. | object | R | This object describes the capabilities of the ServiceMonitoring object.
Changes in 1.4:
|
- | 1.0 |
| MaxMainStreamEventLogEntries | unsignedInt | R | Maximum number of event log entries that the STB is able to record for a MainStream object instance. | - | 1.4 |
| STBService.{i}.Components. | object | R | 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(0:) | R | 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 |
| STBService.{i}.Components.FrontEnd.{i}.DVBT. | object | R | 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].
Changes in 1.4:
|
- | 1.0 |
| InstallProgress | unsignedInt(0:100) | R | Progression in % of the current scan. The value is undefined when a scan is not in progress. | - | 1.0 |
| Install() | command | - | [ASYNC] DVB-T service list database installation. Supports maintenance of the service list database by scanning frequencies in order to detect services. The service list database is in Components.FrontEnd.{i}.DVBT.ServiceListDatabase. | - | 1.0 |
| ⇒ Input. | arguments | - | Input arguments. | - | |
| ⇒ StartFrequency | unsignedInt | W | Frequency (in kHz) at which to start the scanning process. | - | 1.0 |
| ⇒ StopFrequency | unsignedInt | W | Frequency (in kHz) at which to stop the scanning process. | - | 1.0 |
| LogicalChannelConnect() | command | - | Connect to a DVB-T logical channel. | - | 1.0 |
| ⇒ Input. | arguments | - | Input arguments. | - | |
| ⇒ LogicalChannelNumber | unsignedInt | W | Logical channel number to connect to (the logical channel’s preferred service will be connected to). If a ServiceMonitoring.MainStream instance with ServiceType = DTT is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance. | - | 1.0 |
| ServiceConnect() | command | - | Connect to a DVB-T service. | - | 1.0 |
| ⇒ Input. | arguments | - | Input arguments. | - | |
| ⇒ DvbId | string(:12) | W | DvbId of the service to connect to. If a ServiceMonitoring.MainStream instance with ServiceType = DTT is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance. | - | 1.0 |
| STBService.{i}.Components.FrontEnd.{i}.DVBT.Modulation. | object | R | DVB-T modulation details. | - | 1.0 |
| Frequency | unsignedInt | W | Indicates the current frequency in kHz.The value of this parameter is undefined while installing the service list (see |object|.Components.FrontEnd.{i}.DVBT.Install|Components.FrontEnd.{i}.DVBT.Install()). | - | 1.0 |
| HierarchicalInformation | string | W | Hierarchical parameter alpha. The higher the value of alpha, the more noise-immune the High Priority Modulation is. Enumeration of:
Changes in 1.4:
)
|
- | 1.0 |
| STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceListDatabase. | object | R | DVB-T service list database.
Changes in 1.4:
|
- | 1.0 |
| Reset() | command | - | Resets the service list database. | - | 1.0 |
| STBService.{i}.Components.FrontEnd.{i}.IP. | object | R | IP front-end details. This object will normally be present if and only if the front-end is an IP front-end.
Changes in 1.4:
|
- | 1.0 |
| ServiceConnect() | command | - | Force connection to a dedicated IP stream for test purposes. | - | 1.0 |
| ⇒ Input. | arguments | - | Input arguments. | - | |
| ⇒ URI | string(:256) | W | RFC 3986 URI that describes the service to connect to in the form:
|
- | 1.0 |
| STBService.{i}.Components.FrontEnd.{i}.IP.RTPAVPF. | object | R | Parameters related to RTP AVPF configuration as defined in [RFC4585] and [RFC4588]. | - | 1.0 |
| Enable | boolean | W | Enables or disables RTP/AVPF receiver report generation. When set to true, enables the error correction operation, immediately (Forced mode) or automatically when necessary (Auto mode). When set to false, disables the error correction operation. | - | 1.0 |
| STBService.{i}.Components.FrontEnd.{i}.IP.ForceMonitor. | object | R | Parameters used to describe the force monitoring operation. When running in the force monitoring mode, the STB MUST automatically connect to a test URI defined by the URI parameter whenever it detects that the IP tuner is not not receiving any data from the WAN. When running in normal mode, the STB does not perform any action when it does not receive any data from the IP tuner coming from the WAN. The force monitor mode allows to maintain an active stream coming from the network so as to keep collecting statistics. | - | 1.1 |
| URI | string(:256) | W | describesDescribes the service to connect to for force monitoring purposes with the same syntaxtsyntax as ServiceConnect().URI.If a ServiceMonitoring.MainStream instance with ServiceType = TEST or IP-All is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance. The value when read is not specified and need not be the value that was most recently written. | - | 1.1 |
| STBService.{i}.Components.AudioOutput.{i}. | object(0:) | R | 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. Changes in 1.4:
|
- | 1.0 |
| CancelMute() | command | - | Cancels this audio output’s mute status. | - | 1.0 |
| STBService.{i}.AVPlayers. | object | R | 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.
Changes in 1.4:
|
- | 1.0 |
| ResetPINCode() | command | - | Resets the STB’s master PIN code to 0000. It is not recommended that this be set to true without the user’s permission. No data on the device such as PVR recordings are to be cleared as a result of resetting the PIN code. | - | 1.1 |
| STBService.{i}.ServiceMonitoring. | object | R | Contains statistics relating to theRecords events and collects QoS / QoE ofrelated 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:
Changes in 1.4:
|
- | 1.0 |
| ForceSample() | command | - | Forces statistics for the current sample to be calculated and updated in the data model. If this is the first time that ForceSample() has been invoked during the current sample interval, this MUST cause a new value to be added to each of the Sample statistics comma-separated list parameters, and the ReportEndTime and all SampleSeconds parameters MUST be updated accordingly. If this is not the first time that ForceSample() has been invoked during the current sample interval, then the new values that were added as described in the previous paragraph, and the ReportEndTime and all SampleSeconds parameters, MUST be updated accordingly. Note that ForceSample() just provides a sneak preview of the current sample. It does not create a new sample and it does not interfere with the sample interval schedule. At the end of each sample interval, if ForceSample() was invoked during the sample interval then the new values that were added as described above, and the ReportEndTime and all SampleSeconds parameters, will be updated accordingly. In other words, the partial sample data that was created when ForceSample() was invoked will be updated one last time at the end of the sample interval. | - | 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(0:) | R | 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 |
| Enable | boolean | W | Enables or disables collection of Total and Sample statistics and events for this object instance. The collection of events requires the value of this parameter to be true and the value of the ServiceMonitoring.EventCollectionEnable to be true. | - | 1.0 |
| Status | string | R | Total and Sample statistics and event collection status for this object instance. Enumeration of:
|
- | 1.0 |
| SessionId | string(36) | R | [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}.Total. | object | R | Total statistics since this ServiceMonitoring main stream instance was last enabled or Total statistics were last reset.
Changes in 1.4:
|
- | 1.0 |
| Reset() | command | - | Resets Total statistics for this ServiceMonitoring main stream instance. | - | 1.0 |
| STBService.{i}.ServiceMonitoring.MainStream.{i}.EventLog. | object | R | 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 | R | The number of entries in the Entry table. | - | 1.4 |
| STBService.{i}.ServiceMonitoring.MainStream.{i}.EventLog.Entry.{i}. | object(0:) | R | 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:) | R | 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 | R | Type of the event. The values for this parameter are vendor specific. | - | 1.4 |
| Time | dateTime | R | Timestamp of the event. | - | 1.4 |
| ParameterNumberOfEntries | unsignedInt | R | The number of entries in the Parameter table. | - | 1.4 |
| STBService.{i}.ServiceMonitoring.MainStream.{i}.EventLog.Entry.{i}.Parameter.{i}. | object(0:) | R | This object represents an instance of a parameter that is associated with the Entry object Instance. | - | 1.4 |
| Name | string | R | Name of the parameter (vendor-specific). | - | 1.4 |
| Value | string | R | Value of the parameter. | - | 1.4 |
| STBService.{i}.Applications. | object | R | Applications. | - | 1.0 |
| STBService.{i}.Applications.AudienceStats. | object | R | Audience viewing statistics.
Changes in 1.4:
|
- | 1.0 |
| Reset() | command | - | Resets the viewing statistics table. Resetting statistics MUST reset all Channel.{i}.Duration parameters. | - | 1.0 |
| STBService.{i}.Applications.CDSPush. | object | R | Details of STB CDS Push logical internal parameters. | - | 1.1 |
| STBService.{i}.Applications.CDSPush.ContentItem.{i}. | object(0:) | R | 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. Changes in 1.4:
|
- | 1.1 |
| DeleteItem() | command | - | Deletes this Content Item instance. | - | 1.1 |
| STBService.{i}.Applications.CDSPull. | object | R | 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(0:) | R | 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. Changes in 1.4:
|
- | 1.1 |
| DeleteItem() | command | - | Deletes this Content Item instance. | - | 1.1 |
Notification Requirements
Parameters for which Value Change Notification MAY be Denied
Generated by Broadband Forum bbfreport v2.1.0 (2024-01-18 version) on 2024-01-18 at 10:21:42 UTC.
report.py –include ../../install/cwmp –output <stdout> –transform diff –format markdown tr-135-1-3-0.xml tr-135-1-4-1-usp.xml