From 805bfc19d77d3ebf7ce812834d2236505ce21e71 Mon Sep 17 00:00:00 2001 From: Vivek Kumar Dutta Date: Thu, 24 Apr 2025 09:37:25 +0530 Subject: [PATCH] Updated tr181 xml to 2.19.1 --- gitlab-ci/generate_supported_dm.sh | 13 +- gitlab-ci/shared.sh | 20 +- ...ull.xml => 00-tr-181-2-19-1-cwmp-full.xml} | 6633 ++++++------ ...full.xml => 01-tr-181-2-19-1-usp-full.xml} | 9 +- test/tools/04-tr-135-1-4-1-cwmp-full.xml | 8125 --------------- test/tools/05-tr-135-1-4-1-usp-full.xml | 8064 --------------- tools/Dockerfile | 41 +- tools/bbf_common.py | 11 +- tools/datamodel.json | 8852 +---------------- tools/docker/fixuid.yml | 4 + tools/docker/gitconfig | 4 + tools/generate_dm.sh | 6 +- tools/tools_input.json | 24 +- 13 files changed, 3604 insertions(+), 28202 deletions(-) rename test/tools/{00-tr-181-2-19-0-cwmp-full.xml => 00-tr-181-2-19-1-cwmp-full.xml} (99%) rename test/tools/{01-tr-181-2-19-0-usp-full.xml => 01-tr-181-2-19-1-usp-full.xml} (99%) delete mode 100644 test/tools/04-tr-135-1-4-1-cwmp-full.xml delete mode 100644 test/tools/05-tr-135-1-4-1-usp-full.xml create mode 100644 tools/docker/fixuid.yml create mode 100644 tools/docker/gitconfig diff --git a/gitlab-ci/generate_supported_dm.sh b/gitlab-ci/generate_supported_dm.sh index 4d796a0c..11b4eb43 100755 --- a/gitlab-ci/generate_supported_dm.sh +++ b/gitlab-ci/generate_supported_dm.sh @@ -5,8 +5,8 @@ echo "Generate xml and xls artifacts" source ./gitlab-ci/shared.sh # install required packages -exec_cmd apt update -exec_cmd apt install -y python3-pip libxml2-utils +exec_cmd sudo apt update +exec_cmd sudo apt install -y python3-pip libxml2-utils exec_cmd pip3 install xlwt if [ -n "${CI_SERVER_HOST}" ]; then @@ -20,10 +20,11 @@ install_libeasy install_libethernet install_libqos -[ ! -d "${BBFDM_MS_DIR}" ] && mkdir -p "${BBFDM_MS_DIR}" -rm -rf ${BBFDM_MS_DIR}/* - -mkdir -p ${BBFDM_MS_DIR}/core +[ ! -d "${BBFDM_MS_DIR}" ] && { + mkdir -p "${BBFDM_MS_DIR}" + rm -rf ${BBFDM_MS_DIR}/* + mkdir -p ${BBFDM_MS_DIR}/core +} if [ -z "${1}" ]; then ./tools/generate_dm.py tools/tools_input.json diff --git a/gitlab-ci/shared.sh b/gitlab-ci/shared.sh index 60c2041d..46f7d55f 100755 --- a/gitlab-ci/shared.sh +++ b/gitlab-ci/shared.sh @@ -113,9 +113,9 @@ function install_libeasy() cd /opt/dev/libeasy exec_cmd make - mkdir -p /usr/include/easy - cp -a libeasy*.so* /usr/lib - cp -a *.h /usr/include/easy/ + sudo mkdir -p /usr/include/easy + sudo cp -a libeasy*.so* /usr/lib + sudo cp -a *.h /usr/include/easy/ ) } @@ -128,9 +128,9 @@ function install_libqos() cd /opt/dev/libqos exec_cmd make - mkdir -p /usr/include/ - cp -a libqos*.so* /usr/lib/ - cp -a include/*.h /usr/include/ + sudo mkdir -p /usr/include/ + sudo cp -a libqos*.so* /usr/lib/ + sudo cp -a include/*.h /usr/include/ ) } @@ -142,8 +142,8 @@ function install_libethernet() ( cd /opt/dev/libethernet make PLATFORM=TEST - cp ethernet.h /usr/include - cp -a libethernet*.so* /usr/lib + sudo cp ethernet.h /usr/include + sudo cp -a libethernet*.so* /usr/lib sudo ldconfig ) } @@ -158,7 +158,7 @@ function install_ethmngr_as_micro_service() exec_cmd git clone https://dev.iopsys.eu/hal/ethmngr.git /opt/dev/ethmngr exec_cmd make -C /opt/dev/ethmngr - exec_cmd cp -f /opt/dev/ethmngr/ethmngr /usr/sbin/ethmngr + exec_cmd sudo cp -f /opt/dev/ethmngr/ethmngr /usr/sbin/ethmngr } function install_netmngr_as_micro_service() @@ -219,7 +219,7 @@ function error_on_zero() { ret=$1 if [ "$ret" -eq 0 ]; then - echo "Validation of last command failed, ret(${ret})" + echo "Validation of Last command failed, ret(${ret})" cp /tmp/memory-*.xml . exit $ret fi diff --git a/test/tools/00-tr-181-2-19-0-cwmp-full.xml b/test/tools/00-tr-181-2-19-1-cwmp-full.xml similarity index 99% rename from test/tools/00-tr-181-2-19-0-cwmp-full.xml rename to test/tools/00-tr-181-2-19-1-cwmp-full.xml index 9ba0c4f8..ce3200f8 100644 --- a/test/tools/00-tr-181-2-19-0-cwmp-full.xml +++ b/test/tools/00-tr-181-2-19-1-cwmp-full.xml @@ -59,8 +59,8 @@ https://www.broadband-forum.org/cwmp/cwmp-datamodel-1-14.xsd urn:broadband-forum-org:cwmp:datamodel-report-1-0 https://www.broadband-forum.org/cwmp/cwmp-datamodel-report-1-0.xsd" - spec="urn:broadband-forum-org:tr-181-2-19-0-cwmp" - file="tr-181-2-19-0-cwmp.xml"> + spec="urn:broadband-forum-org:tr-181-2-19-1-cwmp" + file="tr-181-2-19-1-cwmp.xml"> @@ -4059,2163 +4059,6 @@ - - - This object contains parameters relating to the CPE's association with - an ACS. - - - - - Enables and disables the CPE's support for CWMP. - - {{false}} means that CWMP support in the CPE is disabled, in which - case the device MUST NOT send any Inform messages to the ACS or - accept any Connection Request notifications from the ACS. - - {{true}} means that CWMP support on the CPE is enabled. - - The subscriber can re-enable the CPE's CWMP support either by - performing a factory reset or by using a LAN-side protocol to change - the value of this parameter back to {{true}}. - - - - - - - - - - The {{datatype}} for the CPE to connect to the ACS using the CPE WAN - Management Protocol. - - This parameter MUST be in the form of a valid HTTP or HTTPS URL. - - The ''host'' portion of this URL is used by the CPE for validating - the ACS certificate when using SSL or TLS. - - Note that on a factory reset of the CPE, the value of this parameter - might be reset to its factory value. If an ACS modifies the value of - this parameter, it SHOULD be prepared to accommodate the situation - that the original value is restored as the result of a factory reset. - - - - - - - - - Username used to authenticate the CPE when making a connection to the - ACS using the CPE WAN Management Protocol. - - This username is used only for HTTP-based authentication of the CPE. - - Note that on a factory reset of the CPE, the value of this parameter - might be reset to its factory value. If an ACS modifies the value of - this parameter, it SHOULD be prepared to accommodate the situation - that the original value is restored as the result of a factory reset. - - - - - - - - - - - Password used to authenticate the CPE when making a connection to the - ACS using the CPE WAN Management Protocol. - - This password is used only for HTTP-based authentication of the CPE. - - Note that on a factory reset of the CPE, the value of this parameter - might be reset to its factory value. If an ACS modifies the value of - this parameter, it SHOULD be prepared to accommodate the situation - that the original value is restored as the result of a factory reset. - - - - - - - An absolute date and time in UTC at which time the CPE will perform a - reboot. - - If a CWMP session is in progress at the specified time, the CPE MUST - wait until the session has ended before performing the reboot. - - If the value specifies a date and time that has already passed (i.e., - a past date and time), no reboot will be performed. - - - - - - - - - The number of {{units}} from the time the CWMP session in which this - parameter value is set is ended until the CPE performs a reboot. - - Whenever the CPE reboots, this value MUST be reset by the CPE to -1. - - - - - - - - - - - - Whether or not the CPE MUST periodically send CPE information to the - ACS using the Inform method call. - - - - - - - - - The duration in {{units}} of the interval for which the CPE MUST - attempt to connect with the ACS and call the Inform method if - {{param|PeriodicInformEnable}} is {{true}}. - - - - - - - - - - - - An absolute time reference in UTC to determine when the CPE will - initiate the periodic Inform method calls. Each Inform call MUST - occur at this reference time plus or minus an integer multiple of the - {{param|PeriodicInformInterval}}. - - {{param}} is used only to set the ''phase'' of the periodic Informs. - The actual value of {{param}} can be arbitrarily far into the past or - future. - - For example, if {{param|PeriodicInformInterval}} is 86400 (a day) and - if {{param}} is set to UTC midnight on some day (in the past, - present, or future) then periodic Informs will occur every day at UTC - midnight. These MUST begin on the very next midnight, even if - {{param}} refers to a day in the future. - - The Unknown Time value defined in {{bibref|TR-106|section 3.2}} - indicates that no particular time reference is specified. That is, - the CPE MAY locally choose the time reference, and needs only to - adhere to the specified {{param|PeriodicInformInterval}}. - - If absolute time is not available to the CPE, its periodic Inform - behavior MUST be the same as if the {{param}} parameter was set to - the Unknown Time value. - - - - - - - - - {{param}} provides the ACS a reliable and extensible means to track - changes made by the ACS. The value of {{param}} MUST be equal to the - value of the ParameterKey argument from the most recent successful - SetParameterValues, AddObject, or DeleteObject method call from the - ACS. - - The CPE MUST set {{param}} to the value specified in the - corresponding method arguments if and only if the method completes - successfully and no fault response is generated. If a method call - does not complete successfully (implying that the changes requested - in the method did not take effect), the value of {{param}} MUST NOT - be modified. - - The CPE MUST only modify the value of {{param}} as a result of - SetParameterValues, AddObject, DeleteObject, or due to a factory - reset. On factory reset, the value of {{param}} MUST be set to - {{empty}}. - - - - - - - - - - - The HTTP {{datatype}} for an ACS to make a Connection Request - notification to the CPE. - - In the form: - - : http://host:port/path - - The ''host'' portion of the URL MAY be the IP address for the - management interface of the CPE in lieu of a host name. - - Note: If the ''host'' portion of the URL is a literal IPv6 address - then it MUST be enclosed in square brackets (see - {{bibref|RFC3986|Section 3.2.2}}). - - - - - - - - - Username used to authenticate an ACS making a Connection Request to - the CPE. - - - - - - - - - - - Password used to authenticate an ACS making a Connection Request to - the CPE. - - - - - - - Indicates whether or not the ACS will manage upgrades for the CPE. If - {{true}}, the CPE SHOULD NOT use other means other than the ACS to - seek out available upgrades. If {{false}}, the CPE MAY use other - means for this purpose. - - Note that an autonomous upgrade (reported via an "10 AUTONOMOUS - TRANSFER COMPLETE" Inform Event code) SHOULD be regarded as a managed - upgrade if it is performed according to ACS-specified policy. - - - - - - - - - Present only for a CPE that supports the Kicked RPC method. - - LAN-accessible {{datatype}} from which the CPE can be ''kicked'' to - initiate the Kicked RPC method call. MUST be an absolute URL - including a host name or IP address as would be used on the LAN side - of the CPE. - - - - - - - - - Present only for a CPE that provides a LAN-side web page to show - progress during a file download. - - LAN-accessible {{datatype}} to which a web-server associated with the - ACS MAY redirect a user's browser on initiation of a file download to - observer the status of the download. - - - - - - - - - This parameter is used to control throttling of active notifications - sent by the CPE to the ACS. It defines the minimum number of - {{units}} that the CPE MUST wait since the end of the last session - with the ACS before establishing a new session for the purpose of - delivering an active notification. - - In other words, if CPE needs to establish a new session with the ACS - for the sole purpose of delivering an active notification, it MUST - delay establishing such a session as needed to ensure that the - minimum time since the last session completion has been met. - - The time is counted since the last successfully completed session, - regardless of whether or not it was used for active notifications or - other purposes. However, if connection to the ACS is established for - purposes other than just delivering active notifications, including - for the purpose of retrying a failed session, such connection MUST - NOT be delayed based on this parameter value, and the pending active - notifications MUST be communicated during that connection. - - The time of the last session completion does not need to be tracked - across reboots. - - - - - - - - - - - Configures the first session retry wait interval, in {{units}}, as - specified in {{bibref|TR-069|section 3.2.1.1}}. - - A value of 5 corresponds to the default behavior that is described in - {{bibref|TR-069}}. - - The device MUST use a random value between {{param}} and ({{param}} * - {{param|CWMPRetryIntervalMultiplier}} / 1000) as the first retry wait - interval. Other values in the retry pattern MUST be calculated using - this value as a starting point. - - - - - - - - - - - - Configures the retry interval multiplier as specified in - {{bibref|TR-069|section 3.2.1.1}}. - - This value is expressed in units of 0.001. Hence the values of the - multiplier range between 1.000 and 65.535. - - A value of 2000 corresponds to the default behavior that is described - in {{bibref|TR-069}}. - - The device MUST use a random value between - {{param|CWMPRetryMinimumWaitInterval}} and - ({{param|CWMPRetryMinimumWaitInterval}} * {{param}} / 1000) as the - first retry wait interval. Other values in the retry pattern MUST be - calculated using this value as a starting point. - - - - - - - - - - - Enables or disables HTTP connection request handling on the CPE. - - If HTTP connection request handling is disabled ({{param}} is set to - {{false}}), {{param|ConnectionRequestURL}} MUST be set to {{empty}} - and the CPE MUST close the port used by the HTTP connection request - server. - - - - - - - - - - Address and port to which an ACS MAY send a UDP Connection Request to - the CPE (see {{bibref|TR-069|Annex G}}). - - This parameter is represented in the form of an Authority element as - defined in {{bibref|RFC3986}}. The value MUST be in one of the - following two forms: - - : host:port - - : host - - * When {{param|STUNEnable}} is {{true}}, the ''host'' and ''port'' - portions of this parameter MUST represent the public address and - port corresponding to the NAT binding through which the ACS can - send UDP Connection Request messages (once this information is - learned by the CPE through the use of STUN). - - * When {{param|STUNEnable}} is {{false}}, the ''host'' and ''port'' - portions of the URL MUST represent the local IP address and port on - which the CPE is listening for UDP Connection Request messages. - - The second form of this parameter MAY be used only if the port value - is equal to ''80''. - - Note: If the ''host'' portion of the URL is a literal IPv6 address - then it MUST be enclosed in square brackets (see - {{bibref|RFC3986|Section 3.2.2}}). - - - - - - - - - - - Enables or disables the use of STUN by the CPE. This applies only to - the use of STUN in association with the ACS to allow UDP Connection - Requests. - - - - - - - - - Host name or IP address of the STUN server for the CPE to send - Binding Requests if STUN is enabled via {{param|STUNEnable}}. - - If is {{empty}} and {{param|STUNEnable}} is {{true}}, the CPE MUST - use the address of the ACS extracted from the host portion of the ACS - URL. - - - - - - - - - - - Port number of the STUN server for the CPE to send Binding Requests - if STUN is enabled via {{param|STUNEnable}}. - - By default, this SHOULD be the equal to the default STUN port, 3478. - - - - - - - - - - - If is not {{empty}}, the value of the STUN USERNAME attribute to be - used in Binding Requests (only if message integrity has been - requested by the STUN server). - - If is {{empty}}, the CPE MUST NOT send STUN Binding Requests with - message integrity. - - - - - - - - - - - The value of the STUN Password to be used in computing the - MESSAGE-INTEGRITY attribute to be used in Binding Requests (only if - message integrity has been requested by the STUN server). - - - - - - - If STUN Is enabled, the maximum period, in {{units}}, that STUN - Binding Requests MUST be sent by the CPE for the purpose of - maintaining the binding in the Gateway. This applies specifically to - Binding Requests sent from the UDP Connection Request address and - port. - - A value of -1 indicates that no maximum period is specified. - - - - - - - - - - - - If STUN Is enabled, the minimum period, in {{units}}, that STUN - Binding Requests can be sent by the CPE for the purpose of - maintaining the binding in the Gateway. This limit applies only to - Binding Requests sent from the UDP Connection Request address and - port, and only those that do not contain the BINDING-CHANGE - attribute. This limit does not apply to retransmissions following the - procedures defined in {{bibref|RFC3489}}. - - - - - - - - - - - When STUN is enabled, this parameter indicates whether or not the CPE - has detected address and/or port mapping in use. - - A {{true}} value indicates that the received MAPPED-ADDRESS in the - most recent Binding Response differs from the CPE's source address - and port. - - When {{param|STUNEnable}} is {{false}}, this value MUST be {{false}}. - - - - - - - - - Indicates whether or not the Alias-Based Addressing Mechanism is - supported. - - A {{true}} value indicates that the CPE supports the Alias-Based - Addressing Mechanism, as defined in {{bibref|TR-069|3.6.1}} and - described in {{bibref|TR-069|Appendix II}}. - - - - - - - - - Instance identification mode as defined in {{bibref|TR-069|3.6.1}}. - When {{param|AliasBasedAddressing}} is {{true}}, {{param}} is used by - the ACS to control whether the CPE will use Instance Numbers or - Instance Aliases in returned Path Names. {{enum}} - - This parameter is REQUIRED for any CPE supporting Alias-Based - Addressing. - - - - - - - - - - - - - Enable or disable the Auto-Create Instance Mechanism. When - {{param|AliasBasedAddressing}} is {{true}}, {{param}} indicates - whether or not the CPE will automatically create instances while - processing a SetParameterValues RPC (as defined in - {{bibref|TR-069|A.3.2.1}}). - - *A {{true}} value indicates that the CPE will perform auto-creation - of instances when the Alias-Based Addressing Mechanism is used in - SetParameterValues RPC. - - *A {{false}} value indicates that the CPE will not create new object - instances. Instead, it will reject the setting of parameters in - unrecognized instances and respond with a fault code. - - This parameter is REQUIRED for any CPE supporting Alias-Based - Addressing. - - - - - - - - - - {{numentries}} - - - - - - - - - The minimum time, in seconds, between Active Notifications resulting - from changes to the {{param|ManageableDeviceNumberOfEntries}} (if - Active Notification is enabled). - - - - - - - - - {{numentries}} - - - - - - - - - {{numentries}} - - - - - - - - - The connection request methods supported by this {{object}}. {{enum}} - - - - - - - The connection request method as specified in - {{bibref|TR-069|Section 3.2.2 ACS Connection Initiation}}, - '''REQUIRED''' - - - - - The connection request method as specified in - {{bibref|TR-069|Annex G Connection Request via NAT Gateway}} - - - - - The connection request method as specified in - {{bibref|TR-069|Annex K XMPP Connection Request}} - - - - - - - - - {{reference|the {{object|#.XMPP.Connection}} instance that is used - for connection requests to this {{object}}}} - - - - - - - - - - - When an XMPP Connection Request is sent to a CPE the XMPP IQ Stanza - will contain a "from" address that contains the Jabber ID of the - initiating entity. - - This parameter is a {{list}} Each entry represents a Jabber ID, or - address, that is allowed to initiate an XMPP Connection Request. - - Each Jabber ID is allowed to be either a "Full JID" (containing a - local-part, domain-part, and resource-part in the following format: - "local-part@domain-part/resource-part") or a "Bare JID" (containing a - local-part and a domain-part in the following format: - "local-part@domain-part"). "Full JID" entries require an exact match - whereas "Bare JID" entries are a wildcard match and will match any - Jabber ID with the same local-part and domain-part independent of the - resource-part. - - For example, if {{param}} contained "ACS1@tr069.example.com, - ACS2@tr-069.example.com/resource1" then the following incoming "from" - addresses would be '''allowed''': - - * "ACS1@tr069.example.com/resource1" - - * "ACS1@tr069.example.com/resource2" - - * "ACS2@tr069.example.com/resource1" - - And the following incoming "from" addresses '''would not be - allowed''': - - * "ACS2@tr069.example.com/resource2" - - * "ACS@tr069.example.com/resource" - - If this Parameter is {{empty}} then all Jabber IDs are allowed and an - XMPP Connection Request can not be deemed invalid due to the "from" - address. - - - - - - - - - - - - - - The value MUST be the value of the - {{param|#.XMPP.Connection.{i}.JabberID}} contained in the - {{object|#.XMPP.Connection}} instance referenced by the - {{param|ConnReqXMPPConnection}} parameter. - - If the {{param|ConnReqXMPPConnection}} parameter is empty or the - {{object|#.XMPP.Connection}} instance being reference is disabled, - then this value will be empty. - - If the {{object|#.XMPP.Connection}} instance being referenced by the - {{param|ConnReqXMPPConnection}} parameter is lost - ({{param|#.XMPP.Connection.{i}.Status}} parameter changes from - Enabled to some other value), then the value of this parameter MUST - remain unchanged until the connection can be reestablished and a new - {{param|#.XMPP.Connection.{i}.JabberID}} can be established. If the - new {{param|#.XMPP.Connection.{i}.JabberID}} is identical to the - existing value, then the value of this parameter MUST NOT be altered - and a VALUE CHANGE event MUST NOT be generated. - - - - - - - - - Indicates the HTTP Compression mechanism(s) supported by this CPE. - Requirements for the use of HTTP Compression for CWMP can be found in - {{bibref|TR-069|Section 3.4.7}}. {{enum}} - - Vendors can extend the enumerated values with vendor specific - extensions, in which case the rules outlined in - {{bibref|TR-106|Section 3.3}} MUST be adhered to. - - - - - - - As defined in {{bibref|RFC2616|Section 3.5}} - - - - - As defined in {{bibref|RFC2616|Section 3.5}} - - - - - As defined in {{bibref|RFC2616|Section 3.5}} - - - - - - - - - The value of this parameter represents the HTTP Compression mechanism - to be used by the CPE when communicating with the ACS. - - - - - - - - - - - - Indicates the Lightweight Notification Protocol(s) supported by this - CPE. {{enum}} - - Vendors can extend the enumerated values with vendor specific - extensions, in which case the rules outlined in - {{bibref|TR-106|Section 3.3}} MUST be adhered to. - - - - - - - As defined in {{bibref|TR-069|Annex M}} - - - - - - - - - The value of this parameter represents the protocol(s) that will be - used by the CPE when sending Lightweight Notifications. - - {{empty}} means that Lightweight Notifications are disabled, despite - any SetParameterAttributes that have been configured on various - parameters. - - - - - - - - - - - - The duration in {{units}} of the interval for which the CPE MUST - attempt to deliver any pending Passive Lightweight Notifications. - - A value of 0 means that the trigger interval is effectively disabled. - In this case pending Passive Lightweight Notifications are only sent - when triggered by an Active Lightweight Notification. - - - - - - - - - - - - An absolute time reference in UTC to determine when the CPE will - initiate the Lightweight Notification (in the case that there are - pending Passive Lightweight Notifications that need to be delivered). - Each Passive Lightweight Notification (that is waiting for the - Lightweight Notification Trigger mechanism for delivery) MUST occur - at this reference time plus or minus an integer multiple of the - {{param|LightweightNotificationTriggerInterval}}. {{param}} is used - only to set the ''phase'' of the Passive Lightweight Notification. - The actual value of {{param}} can be arbitrarily far into the past or - future. - - For example, if {{param|LightweightNotificationTriggerInterval}} is - 86400 (a day) and if {{param}} is set to UTC midnight on some day (in - the past, present, or future) then Lightweight Notifications for - pending Passive Lightweight Notifications will occur every day at UTC - midnight. These MUST begin on the very next midnight, even if - {{param}} refers to a day in the future. The Unknown Time value - defined in {{bibref|TR-106|section 3.2}} indicates that no particular - time reference is specified. That is, the CPE MAY locally choose the - time reference, and needs only to adhere to the specified - {{param|LightweightNotificationTriggerInterval}}. If absolute time is - not available to the CPE, its Lightweight Notifications behavior MUST - be the same as if the {{param}} parameter was set to the Unknown Time - value. - - - - - - - - - Host name or address to be used when sending the UDP Lightweight - Notifications. - - {{param}} is only applicable when - {{param|LightweightNotificationProtocolsUsed}} contains the - {{enum|UDP|LightweightNotificationProtocolsUsed}} enumeration. - - If {{param}} is not implemented or is {{empty}}, and UDP Lightweight - Notifications are supported, the destination host MUST be the same as - the ACS (as contained in the host portion of the {{param|URL}}). - - - - - - - - - - - The port number to be used when sending UDP Lightweight - Notifications. - - {{param}} is only applicable when - {{param|LightweightNotificationProtocolsUsed}} contains the - {{enum|UDP|LightweightNotificationProtocolsUsed}} enumeration. - - If {{param}} is not implemented and UDP Lightweight Notifications are - supported, the destination port MUST be 7547. - - - - - - - - - Indicates whether or not instance wildcards are supported. - - A {{true}} value indicates that the CPE supports instance wildcards - for GPV, GPN and GPA RPC calls, as defined in [TR-069]. - - - - - - - - - {{numentries}} - - - - - - - - - - Each entry in this table corresponds to a distinct LAN Device that - supports Device-Gateway Association according to {{bibref|TR-069|Annex - F}} as indicated by the presence of the DHCP option specified in that - Annex. - - - - - - - - - - A non-volatile handle used to reference this instance. {{param}} - provides a mechanism for an ACS to label this instance for future - reference. An initial unique value MUST be assigned when the CPE - creates an instance of this object. - - {{deprecated|2.11|because {{object}} is a transient object}} - - {{obsoleted|2.14}} - - {{deleted|2.15}} - - - - - - - - - - - Organizationally unique identifier of the Device manufacturer as - provided to the Gateway by the Device. Represented as a six - hexadecimal-digit value using all upper-case letters and including - any leading zeros. {{pattern}} - - The value MUST be a valid OUI as defined in {{bibref|OUI}}. - - - - - - - - - - - - Serial number of the Device as provided to the Gateway by the Device. - - - - - - - - - - - Identifier of the class of product for which the Device's serial - number applies as provided to the Gateway by the Device. - - If the Device does not provide a Product Class, then this parameter - MUST be {{empty}}. - - - - - - - - - - - {{list}} {{reference}} References all the {{object|##.Hosts.Host}} - table entries, whether active or inactive, that correspond to this - physical LAN device. There can be multiple such entries if the device - has more than one network interface. - - For example: ''Device.Hosts.Host.1,Device.Hosts.Host.5'' - - - - - - - - - - - - - - - This object allows configuration of CPE policy for notification of - AUTONOMOUS TRANSFER COMPLETE events, defined in {{bibref|TR-069}}. - - The CPE policy determines the conditions under which the CPE notifies - the ACS of the completion of file transfers that were not specifically - requested by the ACS. - - - - - Enable/disable CPE notification of AUTONOMOUS TRANSFER COMPLETE - events to the ACS. - - - - - - - - - Indicates the transfer types that MUST be included when the CPE - notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. Transfer - types not indicated by this filter MUST NOT be included when the CPE - notifies the ACS. {{enum}} - - Note that this includes any backup or restore operations that were - not specifically requested by the ACS. A backup is regarded as an - Upload and a restore is regarded as a Download. - - - - - - - Upload and Download - - - - - - - - Indicates the transfer results that MUST be included when the CPE - notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. Transfer - results omitted from this list MUST NOT be included when the CPE - notifies the ACS. - - Note that this includes any backup or restore operations that were - not specifically requested by the ACS. A backup is regarded as an - Upload and a restore is regarded as a Download. - - - - - - The autonomous file transfer completed successfully; i.e., the - FaultCode was zero - - - - - The autonomous file transfer did not complete successfully; - i.e., the FaultCode was non-zero - - - - Success and Failure - - - - - - - - {{list}} Indicates the file types that MUST be included when the CPE - notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. File types - omitted from this list MUST NOT be included when the CPE notifies the - ACS. - - {{pattern}} - - Additionally, the following format is defined to allow the unique - definition of vendor-specific file types: - - * ''"X <OUI> <Vendor-specific identifier>"'' - - <OUI> is replaced by a 6 hexadecimal-digit OUI - (organizationally unique identifier) as defined in {{bibref|OUI}}, - with all upper-case letters and any leading zeros included. The OUI - used for a given vendor-specific file type MUST be one that is - assigned to the organization that defined this file type (which is - not necessarily the same as the vendor of the CPE or ACS). - - Note that {{empty}} indicates that all file types are excluded from - this filter, effectively disabling CPE notification of AUTONOMOUS - TRANSFER COMPLETE events to the ACS. - - - - - - - - Download Only - - - Download Only - - - Download or Upload - - - Upload Only - - - - For Vendor-Specific File Types, could be for either Download or - Upload - - - - - - - - - - This object contains multicast announcement and query parameters used - for the purpose of downloading files. - - - - - - This object contains multicast announcement parameters used to download - files. - - - - - Enable/disable CPE ability to receive and use multicast announcements - from a server for the purpose of downloading files. - - - - - - - - - The status of the announcement service. - - - - - - - - MAY be used by the CPE to indicate a locally defined error - condition. - - - - - - - - - {{numentries}} - - - - - - - - - - Multicast groups to which the CPE SHOULD listen for announcements. - - - - - - - - - - - {{datatype|expand}} - - - - - - - - - Enable/disable listening to this multicast group. - - - - - - - - - - The status of this group table entry. - - - - - - - - MAY be used by the CPE to indicate a locally defined error - condition, e.g. unable to parse received announcements. - - - - - - - - - - The {{datatype}} encoding the group address, source and port on which - to listen, and other protocol information, e.g. expected announcement - format. - - Depending on the application, the messages identified by this URL MAY - directly contain the data to be downloaded, or alternatively MAY - contain information informing the CPE how to obtain the data to be - downloaded via a separate mechanism, which itself could involve a - unicast or a multicast download protocol. - - Refer to {{bibref|DVB-TS.102.824}} for an example of a URL format - that identifies a SAP {{bibref|RFC2974}} stream that indicates how to - use either FLUTE {{bibref|RFC3926}} or DSM-CC - {{bibref|ISO-13818-6:1998}} to perform the download. - - - - - - - - - - This object contains multicast query parameters used to download files. - - - - - Enable/disable CPE ability to autonomously query a server for the - purpose of downloading files. - - - - - - - - - The status of the query service. - - - - - - - - MAY be used by the CPE to indicate a locally defined error - condition, e.g. unable to contact query response server. - - - - - - - - - The {{datatype}} of the query response server. - - Depending on the application, the protocol described by this URL MAY - be a SOAP interface, or MAY be any other RPC mechanism. - - Refer to {{bibref|DVB-TS.102.824}} for an example of a URL format - that identifies a SOAP interface running over HTTP or HTTPS. - - - - - - - - - - This object allows configuration of CPE policy for notification of "12 - AUTONOMOUS DU STATE CHANGE COMPLETE" events defined in - {{bibref|TR-069}}. - - The CPE policy determines the conditions under which the CPE notifies - the ACS of the completion of Deployment Unit state changes that were - not specifically requested via CWMP. - - - - - Enables/Disables CPE notification of "12 AUTONOMOUS DU STATE CHANGE - COMPLETE" events to the ACS. - - - - - - - - - Indicates the Deployment Unit operations that MUST be included when - the CPE notifies the ACS of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" - events. - - Operation types not indicated by this list MUST NOT be included when - the CPE notifies the ACS. {{empty}} is essentially the same as - setting {{param|Enable}} to {{false}}. - - - - - - - - - - - - - - Indicates the Deployment Unit state change results that MUST be - included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE - CHANGE COMPLETE" events. State change results omitted from this - filter MUST NOT be included when the CPE notifies the ACS. - - - - - - The autonomous state change completed successfully; i.e., the - FaultCode was zero - - - - - The autonomous state change did not complete successfully; - i.e., the FaultCode was non-zero - - - - - All result types independent of Success or Failure - - - - - - - - - Indicates the Deployment Unit state change fault codes that MUST be - included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE - CHANGE COMPLETE" events. State change fault codes omitted from this - filter MUST NOT be included when the CPE notifies the ACS. - - This filter has no effect on the notification of a successful - autonomous state change. This filter only applies when - {{param|ResultTypeFilter}} is set to either - {{enum|Failure|ResultTypeFilter}} or {{enum|Both|ResultTypeFilter}}. - {{empty}} means that failed autonomous state changes will not be sent - to the ACS. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Each entry in this table represents a distinct Proxied Device that - utilizes the Embedded Object Mechanism {{bibref|TR-069|Annex J.3}} for - proxying devices. - - - - - - - - - Identifier of the controller that is responsible for a sub-network of - Proxied Devices within the LAN. - - {{empty}} indicates that this Proxied Device either: - - * Isn't part of a sub-network, within the LAN, with a controller - entity. - - * Doesn't need a {{param}} to ensure its {{param|ProxiedDeviceID}} is - unique throughout the LAN. - - - - - - - - - - - Idenitfier of the Proxied Device. - - This is an opaque string that is unique to the Proxied Device within - a specific sub-network within the LAN (identified by the - {{param|ControllerID}}). If the {{param|ControllerID}} is {{empty}} - this {{param}} is unique across the LAN. - - - - - - - - - - - {{noreference}}The value MUST be the path name of a table row. If the - referenced object is deleted, this {{object}} instance MUST also be - removed. Represents the instance of a multi-instanced object that is - directly controlled by, and has come into existence because of, this - Proxied Device that utilizes the Embedded Object Mechanism - {{bibref|TR-069|Annex J.3}}. - - - - - - - - - - - Represents the CWMP-DT schema instance(s) that this Proxied Device is - utilizing. The CWMP-DT schema instance is also the one being utilized - by the object referenced within {{param|Reference}}. - - - - - - - - - - - - References the {{object|##.Hosts.Host}} table entry(s), whether - active or inactive, that corresponds to this proxied LAN device. - - - - - - - - - - - - - - The protocol being used to communicate between the CPE Proxier and - this Proxied Device. {{enum}} - - Vendors can extend the enumerated values with vendor specific - extensions, in which case the rules outlined in {{bibref|TR-106|3.3}} - MUST be adhered to. - - - - - see {{bibref|Z-Wave}} - - - see {{bibref|ZigBee}} - - - see {{bibref|UPnP-DM:1}} - - - see {{bibref|ETSIM2MFA}} - - - - - - - - {{reference|a protocol object that uses the {{param|ProxyProtocol}}}} - - - - - - - - - - - {{list|that represents the discovery protocol(s) for this proxied - device}} - - {{enum}} - - Vendors can extend the enumerated values with vendor specific - extensions, in which case the rules outlined in - {{bibref|TR-106|Section 3.3}} MUST be adhered to. - - - - - - see {{bibref|Z-Wave}} - - - see {{bibref|ZigBee}} - - - see {{bibref|UPnP-DAv1}} - - - see {{bibref|ETSIM2MFA}} - - - - - - - - {{list}} {{reference|an object discovered using one or more protocols - listed in {{param|DiscoveryProtocol}}}} - - For objects discovered by the UPnP discovery protocol, the {{param}} - would contain items that are references to instances of the - following: - - * {{object|##.UPnP.Discovery.RootDevice}} - - * {{object|##.UPnP.Discovery.Device}} - - * {{object|##.UPnP.Discovery.Service}} - - For objects discovered by the ETSI-M2M discovery protocol, the - {{param}} would contain items that are references to instances of - {{object|##.ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance}}. - - - - - - - - - - - - Whether or not the CPE Proxier has successfully communicated all - pending configuration commands down to the Proxied Device. - - - - - - - - - - - - - - Detailed {{param|CommandProcessed}} error description (vendor - specific). - - - - - - - - - - - The last time that the CPE Proxier synchronized the state of the - Proxied Device. This parameter MUST be updated when a proxy command - is executed successfully on the Proxied Device. - - The Unknown Time value, as defined in {{bibref|TR-106}}, indicates - that the Proxied Device's state has not been synchronized since the - CPE Proxier was last rebooted. - - - - - - - - - - Each entry in this table represents a distinct Proxied Device that - utilizes the Virtual CWMP Device Mechanism {{bibref|TR-069|Annex J.2}} - for proxying devices. - - - - - - - - - - Organizationally unique identifier of the associated Proxied Device. - Represented as a six hexadecimal-digit value using all upper-case - letters and including any leading zeros. {{pattern}} - - The value MUST be a valid OUI as defined in {{bibref|OUI}}. - - - - - - - - - - - - Identifier of the class of product of the associated Proxied Device - for which the serial number applies. - - - - - - - - - - - Serial number of the associated Proxied Device. - - - - - - - - - - - {{list}} {{reference}} References all the {{object|##.Hosts.Host}} - table entries, whether active or inactive, that correspond to this - proxied LAN device. There can be multiple such entries if the Proxied - Device has more than one network interface. - - - - - - - - - - - - - - The protocol being used to communicate between the CPE Proxier and - this Proxied Device. {{enum}} - - Vendors can extend the enumerated values with vendor specific - extensions, in which case the rules outlined in {{bibref|TR-106|3.3}} - MUST be adhered to. - - - - - see {{bibref|Z-Wave}} - - - see {{bibref|ZigBee}} - - - see {{bibref|UPnP-DM:1}} - - - see {{bibref|ETSIM2MFA}} - - - - - - - - {{reference|a protocol object that uses the {{param|ProxyProtocol}}}} - - - - - - - - - - - {{list|that represents the discovery protocol(s) for this proxied - device}} - - {{enum}} - - Vendors can extend the enumerated values with vendor specific - extensions, in which case the rules outlined in - {{bibref|TR-106|Section 3.3}} MUST be adhered to. - - - - - - see {{bibref|Z-Wave}} - - - see {{bibref|ZigBee}} - - - see {{bibref|UPnP-DAv1}} - - - see {{bibref|ETSIM2MFA}} - - - - - - - - {{list}} {{reference|an object discovered using one or more protocols - listed in {{param|DiscoveryProtocol}}}} - - For objects discovered by the UPnP discovery protocol, the {{param}} - would contain items that are references to instances of the - following: - - * {{object|##.UPnP.Discovery.RootDevice}} - - * {{object|##.UPnP.Discovery.Device}} - - * {{object|##.UPnP.Discovery.Service}} - - For objects discovered by the ETSI-M2M discovery protocol, the - {{param}} would contain items that are references to instances of - {{object|##.ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance}}. - - - - - - - - - - - - - Parameters related to CPE behavior when waking up from standby. If this - object is supported then the CPE MUST support the requirements of - {{bibref|TR-069|Annex L}}. - - NOTE: "CR", as used in the names and descriptions of the parameters - defined in this object, refers to the Connection Request concept - defined in TR-069. - - - - - When waking up from a non CR-Aware Standby that lasted more than this - parameter's value (in {{units}}), the CPE MUST issue a WAKEUP Event. - - If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for - having been non CR-aware. - - - - - - - - - - - - - When waking up from a non fully Timer-Aware Standby that made it miss - more than this parameter's value Periodic Contacts, the CPE MUST - issue a WAKEUP Event. - - If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for - exceeding that limit. - - - - - - - - - - - - When waking up from a non fully Timer-Aware Standby that made it miss - at least one Scheduled Contact, the CPE MUST issue a WAKEUP Event if - this parameter is {{true}}. - - - - - - - - - - Indicates that the CPE is capable of CR-Aware Standby. - - - - - - - - - Indicates that the CPE is capable of Timer-Aware Standby. - - - - - - - - - If {{param|NetworkAwarenessCapable}} and this parameter are both - {{true}}, the CPE MUST NOT go into a non CR-Aware Standby state. - - - - - - - - - - If {{param|SelfTimerCapable}} and this parameter are both {{true}}, - the CPE MUST NOT go into a standby state that prevents it from - honoring Periodic Contacts. - - - - - - - - - - If this parameter is true, the CPE MUST NOT go into a standby state - that prevents it from honoring Scheduled Contacts. This means that, - whenever the ACS has requested a Scheduled Contact: - - *if {{param|SelfTimerCapable}} is {{true}} and the CPE chooses to go - into Standby before the Scheduled Contact has been honored, it MUST - use a Timer-Aware Standby; - - *if {{param|SelfTimerCapable}} is {{false}}, the CPE MUST NOT go into - Standby before the Scheduled Contact has been honored. - - - - - - - - - - This table provides the ACS with the ability to control the Parameters - that are delivered by the Inform RPC. - - Any Parameter (identified by {{param|ParameterName}}) contained in this - table MUST be included within the ParameterList argument of the Inform - RPC whenever any Event within the {{param|EventList}} is being - delivered. - - This table does not include Forced Inform Parameters, and Forced Inform - Parameters are not allowed to be inserted into this table. Any attempt - by an ACS to configure this table to contain a Forced Inform Parameter - MUST result in the failure of the SetParameterValues RPC with error - code 9007. - - - - - - - - - - - Enables or disables this {{object}}. - - - - - - - - - - {{datatype|expand}} - - - - - - - - - A pattern that describes the Parameter(s) to be included in the - Inform’s ParameterList argument. Specifically, patterns with - wildcards (an "*" character) in place of Instance Identifiers are - allowed; any attempt to set the value otherwise MUST be rejected by - the CPE. - - If the pattern does not match any existing Parameters at the time - that the CPE is creating the Inform RPC, then this - {{object|#.InformParameter}} instance is not included in the Inform’s - ParameterList argument. - - - - - - - - - - - - Each entry in this list represents an Event for which this Parameter - MUST be included within the ParameterList argument of the Inform RPC. - - All Inform Events (see {{bibref|TR-069|Section 3.7.1.5}}), except for - "4 VALUE CHANGE", are allowed as entries in this list. "4 VALUE - CHANGE" is not allowed as that would violate requirements contained - in {{bibref|TR-069|Section A.3.3.1}}. - - {{empty}} means all events except "4 VALUE CHANGE". - - - - - - - - - - - - Parameters related to CPE behavior in order to issue a Heartbeat event - to the ACS using the Inform method call. - - If this object is supported then the CPE MUST support the requirements - of {{bibref|TR-069|Annex O}}. - - - - - When {{true}}, Heartbeat events are enabled to be sent to the ACS - based on the values of the {{param|ReportingInterval}} and - {{param|InitiationTime}} parameters. - - - - - - - - - The duration in {{units}} of the interval for which the CPE MUST - attempt to connect with the ACS and call the Inform method if - {{param|Enable}} is {{true}}. - - - - - - - - - - - - An absolute time reference in UTC to determine when the CPE will - initiate the Heartbeat event Inform method calls. Each Inform call - MUST occur at this reference time plus or minus an integer multiple - of the {{param|ReportingInterval}}. - - {{param}} is used only to set the ''phase'' of the Heartbeat event - Informs. The actual value of {{param}} can be arbitrarily far into - the past or future. - - For example, if {{param|ReportingInterval}} is 60 (one minute) and if - {{param}} is set to UTC midnight on some day (in the past, present, - or future) then Heartbeat Informs will occur every minute at the next - UTC midnight. These MUST begin on the very next midnight, even if - {{param}} refers to a day in the future. - - The Unknown Time value defined in {{bibref|TR-106|section 3.2}} - indicates that no particular time reference is specified. The CPE - MUST locally choose a random time reference. - - If absolute time is not available to the CPE, its Heartbeat Inform - behavior MUST be the same as if the {{param}} parameter was set to - the Unknown Time value. - - - - - - - @@ -8657,6 +6500,2164 @@ + + + This object contains parameters relating to the CPE's association with + an ACS. + + + + + Enables and disables the CPE's support for CWMP. + + {{false}} means that CWMP support in the CPE is disabled, in which + case the device MUST NOT send any Inform messages to the ACS or + accept any Connection Request notifications from the ACS. + + {{true}} means that CWMP support on the CPE is enabled. + + The subscriber can re-enable the CPE's CWMP support either by + performing a factory reset or by using a LAN-side protocol to change + the value of this parameter back to {{true}}. + + + + + + + + + + The {{datatype}} for the CPE to connect to the ACS using the CPE WAN + Management Protocol. + + This parameter MUST be in the form of a valid HTTP or HTTPS URL. + + The ''host'' portion of this URL is used by the CPE for validating + the ACS certificate when using SSL or TLS. + + Note that on a factory reset of the CPE, the value of this parameter + might be reset to its factory value. If an ACS modifies the value of + this parameter, it SHOULD be prepared to accommodate the situation + that the original value is restored as the result of a factory reset. + + + + + + + + + Username used to authenticate the CPE when making a connection to the + ACS using the CPE WAN Management Protocol. + + This username is used only for HTTP-based authentication of the CPE. + + Note that on a factory reset of the CPE, the value of this parameter + might be reset to its factory value. If an ACS modifies the value of + this parameter, it SHOULD be prepared to accommodate the situation + that the original value is restored as the result of a factory reset. + + + + + + + + + + + Password used to authenticate the CPE when making a connection to the + ACS using the CPE WAN Management Protocol. + + This password is used only for HTTP-based authentication of the CPE. + + Note that on a factory reset of the CPE, the value of this parameter + might be reset to its factory value. If an ACS modifies the value of + this parameter, it SHOULD be prepared to accommodate the situation + that the original value is restored as the result of a factory reset. + + + + + + + An absolute date and time in UTC at which time the CPE will perform a + reboot. + + If a CWMP session is in progress at the specified time, the CPE MUST + wait until the session has ended before performing the reboot. + + If the value specifies a date and time that has already passed (i.e., + a past date and time), no reboot will be performed. + + + + + + + + + The number of {{units}} from the time the CWMP session in which this + parameter value is set is ended until the CPE performs a reboot. + + Whenever the CPE reboots, this value MUST be reset by the CPE to -1. + + + + + + + + + + + + Whether or not the CPE MUST periodically send CPE information to the + ACS using the Inform method call. + + + + + + + + + The duration in {{units}} of the interval for which the CPE MUST + attempt to connect with the ACS and call the Inform method if + {{param|PeriodicInformEnable}} is {{true}}. + + + + + + + + + + + + An absolute time reference in UTC to determine when the CPE will + initiate the periodic Inform method calls. Each Inform call MUST + occur at this reference time plus or minus an integer multiple of the + {{param|PeriodicInformInterval}}. + + {{param}} is used only to set the ''phase'' of the periodic Informs. + The actual value of {{param}} can be arbitrarily far into the past or + future. + + For example, if {{param|PeriodicInformInterval}} is 86400 (a day) and + if {{param}} is set to UTC midnight on some day (in the past, + present, or future) then periodic Informs will occur every day at UTC + midnight. These MUST begin on the very next midnight, even if + {{param}} refers to a day in the future. + + The Unknown Time value defined in {{bibref|TR-106|section 3.2}} + indicates that no particular time reference is specified. That is, + the CPE MAY locally choose the time reference, and needs only to + adhere to the specified {{param|PeriodicInformInterval}}. + + If absolute time is not available to the CPE, its periodic Inform + behavior MUST be the same as if the {{param}} parameter was set to + the Unknown Time value. + + + + + + + + + {{param}} provides the ACS a reliable and extensible means to track + changes made by the ACS. The value of {{param}} MUST be equal to the + value of the ParameterKey argument from the most recent successful + SetParameterValues, AddObject, or DeleteObject method call from the + ACS. + + The CPE MUST set {{param}} to the value specified in the + corresponding method arguments if and only if the method completes + successfully and no fault response is generated. If a method call + does not complete successfully (implying that the changes requested + in the method did not take effect), the value of {{param}} MUST NOT + be modified. + + The CPE MUST only modify the value of {{param}} as a result of + SetParameterValues, AddObject, DeleteObject, or due to a factory + reset. On factory reset, the value of {{param}} MUST be set to + {{empty}}. + + + + + + + + + + + The HTTP {{datatype}} for an ACS to make a Connection Request + notification to the CPE. + + In the form: + + : http://host:port/path + + The ''host'' portion of the URL MAY be the IP address for the + management interface of the CPE in lieu of a host name. + + Note: If the ''host'' portion of the URL is a literal IPv6 address + then it MUST be enclosed in square brackets (see + {{bibref|RFC3986|Section 3.2.2}}). + + + + + + + + + Username used to authenticate an ACS making a Connection Request to + the CPE. + + + + + + + + + + + Password used to authenticate an ACS making a Connection Request to + the CPE. + + + + + + + Indicates whether or not the ACS will manage upgrades for the CPE. If + {{true}}, the CPE SHOULD NOT use other means other than the ACS to + seek out available upgrades. If {{false}}, the CPE MAY use other + means for this purpose. + + Note that an autonomous upgrade (reported via an "10 AUTONOMOUS + TRANSFER COMPLETE" Inform Event code) SHOULD be regarded as a managed + upgrade if it is performed according to ACS-specified policy. + + + + + + + + + Present only for a CPE that supports the Kicked RPC method. + + LAN-accessible {{datatype}} from which the CPE can be ''kicked'' to + initiate the Kicked RPC method call. MUST be an absolute URL + including a host name or IP address as would be used on the LAN side + of the CPE. + + + + + + + + + Present only for a CPE that provides a LAN-side web page to show + progress during a file download. + + LAN-accessible {{datatype}} to which a web-server associated with the + ACS MAY redirect a user's browser on initiation of a file download to + observer the status of the download. + + + + + + + + + This parameter is used to control throttling of active notifications + sent by the CPE to the ACS. It defines the minimum number of + {{units}} that the CPE MUST wait since the end of the last session + with the ACS before establishing a new session for the purpose of + delivering an active notification. + + In other words, if CPE needs to establish a new session with the ACS + for the sole purpose of delivering an active notification, it MUST + delay establishing such a session as needed to ensure that the + minimum time since the last session completion has been met. + + The time is counted since the last successfully completed session, + regardless of whether or not it was used for active notifications or + other purposes. However, if connection to the ACS is established for + purposes other than just delivering active notifications, including + for the purpose of retrying a failed session, such connection MUST + NOT be delayed based on this parameter value, and the pending active + notifications MUST be communicated during that connection. + + The time of the last session completion does not need to be tracked + across reboots. + + + + + + + + + + + Configures the first session retry wait interval, in {{units}}, as + specified in {{bibref|TR-069|section 3.2.1.1}}. + + A value of 5 corresponds to the default behavior that is described in + {{bibref|TR-069}}. + + The device MUST use a random value between {{param}} and ({{param}} * + {{param|CWMPRetryIntervalMultiplier}} / 1000) as the first retry wait + interval. Other values in the retry pattern MUST be calculated using + this value as a starting point. + + + + + + + + + + + + Configures the retry interval multiplier as specified in + {{bibref|TR-069|section 3.2.1.1}}. + + This value is expressed in units of 0.001. Hence the values of the + multiplier range between 1.000 and 65.535. + + A value of 2000 corresponds to the default behavior that is described + in {{bibref|TR-069}}. + + The device MUST use a random value between + {{param|CWMPRetryMinimumWaitInterval}} and + ({{param|CWMPRetryMinimumWaitInterval}} * {{param}} / 1000) as the + first retry wait interval. Other values in the retry pattern MUST be + calculated using this value as a starting point. + + + + + + + + + + + Enables or disables HTTP connection request handling on the CPE. + + If HTTP connection request handling is disabled ({{param}} is set to + {{false}}), {{param|ConnectionRequestURL}} MUST be set to {{empty}} + and the CPE MUST close the port used by the HTTP connection request + server. + + + + + + + + + + Address and port to which an ACS MAY send a UDP Connection Request to + the CPE (see {{bibref|TR-069|Annex G}}). + + This parameter is represented in the form of an Authority element as + defined in {{bibref|RFC3986}}. The value MUST be in one of the + following two forms: + + : host:port + + : host + + * When {{param|STUNEnable}} is {{true}}, the ''host'' and ''port'' + portions of this parameter MUST represent the public address and + port corresponding to the NAT binding through which the ACS can + send UDP Connection Request messages (once this information is + learned by the CPE through the use of STUN). + + * When {{param|STUNEnable}} is {{false}}, the ''host'' and ''port'' + portions of the URL MUST represent the local IP address and port on + which the CPE is listening for UDP Connection Request messages. + + The second form of this parameter MAY be used only if the port value + is equal to ''80''. + + Note: If the ''host'' portion of the URL is a literal IPv6 address + then it MUST be enclosed in square brackets (see + {{bibref|RFC3986|Section 3.2.2}}). + + + + + + + + + + + Enables or disables the use of STUN by the CPE. This applies only to + the use of STUN in association with the ACS to allow UDP Connection + Requests. + + + + + + + + + Host name or IP address of the STUN server for the CPE to send + Binding Requests if STUN is enabled via {{param|STUNEnable}}. + + If is {{empty}} and {{param|STUNEnable}} is {{true}}, the CPE MUST + use the address of the ACS extracted from the host portion of the ACS + URL. + + + + + + + + + + + Port number of the STUN server for the CPE to send Binding Requests + if STUN is enabled via {{param|STUNEnable}}. + + By default, this SHOULD be the equal to the default STUN port, 3478. + + + + + + + + + + + If is not {{empty}}, the value of the STUN USERNAME attribute to be + used in Binding Requests (only if message integrity has been + requested by the STUN server). + + If is {{empty}}, the CPE MUST NOT send STUN Binding Requests with + message integrity. + + + + + + + + + + + The value of the STUN Password to be used in computing the + MESSAGE-INTEGRITY attribute to be used in Binding Requests (only if + message integrity has been requested by the STUN server). + + + + + + + If STUN Is enabled, the maximum period, in {{units}}, that STUN + Binding Requests MUST be sent by the CPE for the purpose of + maintaining the binding in the Gateway. This applies specifically to + Binding Requests sent from the UDP Connection Request address and + port. + + A value of -1 indicates that no maximum period is specified. + + + + + + + + + + + + If STUN Is enabled, the minimum period, in {{units}}, that STUN + Binding Requests can be sent by the CPE for the purpose of + maintaining the binding in the Gateway. This limit applies only to + Binding Requests sent from the UDP Connection Request address and + port, and only those that do not contain the BINDING-CHANGE + attribute. This limit does not apply to retransmissions following the + procedures defined in {{bibref|RFC3489}}. + + + + + + + + + + + When STUN is enabled, this parameter indicates whether or not the CPE + has detected address and/or port mapping in use. + + A {{true}} value indicates that the received MAPPED-ADDRESS in the + most recent Binding Response differs from the CPE's source address + and port. + + When {{param|STUNEnable}} is {{false}}, this value MUST be {{false}}. + + + + + + + + + Indicates whether or not the Alias-Based Addressing Mechanism is + supported. + + A {{true}} value indicates that the CPE supports the Alias-Based + Addressing Mechanism, as defined in {{bibref|TR-069|3.6.1}} and + described in {{bibref|TR-069|Appendix II}}. + + + + + + + + + Instance identification mode as defined in {{bibref|TR-069|3.6.1}}. + When {{param|AliasBasedAddressing}} is {{true}}, {{param}} is used by + the ACS to control whether the CPE will use Instance Numbers or + Instance Aliases in returned Path Names. {{enum}} + + This parameter is REQUIRED for any CPE supporting Alias-Based + Addressing. + + + + + + + + + + + + + Enable or disable the Auto-Create Instance Mechanism. When + {{param|AliasBasedAddressing}} is {{true}}, {{param}} indicates + whether or not the CPE will automatically create instances while + processing a SetParameterValues RPC (as defined in + {{bibref|TR-069|A.3.2.1}}). + + *A {{true}} value indicates that the CPE will perform auto-creation + of instances when the Alias-Based Addressing Mechanism is used in + SetParameterValues RPC. + + *A {{false}} value indicates that the CPE will not create new object + instances. Instead, it will reject the setting of parameters in + unrecognized instances and respond with a fault code. + + This parameter is REQUIRED for any CPE supporting Alias-Based + Addressing. + + + + + + + + + + {{numentries}} + + + + + + + + + The minimum time, in seconds, between Active Notifications resulting + from changes to the {{param|ManageableDeviceNumberOfEntries}} (if + Active Notification is enabled). + + + + + + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + The connection request methods supported by this {{object}}. {{enum}} + + + + + + + The connection request method as specified in + {{bibref|TR-069|Section 3.2.2 ACS Connection Initiation}}, + '''REQUIRED''' + + + + + The connection request method as specified in + {{bibref|TR-069|Annex G Connection Request via NAT Gateway}} + + + + + The connection request method as specified in + {{bibref|TR-069|Annex K XMPP Connection Request}} + + + + + + + + + {{reference|the {{object|#.XMPP.Connection}} instance that is used + for connection requests to this {{object}}}} + + + + + + + + + + + When an XMPP Connection Request is sent to a CPE the XMPP IQ Stanza + will contain a "from" address that contains the Jabber ID of the + initiating entity. + + This parameter is a {{list}} Each entry represents a Jabber ID, or + address, that is allowed to initiate an XMPP Connection Request. + + Each Jabber ID is allowed to be either a "Full JID" (containing a + local-part, domain-part, and resource-part in the following format: + "local-part@domain-part/resource-part") or a "Bare JID" (containing a + local-part and a domain-part in the following format: + "local-part@domain-part"). "Full JID" entries require an exact match + whereas "Bare JID" entries are a wildcard match and will match any + Jabber ID with the same local-part and domain-part independent of the + resource-part. + + For example, if {{param}} contained "ACS1@tr069.example.com, + ACS2@tr-069.example.com/resource1" then the following incoming "from" + addresses would be '''allowed''': + + * "ACS1@tr069.example.com/resource1" + + * "ACS1@tr069.example.com/resource2" + + * "ACS2@tr069.example.com/resource1" + + And the following incoming "from" addresses '''would not be + allowed''': + + * "ACS2@tr069.example.com/resource2" + + * "ACS@tr069.example.com/resource" + + If this Parameter is {{empty}} then all Jabber IDs are allowed and an + XMPP Connection Request can not be deemed invalid due to the "from" + address. + + + + + + + + + + + + + + The value MUST be the value of the + {{param|#.XMPP.Connection.{i}.JabberID}} contained in the + {{object|#.XMPP.Connection}} instance referenced by the + {{param|ConnReqXMPPConnection}} parameter. + + If the {{param|ConnReqXMPPConnection}} parameter is empty or the + {{object|#.XMPP.Connection}} instance being reference is disabled, + then this value will be empty. + + If the {{object|#.XMPP.Connection}} instance being referenced by the + {{param|ConnReqXMPPConnection}} parameter is lost + ({{param|#.XMPP.Connection.{i}.Status}} parameter changes from + Enabled to some other value), then the value of this parameter MUST + remain unchanged until the connection can be reestablished and a new + {{param|#.XMPP.Connection.{i}.JabberID}} can be established. If the + new {{param|#.XMPP.Connection.{i}.JabberID}} is identical to the + existing value, then the value of this parameter MUST NOT be altered + and a VALUE CHANGE event MUST NOT be generated. + + + + + + + + + Indicates the HTTP Compression mechanism(s) supported by this CPE. + Requirements for the use of HTTP Compression for CWMP can be found in + {{bibref|TR-069|Section 3.4.7}}. {{enum}} + + Vendors can extend the enumerated values with vendor specific + extensions, in which case the rules outlined in + {{bibref|TR-106|Section 3.3}} MUST be adhered to. + + + + + + + As defined in {{bibref|RFC2616|Section 3.5}} + + + + + As defined in {{bibref|RFC2616|Section 3.5}} + + + + + As defined in {{bibref|RFC2616|Section 3.5}} + + + + + + + + + The value of this parameter represents the HTTP Compression mechanism + to be used by the CPE when communicating with the ACS. + + + + + + + + + + + + Indicates the Lightweight Notification Protocol(s) supported by this + CPE. {{enum}} + + Vendors can extend the enumerated values with vendor specific + extensions, in which case the rules outlined in + {{bibref|TR-106|Section 3.3}} MUST be adhered to. + + + + + + + As defined in {{bibref|TR-069|Annex M}} + + + + + + + + + The value of this parameter represents the protocol(s) that will be + used by the CPE when sending Lightweight Notifications. + + {{empty}} means that Lightweight Notifications are disabled, despite + any SetParameterAttributes that have been configured on various + parameters. + + + + + + + + + + + + The duration in {{units}} of the interval for which the CPE MUST + attempt to deliver any pending Passive Lightweight Notifications. + + A value of 0 means that the trigger interval is effectively disabled. + In this case pending Passive Lightweight Notifications are only sent + when triggered by an Active Lightweight Notification. + + + + + + + + + + + + An absolute time reference in UTC to determine when the CPE will + initiate the Lightweight Notification (in the case that there are + pending Passive Lightweight Notifications that need to be delivered). + Each Passive Lightweight Notification (that is waiting for the + Lightweight Notification Trigger mechanism for delivery) MUST occur + at this reference time plus or minus an integer multiple of the + {{param|LightweightNotificationTriggerInterval}}. {{param}} is used + only to set the ''phase'' of the Passive Lightweight Notification. + The actual value of {{param}} can be arbitrarily far into the past or + future. + + For example, if {{param|LightweightNotificationTriggerInterval}} is + 86400 (a day) and if {{param}} is set to UTC midnight on some day (in + the past, present, or future) then Lightweight Notifications for + pending Passive Lightweight Notifications will occur every day at UTC + midnight. These MUST begin on the very next midnight, even if + {{param}} refers to a day in the future. The Unknown Time value + defined in {{bibref|TR-106|section 3.2}} indicates that no particular + time reference is specified. That is, the CPE MAY locally choose the + time reference, and needs only to adhere to the specified + {{param|LightweightNotificationTriggerInterval}}. If absolute time is + not available to the CPE, its Lightweight Notifications behavior MUST + be the same as if the {{param}} parameter was set to the Unknown Time + value. + + + + + + + + + Host name or address to be used when sending the UDP Lightweight + Notifications. + + {{param}} is only applicable when + {{param|LightweightNotificationProtocolsUsed}} contains the + {{enum|UDP|LightweightNotificationProtocolsUsed}} enumeration. + + If {{param}} is not implemented or is {{empty}}, and UDP Lightweight + Notifications are supported, the destination host MUST be the same as + the ACS (as contained in the host portion of the {{param|URL}}). + + + + + + + + + + + The port number to be used when sending UDP Lightweight + Notifications. + + {{param}} is only applicable when + {{param|LightweightNotificationProtocolsUsed}} contains the + {{enum|UDP|LightweightNotificationProtocolsUsed}} enumeration. + + If {{param}} is not implemented and UDP Lightweight Notifications are + supported, the destination port MUST be 7547. + + + + + + + + + Indicates whether or not instance wildcards are supported. + + A {{true}} value indicates that the CPE supports instance wildcards + for GPV, GPN and GPA RPC calls, as defined in [TR-069]. + + + + + + + + + {{numentries}} + + + + + + + + + + Each entry in this table corresponds to a distinct LAN Device that + supports Device-Gateway Association according to {{bibref|TR-069|Annex + F}} as indicated by the presence of the DHCP option specified in that + Annex. + + + + + + + + + + A non-volatile handle used to reference this instance. {{param}} + provides a mechanism for an ACS to label this instance for future + reference. An initial unique value MUST be assigned when the CPE + creates an instance of this object. + + {{deprecated|2.11|because {{object}} is a transient object}} + + {{obsoleted|2.14}} + + {{deleted|2.15}} + + + + + + + + + + + Organizationally unique identifier of the Device manufacturer as + provided to the Gateway by the Device. Represented as a six + hexadecimal-digit value using all upper-case letters and including + any leading zeros. {{pattern}} + + The value MUST be a valid OUI as defined in {{bibref|OUI}}. + + + + + + + + + + + + Serial number of the Device as provided to the Gateway by the Device. + + + + + + + + + + + Identifier of the class of product for which the Device's serial + number applies as provided to the Gateway by the Device. + + If the Device does not provide a Product Class, then this parameter + MUST be {{empty}}. + + + + + + + + + + + {{list}} {{reference}} References all the {{object|##.Hosts.Host}} + table entries, whether active or inactive, that correspond to this + physical LAN device. There can be multiple such entries if the device + has more than one network interface. + + For example: ''Device.Hosts.Host.1,Device.Hosts.Host.5'' + + + + + + + + + + + + + + + This object allows configuration of CPE policy for notification of + AUTONOMOUS TRANSFER COMPLETE events, defined in {{bibref|TR-069}}. + + The CPE policy determines the conditions under which the CPE notifies + the ACS of the completion of file transfers that were not specifically + requested by the ACS. + + + + + Enable/disable CPE notification of AUTONOMOUS TRANSFER COMPLETE + events to the ACS. + + + + + + + + + Indicates the transfer types that MUST be included when the CPE + notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. Transfer + types not indicated by this filter MUST NOT be included when the CPE + notifies the ACS. {{enum}} + + Note that this includes any backup or restore operations that were + not specifically requested by the ACS. A backup is regarded as an + Upload and a restore is regarded as a Download. + + + + + + + Upload and Download + + + + + + + + Indicates the transfer results that MUST be included when the CPE + notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. Transfer + results omitted from this list MUST NOT be included when the CPE + notifies the ACS. + + Note that this includes any backup or restore operations that were + not specifically requested by the ACS. A backup is regarded as an + Upload and a restore is regarded as a Download. + + + + + + The autonomous file transfer completed successfully; i.e., the + FaultCode was zero + + + + + The autonomous file transfer did not complete successfully; + i.e., the FaultCode was non-zero + + + + Success and Failure + + + + + + + + {{list}} Indicates the file types that MUST be included when the CPE + notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. File types + omitted from this list MUST NOT be included when the CPE notifies the + ACS. + + {{pattern}} + + Additionally, the following format is defined to allow the unique + definition of vendor-specific file types: + + * ''"X <OUI> <Vendor-specific identifier>"'' + + <OUI> is replaced by a 6 hexadecimal-digit OUI + (organizationally unique identifier) as defined in {{bibref|OUI}}, + with all upper-case letters and any leading zeros included. The OUI + used for a given vendor-specific file type MUST be one that is + assigned to the organization that defined this file type (which is + not necessarily the same as the vendor of the CPE or ACS). + + Note that {{empty}} indicates that all file types are excluded from + this filter, effectively disabling CPE notification of AUTONOMOUS + TRANSFER COMPLETE events to the ACS. + + + + + + + + Download Only + + + Download Only + + + Download or Upload + + + Upload Only + + + + For Vendor-Specific File Types, could be for either Download or + Upload + + + + + + + + + + This object contains multicast announcement and query parameters used + for the purpose of downloading files. + + + + + + This object contains multicast announcement parameters used to download + files. + + + + + Enable/disable CPE ability to receive and use multicast announcements + from a server for the purpose of downloading files. + + + + + + + + + The status of the announcement service. + + + + + + + + MAY be used by the CPE to indicate a locally defined error + condition. + + + + + + + + + {{numentries}} + + + + + + + + + + Multicast groups to which the CPE SHOULD listen for announcements. + + + + + + + + + + + {{datatype|expand}} + + + + + + + + + Enable/disable listening to this multicast group. + + + + + + + + + + The status of this group table entry. + + + + + + + + MAY be used by the CPE to indicate a locally defined error + condition, e.g. unable to parse received announcements. + + + + + + + + + + The {{datatype}} encoding the group address, source and port on which + to listen, and other protocol information, e.g. expected announcement + format. + + Depending on the application, the messages identified by this URL MAY + directly contain the data to be downloaded, or alternatively MAY + contain information informing the CPE how to obtain the data to be + downloaded via a separate mechanism, which itself could involve a + unicast or a multicast download protocol. + + Refer to {{bibref|DVB-TS.102.824}} for an example of a URL format + that identifies a SAP {{bibref|RFC2974}} stream that indicates how to + use either FLUTE {{bibref|RFC3926}} or DSM-CC + {{bibref|ISO-13818-6:1998}} to perform the download. + + + + + + + + + + This object contains multicast query parameters used to download files. + + + + + Enable/disable CPE ability to autonomously query a server for the + purpose of downloading files. + + + + + + + + + The status of the query service. + + + + + + + + MAY be used by the CPE to indicate a locally defined error + condition, e.g. unable to contact query response server. + + + + + + + + + The {{datatype}} of the query response server. + + Depending on the application, the protocol described by this URL MAY + be a SOAP interface, or MAY be any other RPC mechanism. + + Refer to {{bibref|DVB-TS.102.824}} for an example of a URL format + that identifies a SOAP interface running over HTTP or HTTPS. + + + + + + + + + + This object allows configuration of CPE policy for notification of "12 + AUTONOMOUS DU STATE CHANGE COMPLETE" events defined in + {{bibref|TR-069}}. + + The CPE policy determines the conditions under which the CPE notifies + the ACS of the completion of Deployment Unit state changes that were + not specifically requested via CWMP. + + + + + Enables/Disables CPE notification of "12 AUTONOMOUS DU STATE CHANGE + COMPLETE" events to the ACS. + + + + + + + + + Indicates the Deployment Unit operations that MUST be included when + the CPE notifies the ACS of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" + events. + + Operation types not indicated by this list MUST NOT be included when + the CPE notifies the ACS. {{empty}} is essentially the same as + setting {{param|Enable}} to {{false}}. + + + + + + + + + + + + + + Indicates the Deployment Unit state change results that MUST be + included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE + CHANGE COMPLETE" events. State change results omitted from this + filter MUST NOT be included when the CPE notifies the ACS. + + + + + + The autonomous state change completed successfully; i.e., the + FaultCode was zero + + + + + The autonomous state change did not complete successfully; + i.e., the FaultCode was non-zero + + + + + All result types independent of Success or Failure + + + + + + + + + Indicates the Deployment Unit state change fault codes that MUST be + included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE + CHANGE COMPLETE" events. State change fault codes omitted from this + filter MUST NOT be included when the CPE notifies the ACS. + + This filter has no effect on the notification of a successful + autonomous state change. This filter only applies when + {{param|ResultTypeFilter}} is set to either + {{enum|Failure|ResultTypeFilter}} or {{enum|Both|ResultTypeFilter}}. + {{empty}} means that failed autonomous state changes will not be sent + to the ACS. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Each entry in this table represents a distinct Proxied Device that + utilizes the Embedded Object Mechanism {{bibref|TR-069|Annex J.3}} for + proxying devices. + + + + + + + + + Identifier of the controller that is responsible for a sub-network of + Proxied Devices within the LAN. + + {{empty}} indicates that this Proxied Device either: + + * Isn't part of a sub-network, within the LAN, with a controller + entity. + + * Doesn't need a {{param}} to ensure its {{param|ProxiedDeviceID}} is + unique throughout the LAN. + + + + + + + + + + + Idenitfier of the Proxied Device. + + This is an opaque string that is unique to the Proxied Device within + a specific sub-network within the LAN (identified by the + {{param|ControllerID}}). If the {{param|ControllerID}} is {{empty}} + this {{param}} is unique across the LAN. + + + + + + + + + + + {{noreference}}The value MUST be the path name of a table row. If the + referenced object is deleted, this {{object}} instance MUST also be + removed. Represents the instance of a multi-instanced object that is + directly controlled by, and has come into existence because of, this + Proxied Device that utilizes the Embedded Object Mechanism + {{bibref|TR-069|Annex J.3}}. + + + + + + + + + + + Represents the CWMP-DT schema instance(s) that this Proxied Device is + utilizing. The CWMP-DT schema instance is also the one being utilized + by the object referenced within {{param|Reference}}. + + + + + + + + + + + + References the {{object|##.Hosts.Host}} table entry(s), whether + active or inactive, that corresponds to this proxied LAN device. + + + + + + + + + + + + + + The protocol being used to communicate between the CPE Proxier and + this Proxied Device. {{enum}} + + Vendors can extend the enumerated values with vendor specific + extensions, in which case the rules outlined in {{bibref|TR-106|3.3}} + MUST be adhered to. + + + + + see {{bibref|Z-Wave}} + + + see {{bibref|ZigBee}} + + + see {{bibref|UPnP-DM:1}} + + + see {{bibref|ETSIM2MFA}} + + + + + + + + {{reference|a protocol object that uses the {{param|ProxyProtocol}}}} + + + + + + + + + + + {{list|that represents the discovery protocol(s) for this proxied + device}} + + {{enum}} + + Vendors can extend the enumerated values with vendor specific + extensions, in which case the rules outlined in + {{bibref|TR-106|Section 3.3}} MUST be adhered to. + + + + + + see {{bibref|Z-Wave}} + + + see {{bibref|ZigBee}} + + + see {{bibref|UPnP-DAv1}} + + + see {{bibref|ETSIM2MFA}} + + + + + + + + {{list}} {{reference|an object discovered using one or more protocols + listed in {{param|DiscoveryProtocol}}}} + + For objects discovered by the UPnP discovery protocol, the {{param}} + would contain items that are references to instances of the + following: + + * {{object|##.UPnP.Discovery.RootDevice}} + + * {{object|##.UPnP.Discovery.Device}} + + * {{object|##.UPnP.Discovery.Service}} + + For objects discovered by the ETSI-M2M discovery protocol, the + {{param}} would contain items that are references to instances of + {{object|##.ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance}}. + + + + + + + + + + + + Whether or not the CPE Proxier has successfully communicated all + pending configuration commands down to the Proxied Device. + + + + + + + + + + + + + + Detailed {{param|CommandProcessed}} error description (vendor + specific). + + + + + + + + + + + The last time that the CPE Proxier synchronized the state of the + Proxied Device. This parameter MUST be updated when a proxy command + is executed successfully on the Proxied Device. + + The Unknown Time value, as defined in {{bibref|TR-106}}, indicates + that the Proxied Device's state has not been synchronized since the + CPE Proxier was last rebooted. + + + + + + + + + + Each entry in this table represents a distinct Proxied Device that + utilizes the Virtual CWMP Device Mechanism {{bibref|TR-069|Annex J.2}} + for proxying devices. + + + + + + + + + + Organizationally unique identifier of the associated Proxied Device. + Represented as a six hexadecimal-digit value using all upper-case + letters and including any leading zeros. {{pattern}} + + The value MUST be a valid OUI as defined in {{bibref|OUI}}. + + + + + + + + + + + + Identifier of the class of product of the associated Proxied Device + for which the serial number applies. + + + + + + + + + + + Serial number of the associated Proxied Device. + + + + + + + + + + + {{list}} {{reference}} References all the {{object|##.Hosts.Host}} + table entries, whether active or inactive, that correspond to this + proxied LAN device. There can be multiple such entries if the Proxied + Device has more than one network interface. + + + + + + + + + + + + + + The protocol being used to communicate between the CPE Proxier and + this Proxied Device. {{enum}} + + Vendors can extend the enumerated values with vendor specific + extensions, in which case the rules outlined in {{bibref|TR-106|3.3}} + MUST be adhered to. + + + + + see {{bibref|Z-Wave}} + + + see {{bibref|ZigBee}} + + + see {{bibref|UPnP-DM:1}} + + + see {{bibref|ETSIM2MFA}} + + + + + + + + {{reference|a protocol object that uses the {{param|ProxyProtocol}}}} + + + + + + + + + + + {{list|that represents the discovery protocol(s) for this proxied + device}} + + {{enum}} + + Vendors can extend the enumerated values with vendor specific + extensions, in which case the rules outlined in + {{bibref|TR-106|Section 3.3}} MUST be adhered to. + + + + + + see {{bibref|Z-Wave}} + + + see {{bibref|ZigBee}} + + + see {{bibref|UPnP-DAv1}} + + + see {{bibref|ETSIM2MFA}} + + + + + + + + {{list}} {{reference|an object discovered using one or more protocols + listed in {{param|DiscoveryProtocol}}}} + + For objects discovered by the UPnP discovery protocol, the {{param}} + would contain items that are references to instances of the + following: + + * {{object|##.UPnP.Discovery.RootDevice}} + + * {{object|##.UPnP.Discovery.Device}} + + * {{object|##.UPnP.Discovery.Service}} + + For objects discovered by the ETSI-M2M discovery protocol, the + {{param}} would contain items that are references to instances of + {{object|##.ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance}}. + + + + + + + + + + + + + Parameters related to CPE behavior when waking up from standby. If this + object is supported then the CPE MUST support the requirements of + {{bibref|TR-069|Annex L}}. + + NOTE: "CR", as used in the names and descriptions of the parameters + defined in this object, refers to the Connection Request concept + defined in TR-069. + + + + + When waking up from a non CR-Aware Standby that lasted more than this + parameter's value (in {{units}}), the CPE MUST issue a WAKEUP Event. + + If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for + having been non CR-aware. + + + + + + + + + + + + + When waking up from a non fully Timer-Aware Standby that made it miss + more than this parameter's value Periodic Contacts, the CPE MUST + issue a WAKEUP Event. + + If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for + exceeding that limit. + + + + + + + + + + + + When waking up from a non fully Timer-Aware Standby that made it miss + at least one Scheduled Contact, the CPE MUST issue a WAKEUP Event if + this parameter is {{true}}. + + + + + + + + + + Indicates that the CPE is capable of CR-Aware Standby. + + + + + + + + + Indicates that the CPE is capable of Timer-Aware Standby. + + + + + + + + + If {{param|NetworkAwarenessCapable}} and this parameter are both + {{true}}, the CPE MUST NOT go into a non CR-Aware Standby state. + + + + + + + + + + If {{param|SelfTimerCapable}} and this parameter are both {{true}}, + the CPE MUST NOT go into a standby state that prevents it from + honoring Periodic Contacts. + + + + + + + + + + If this parameter is true, the CPE MUST NOT go into a standby state + that prevents it from honoring Scheduled Contacts. This means that, + whenever the ACS has requested a Scheduled Contact: + + *if {{param|SelfTimerCapable}} is {{true}} and the CPE chooses to go + into Standby before the Scheduled Contact has been honored, it MUST + use a Timer-Aware Standby; + + *if {{param|SelfTimerCapable}} is {{false}}, the CPE MUST NOT go into + Standby before the Scheduled Contact has been honored. + + + + + + + + + + This table provides the ACS with the ability to control the Parameters + that are delivered by the Inform RPC. + + Any Parameter (identified by {{param|ParameterName}}) contained in this + table MUST be included within the ParameterList argument of the Inform + RPC whenever any Event within the {{param|EventList}} is being + delivered. + + This table does not include Forced Inform Parameters, and Forced Inform + Parameters are not allowed to be inserted into this table. Any attempt + by an ACS to configure this table to contain a Forced Inform Parameter + MUST result in the failure of the SetParameterValues RPC with error + code 9007. + + + + + + + + + + + Enables or disables this {{object}}. + + + + + + + + + + {{datatype|expand}} + + + + + + + + + A pattern that describes the Parameter(s) to be included in the + Inform’s ParameterList argument. Specifically, patterns with + wildcards (an "*" character) in place of Instance Identifiers are + allowed; any attempt to set the value otherwise MUST be rejected by + the CPE. + + If the pattern does not match any existing Parameters at the time + that the CPE is creating the Inform RPC, then this + {{object|#.InformParameter}} instance is not included in the Inform’s + ParameterList argument. + + + + + + + + + + + + Each entry in this list represents an Event for which this Parameter + MUST be included within the ParameterList argument of the Inform RPC. + + All Inform Events (see {{bibref|TR-069|Section 3.7.1.5}}), except for + "4 VALUE CHANGE", are allowed as entries in this list. "4 VALUE + CHANGE" is not allowed as that would violate requirements contained + in {{bibref|TR-069|Section A.3.3.1}}. + + {{empty}} means all events except "4 VALUE CHANGE". + + + + + + + + + + + + Parameters related to CPE behavior in order to issue a Heartbeat event + to the ACS using the Inform method call. + + If this object is supported then the CPE MUST support the requirements + of {{bibref|TR-069|Annex O}}. + + + + + When {{true}}, Heartbeat events are enabled to be sent to the ACS + based on the values of the {{param|ReportingInterval}} and + {{param|InitiationTime}} parameters. + + + + + + + + + The duration in {{units}} of the interval for which the CPE MUST + attempt to connect with the ACS and call the Inform method if + {{param|Enable}} is {{true}}. + + + + + + + + + + + + An absolute time reference in UTC to determine when the CPE will + initiate the Heartbeat event Inform method calls. Each Inform call + MUST occur at this reference time plus or minus an integer multiple + of the {{param|ReportingInterval}}. + + {{param}} is used only to set the ''phase'' of the Heartbeat event + Informs. The actual value of {{param}} can be arbitrarily far into + the past or future. + + For example, if {{param|ReportingInterval}} is 60 (one minute) and if + {{param}} is set to UTC midnight on some day (in the past, present, + or future) then Heartbeat Informs will occur every minute at the next + UTC midnight. These MUST begin on the very next midnight, even if + {{param}} refers to a day in the future. + + The Unknown Time value defined in {{bibref|TR-106|section 3.2}} + indicates that no particular time reference is specified. The CPE + MUST locally choose a random time reference. + + If absolute time is not available to the CPE, its Heartbeat Inform + behavior MUST be the same as if the {{param}} parameter was set to + the Unknown Time value. + + + + + + + @@ -51536,531 +51537,6 @@ - - - This object is to provide diagnostic information on a Clear Channel - Assessment (CCA) measurement scan on this radio on the given channel - using a specific {{param|DwellTime}}. - - - - - {{datatype|expand}} - - - - - - - - - - - - - - - The number of the Wi-Fi channel the clear channel assessment (CCA) - measurement is run on. - - - - - - - - - Frequency of the channel the clear channel assessment (CCA) - measurement is run on. - - - - - - - - - - - - - The duration of the CCA measurement in {{units}}. - - - - - - - - - - - The clear channel assessment (CCA) report in the format specified in - {{bibref|802.11-2020|Section 9.4.2.21.3}}. - - When read, the value of this parameter MUST correspond to - {{param|Channel}}. How this is achieved is a local matter to the CPE. - - - - - - - - - - - - This object is to provide diagnostic information on a Remote - Measurement of a Wi-Fi BSS. - - - - - {{datatype|expand}} - - - - - - - - - - - - - - - The BSSID of the remote BSS. - - - - - - - - - The duration after which the request is timed out in {{units}}. - - - - - - - - - - - The Operating Class in {{bibref|802.11-2020|Table E-4}} for which the - measurement is requested. - - - - - - - - - - - The number of the channel for which the measurement is requested. - - - - - - - - - The received signal strength (RSSI) as received by the radio measured - in {{units}}. RSSI is encoded as per {{bibref|802.11-2020|Table - 9-176}}. Reserved: 221 - 255. - - - - - - - - - - - - An indicator of the average radio noise plus interference power as - received by the radio. Encoded as defined for ANPI in - {{bibref|802.11-2020|Section 11.10.9.4}}. - - - - - - - - - - - - This object defines access to other WiFi SSIDs that this device is able - to receive. - - - - - {{datatype|expand}} - - - - - - - - - - - {{deprecated|2.13|because it's a typo for {{enum|Complete}}}} - - {{obsoleted|2.16}} - - {{deleted|2.17}} - - - - - - - - - {{numentries}} - - - - - - - - - - Neighboring SSID table. This table models other WiFi SSIDs that this - device is able to receive. - - - - - - - - The Radio that detected the neighboring WiFi SSID. - - - - - - - - - - - The current service set identifier in use by the neighboring WiFi - SSID. The value MAY be empty for hidden SSIDs. - - - - - - - - - - - The BSSID used for the neighboring WiFi SSID. - - - - - - - - - The mode the neighboring WiFi radio is operating in. - - - - - - - - - - - - The current radio channel used by the neighboring WiFi radio. - - - - - - - - - - - An indicator of radio signal strength (RSSI) of the neighboring WiFi - radio measured in {{units}}, as an average of the last 100 packets - received. - - - - - - - - - - - - The type of encryption the neighboring WiFi SSID advertises. - - The {{enum|WEP}} value indicates either WEP-64 or WEP-128. - - The {{enum|WPA}} value is the same as WPA-Personal. - - The {{enum|WPA2}} value is the same as WPA2-Personal. - - The {{enum|WPA-WPA2}} value is the same as WPA-WPA2-Personal. - - The {{enum|WPA3-SAE}} value is the same as WPA3-Personal. - - The {{enum|WPA2-PSK-WPA3-SAE}} value is the same as - WPA3-Personal-Transition. - - - - - - - - - - - - - - - - - - - - - - The type of encryption the neighboring WiFi SSID advertises. - - When {{param|SecurityModeEnabled}} is one of - {{enum|WPA3-SAE|SecurityModeEnabled}}, - {{enum|WPA2-PSK-WPA3-SAE|SecurityModeEnabled}}, or - {{enum|WPA3-Enterprise|SecurityModeEnabled}}, {{enum|TKIP}} is not - valid, and should not be in the list. - - - - - - - - - - - - - Indicates the frequency band at which the radio this SSID instance is - operating. - - - - - - - - - - - - - {{list}} List items indicate which IEEE 802.11 standards this - {{object}} instance can support simultaneously, in the frequency band - specified by {{param|OperatingFrequencyBand}}. {{enum}} - - Each value indicates support for the indicated standard. - - If {{param|OperatingFrequencyBand}} is set to - {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, - {{enum|g}}, {{enum|n}}, {{enum|ax}}, {{enum|be}} are allowed. - - If {{param|OperatingFrequencyBand}} is set to - {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, - {{enum|n}}, {{enum|ac}}, {{enum|ax}}, {{enum|be}} are allowed. - - If {{param|OperatingFrequencyBand}} is set to - {{enum|6GHz|OperatingFrequencyBand}}, only values {{enum|ax}}, - {{enum|be}} are allowed. - - - - - - {{bibref|802.11a-1999}} - - - {{bibref|802.11b-1999}} - - - {{bibref|802.11g-2003}} - - - {{bibref|802.11n-2009}} - - - {{bibref|802.11ac-2013}} - - - {{bibref|802.11ax}} - - - {{bibref|802.11be}} - - - - - - - - {{list}} List items indicate which IEEE 802.11 standard that is - detected for this {{object}}. - - Each value indicates support for the indicated standard. - - If {{param|OperatingFrequencyBand}} is set to - {{enum|2.4GHz|##.Radio.{i}.SupportedFrequencyBands}}, only values - {{enum|b}}, {{enum|g}}, {{enum|n}}, {{enum|ax}}, {{enum|be}} are - allowed. - - If {{param|OperatingFrequencyBand}} is set to - {{enum|5GHz|##.Radio.{i}.SupportedFrequencyBands}}, only values - {{enum|a}}, {{enum|n}}, {{enum|ac}}, {{enum|ax}}, {{enum|be}} are - allowed. - - If {{param|OperatingFrequencyBand}} is set to - {{enum|6GHz|##.Radio.{i}.SupportedFrequencyBands}}, only value - {{enum|ax}}, {{enum|be}} are allowed. - - For example, a value of "g,b" (or "b,g" - order is not important) - means that the 802.11g standard {{bibref|802.11g-2003}} is used with - a backwards-compatible mode for 802.11b {{bibref|802.11b-1999}}. A - value of "g" means that only the 802.11g standard can be used. - - - - - - - - - - - - Indicates the bandwidth at which the channel is operating. - - - - - - - - - - - - - - - - - Time interval (in {{units}}) between transmitting beacons. - - - - - - - - - - - Indicator of average noise strength (in {{units}}) received from the - neighboring WiFi radio. - - - - - - - - - - - - {{list}} Basic data transmit rates (in Mbps) for the SSID. For - example, if {{param}} is "1,2", this indicates that the SSID is - operating with basic rates of 1 Mbps and 2 Mbps. - - - - - - - - - - - - {{list}} Data transmit rates (in Mbps) for unicast frames at which - the SSID will permit a station to connect. For example, if {{param}} - is "1,2,5.5", this indicates that the SSID will only permit - connections at 1 Mbps, 2 Mbps and 5.5 Mbps. - - - - - - - - - - - - The number of beacon intervals (measured in {{units}}) that elapse - between transmission of Beacon frames containing a TIM element whose - DTIM count field is 0. This value is transmitted in the DTIM Period - field of beacon frames. {{bibref|802.11-2020}} - - - - - - - - - @@ -52435,6 +51911,531 @@ + + + This object is to provide diagnostic information on a Clear Channel + Assessment (CCA) measurement scan on this radio on the given channel + using a specific {{param|DwellTime}}. + + + + + {{datatype|expand}} + + + + + + + + + + + + + + + The number of the Wi-Fi channel the clear channel assessment (CCA) + measurement is run on. + + + + + + + + + Frequency of the channel the clear channel assessment (CCA) + measurement is run on. + + + + + + + + + + + + + The duration of the CCA measurement in {{units}}. + + + + + + + + + + + The clear channel assessment (CCA) report in the format specified in + {{bibref|802.11-2020|Section 9.4.2.21.3}}. + + When read, the value of this parameter MUST correspond to + {{param|Channel}}. How this is achieved is a local matter to the CPE. + + + + + + + + + + + + This object is to provide diagnostic information on a Remote + Measurement of a Wi-Fi BSS. + + + + + {{datatype|expand}} + + + + + + + + + + + + + + + The BSSID of the remote BSS. + + + + + + + + + The duration after which the request is timed out in {{units}}. + + + + + + + + + + + The Operating Class in {{bibref|802.11-2020|Table E-4}} for which the + measurement is requested. + + + + + + + + + + + The number of the channel for which the measurement is requested. + + + + + + + + + The received signal strength (RSSI) as received by the radio measured + in {{units}}. RSSI is encoded as per {{bibref|802.11-2020|Table + 9-176}}. Reserved: 221 - 255. + + + + + + + + + + + + An indicator of the average radio noise plus interference power as + received by the radio. Encoded as defined for ANPI in + {{bibref|802.11-2020|Section 11.10.9.4}}. + + + + + + + + + + + + This object defines access to other WiFi SSIDs that this device is able + to receive. + + + + + {{datatype|expand}} + + + + + + + + + + + {{deprecated|2.13|because it's a typo for {{enum|Complete}}}} + + {{obsoleted|2.16}} + + {{deleted|2.17}} + + + + + + + + + {{numentries}} + + + + + + + + + + Neighboring SSID table. This table models other WiFi SSIDs that this + device is able to receive. + + + + + + + + The Radio that detected the neighboring WiFi SSID. + + + + + + + + + + + The current service set identifier in use by the neighboring WiFi + SSID. The value MAY be empty for hidden SSIDs. + + + + + + + + + + + The BSSID used for the neighboring WiFi SSID. + + + + + + + + + The mode the neighboring WiFi radio is operating in. + + + + + + + + + + + + The current radio channel used by the neighboring WiFi radio. + + + + + + + + + + + An indicator of radio signal strength (RSSI) of the neighboring WiFi + radio measured in {{units}}, as an average of the last 100 packets + received. + + + + + + + + + + + + The type of encryption the neighboring WiFi SSID advertises. + + The {{enum|WEP}} value indicates either WEP-64 or WEP-128. + + The {{enum|WPA}} value is the same as WPA-Personal. + + The {{enum|WPA2}} value is the same as WPA2-Personal. + + The {{enum|WPA-WPA2}} value is the same as WPA-WPA2-Personal. + + The {{enum|WPA3-SAE}} value is the same as WPA3-Personal. + + The {{enum|WPA2-PSK-WPA3-SAE}} value is the same as + WPA3-Personal-Transition. + + + + + + + + + + + + + + + + + + + + + + The type of encryption the neighboring WiFi SSID advertises. + + When {{param|SecurityModeEnabled}} is one of + {{enum|WPA3-SAE|SecurityModeEnabled}}, + {{enum|WPA2-PSK-WPA3-SAE|SecurityModeEnabled}}, or + {{enum|WPA3-Enterprise|SecurityModeEnabled}}, {{enum|TKIP}} is not + valid, and should not be in the list. + + + + + + + + + + + + + Indicates the frequency band at which the radio this SSID instance is + operating. + + + + + + + + + + + + + {{list}} List items indicate which IEEE 802.11 standards this + {{object}} instance can support simultaneously, in the frequency band + specified by {{param|OperatingFrequencyBand}}. {{enum}} + + Each value indicates support for the indicated standard. + + If {{param|OperatingFrequencyBand}} is set to + {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, + {{enum|g}}, {{enum|n}}, {{enum|ax}}, {{enum|be}} are allowed. + + If {{param|OperatingFrequencyBand}} is set to + {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, + {{enum|n}}, {{enum|ac}}, {{enum|ax}}, {{enum|be}} are allowed. + + If {{param|OperatingFrequencyBand}} is set to + {{enum|6GHz|OperatingFrequencyBand}}, only values {{enum|ax}}, + {{enum|be}} are allowed. + + + + + + {{bibref|802.11a-1999}} + + + {{bibref|802.11b-1999}} + + + {{bibref|802.11g-2003}} + + + {{bibref|802.11n-2009}} + + + {{bibref|802.11ac-2013}} + + + {{bibref|802.11ax}} + + + {{bibref|802.11be}} + + + + + + + + {{list}} List items indicate which IEEE 802.11 standard that is + detected for this {{object}}. + + Each value indicates support for the indicated standard. + + If {{param|OperatingFrequencyBand}} is set to + {{enum|2.4GHz|##.Radio.{i}.SupportedFrequencyBands}}, only values + {{enum|b}}, {{enum|g}}, {{enum|n}}, {{enum|ax}}, {{enum|be}} are + allowed. + + If {{param|OperatingFrequencyBand}} is set to + {{enum|5GHz|##.Radio.{i}.SupportedFrequencyBands}}, only values + {{enum|a}}, {{enum|n}}, {{enum|ac}}, {{enum|ax}}, {{enum|be}} are + allowed. + + If {{param|OperatingFrequencyBand}} is set to + {{enum|6GHz|##.Radio.{i}.SupportedFrequencyBands}}, only value + {{enum|ax}}, {{enum|be}} are allowed. + + For example, a value of "g,b" (or "b,g" - order is not important) + means that the 802.11g standard {{bibref|802.11g-2003}} is used with + a backwards-compatible mode for 802.11b {{bibref|802.11b-1999}}. A + value of "g" means that only the 802.11g standard can be used. + + + + + + + + + + + + Indicates the bandwidth at which the channel is operating. + + + + + + + + + + + + + + + + + Time interval (in {{units}}) between transmitting beacons. + + + + + + + + + + + Indicator of average noise strength (in {{units}}) received from the + neighboring WiFi radio. + + + + + + + + + + + + {{list}} Basic data transmit rates (in Mbps) for the SSID. For + example, if {{param}} is "1,2", this indicates that the SSID is + operating with basic rates of 1 Mbps and 2 Mbps. + + + + + + + + + + + + {{list}} Data transmit rates (in Mbps) for unicast frames at which + the SSID will permit a station to connect. For example, if {{param}} + is "1,2,5.5", this indicates that the SSID will only permit + connections at 1 Mbps, 2 Mbps and 5.5 Mbps. + + + + + + + + + + + + The number of beacon intervals (measured in {{units}}) that elapse + between transmission of Beacon frames containing a TIM element whose + DTIM count field is 0. This value is transmitted in the DTIM Period + field of beacon frames. {{bibref|802.11-2020}} + + + + + + + + + @@ -65113,9 +65114,467 @@ + + + Results for individual connections. This table is only populated when + {{param|#.EnablePerConnectionResults}} is {{true}}. A new object is + created for each connection specified in + {{param|#.NumberOfConnections}}. Instance numbers MUST start at 1 and + sequentially increment as new instances are created. All instances are + removed when {{param|#.DiagnosticsState}} is set to + {{enum|Requested|#.DiagnosticsState}} or + {{enum|None|#.DiagnosticsState}}. + + + + + Request time in UTC, which MUST be specified to microsecond + precision. + + For example: 2008-04-09T15:01:05.123456Z + + * For HTTP this is the time at which the client sends the GET + command. + + * For FTP this is the time at which the client sends the RTRV + command. + + + + + + + + + Begin of transmission time in UTC, which MUST be specified to + microsecond precision + + For example: 2008-04-09T15:01:05.123456Z + + * For HTTP this is the time at which the first data packet is + received. + + * For FTP this is the time at which the client receives the first + data packet on the data connection. + + + + + + + + + End of transmission in UTC, which MUST be specified to microsecond + precision. + + For example: 2008-04-09T15:01:05.123456Z + + * For HTTP this is the time at which the last data packet is + received. + + * For FTP this is the time at which the client receives the last + packet on the data connection. + + + + + + + + + The number of {{units}} of the test file received during the FTP/HTTP + transaction including FTP/HTTP headers, between {{param|BOMTime}} and + {{param|EOMTime}}. + + + + + + + + + + + The total number of {{units}} (at the IP layer) received on the + Interface between {{param|BOMTime}} and {{param|EOMTime}}. This MAY + be calculated by sampling Stats.BytesReceived on the + {{param|#.Interface}} object at {{param|BOMTime}} and at + {{param|EOMTime}} and subtracting. + + + + + + + + + + + The total number of {{units}} (at the IP layer) sent on the Interface + between {{param|BOMTime}} and {{param|EOMTime}}. This MAY be + calculated by sampling Stats.BytesSent on the {{param|#.Interface}} + object at {{param|BOMTime}} and at {{param|EOMTime}} and subtracting. + + + + + + + + + + + Request time in UTC, which MUST be specified to microsecond + precision. + + For example: 2008-04-09T15:01:05.123456Z + + * For HTTP this is the time at which the TCP socket open (SYN) was + sent for the HTTP connection. + + * For FTP this is the time at which the TCP socket open (SYN) was + sent for the data connection. + + + + + + + + + Response time in UTC, which MUST be specified to microsecond + precision. + + For example: 2008-04-09T15:01:05.123456Z + + * For HTTP this is the time at which the TCP ACK to the socket + opening the HTTP connection was received. + + * For FTP this is the time at which the TCP ACK to the socket opening + the data connection was received. + + + + + + + + + + Results for time segmented tests (tests where + {{param|#.TimeBasedTestDuration}} > 0 and + {{param|#.TimeBasedTestMeasurementInterval}} > 0). This data is + totaled across all connections in the test. A new object is created + every {{param|#.TimeBasedTestMeasurementInterval}} after that interval + has completed. Instance numbers MUST start at 1 and sequentially + increment as new instances are created. All instances are removed when + {{param|#.DiagnosticsState}} is set to + {{enum|Requested|#.DiagnosticsState}} or + {{enum|None|#.DiagnosticsState}}. + + + + + Change in the value of {{param|#.TestBytesReceivedUnderFullLoading}} + between {{param|StartTime}} and {{param|EndTime}}, measured in + {{units}}. + + + + + + + + + + + The total number of {{units}} (at the IP layer) received on the + Interface between {{param|StartTime}} and {{param|EndTime}}. This MAY + be calculated by sampling Stats.BytesReceived on the + {{param|#.Interface}} object at {{param|StartTime}} and at + {{param|EndTime}} and subtracting. If {{param|#.Interface}} is + {{empty}}, this parameter cannot be determined and SHOULD be 0. + + + + + + + + + + + The total number of {{units}} (at the IP layer) sent on the Interface + between {{param|StartTime}} and {{param|EndTime}}. This MAY be + calculated by sampling Stats.BytesSent on the {{param|#.Interface}} + object at {{param|StartTime}} and at {{param|EndTime}} and + subtracting. If {{param|#.Interface}} is {{empty}}, this parameter + cannot be determined and SHOULD be 0. + + + + + + + + + + + The start time of this interval which MUST be specified to + microsecond precision. + + For example: 2008-04-09T15:01:05.123456Z + + + + + + + + + The end time of this interval which MUST be specified to microsecond + precision. + + For example: 2008-04-09T15:01:05.123456Z + + + + + + + + + + Contains the array of hop results returned. If a route could not be + determined, this array will be empty + + + + + Result parameter indicating the Host Name if DNS is able to resolve + or IP Address of a hop along the discovered route. + + + + + + + + + + + If this parameter is not {{empty}} it will contain the last IP + address of the host returned for this hop and the {{param|Host}} will + contain the Host Name returned from the reverse DNS query. + + + + + + + + + Contains the error code returned for this hop. This code is directly + from the ICMP CODE field. + + + + + + + + + {{list}} Each list item contains one or more round trip times in + {{units}} (one for each repetition) for this hop. + + A list item of 0 indicates that the corresponding response was not + received. Round trip times of less than 1 {{units}} MUST be rounded + up to 1. + + The number of list entries is determined by the value of + {{param|#.NumberOfTries}}. + + + + + + + + + + + + + This object allows the CPE to be configured to perform the UDP Echo + Service defined in {{bibref|RFC862}} and UDP Echo Plus Service defined + in {{bibref|TR-143|Appendix A.1}}. + + + + + MUST be enabled to receive UDP echo. When enabled from a disabled + state all related timestamps, statistics and UDP Echo Plus counters + are cleared. + + + + + + + + + {{reference|IP-layer interface over which the CPE MUST listen and + receive UDP echo requests on}} + + The value of this parameter MUST be either a valid interface or + {{empty}}. An attempt to set this parameter to a different value MUST + be rejected as an invalid parameter value. + + If {{empty}} is specified, the CPE MUST listen and receive UDP echo + requests on all interfaces. + + Note: Interfaces behind a NAT MAY require port forwarding rules + configured in the Gateway to enable receiving the UDP packets. + + + + + + + + + + + + The Source IP address of the UDP echo packet. The CPE MUST only + respond to a UDP echo from this source IP address. + + + + + + + + + The UDP port on which the UDP server MUST listen and respond to UDP + echo requests. + + + + + + + + + If {{true}} the CPE will perform necessary packet processing for UDP + Echo Plus packets. + + + + + + + + + {{true}} if UDP Echo Plus is supported. + + + + + + + + + Incremented upon each valid UDP echo packet received. + + + + + + + + + Incremented for each UDP echo response sent. + + + + + + + + + The number of UDP received bytes including payload and UDP header + after the UDPEchoConfig is enabled. + + + + + + + + + The number of UDP responded bytes, including payload and UDP header + sent after the UDPEchoConfig is enabled. + + + + + + + + + Time in UTC, which MUST be specified to microsecond precision. + + For example: 2008-04-09T15:01:05.123456, + + The time that the server receives the first UDP echo packet after the + UDPEchoConfig is enabled. + + + + + + + + + Time in UTC, which MUST be specified to microsecond precision. + + For example: 2008-04-09T15:01:05.123456 + + The time that the server receives the most recent UDP echo packet. + + + + + + + + dmr:previousObject="Device.IP.Diagnostics.DownloadDiagnostics.IncrementalResult."> This object defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test. @@ -65878,464 +66337,6 @@ - - - Results for individual connections. This table is only populated when - {{param|#.EnablePerConnectionResults}} is {{true}}. A new object is - created for each connection specified in - {{param|#.NumberOfConnections}}. Instance numbers MUST start at 1 and - sequentially increment as new instances are created. All instances are - removed when {{param|#.DiagnosticsState}} is set to - {{enum|Requested|#.DiagnosticsState}} or - {{enum|None|#.DiagnosticsState}}. - - - - - Request time in UTC, which MUST be specified to microsecond - precision. - - For example: 2008-04-09T15:01:05.123456Z - - * For HTTP this is the time at which the client sends the GET - command. - - * For FTP this is the time at which the client sends the RTRV - command. - - - - - - - - - Begin of transmission time in UTC, which MUST be specified to - microsecond precision - - For example: 2008-04-09T15:01:05.123456Z - - * For HTTP this is the time at which the first data packet is - received. - - * For FTP this is the time at which the client receives the first - data packet on the data connection. - - - - - - - - - End of transmission in UTC, which MUST be specified to microsecond - precision. - - For example: 2008-04-09T15:01:05.123456Z - - * For HTTP this is the time at which the last data packet is - received. - - * For FTP this is the time at which the client receives the last - packet on the data connection. - - - - - - - - - The number of {{units}} of the test file received during the FTP/HTTP - transaction including FTP/HTTP headers, between {{param|BOMTime}} and - {{param|EOMTime}}. - - - - - - - - - - - The total number of {{units}} (at the IP layer) received on the - Interface between {{param|BOMTime}} and {{param|EOMTime}}. This MAY - be calculated by sampling Stats.BytesReceived on the - {{param|#.Interface}} object at {{param|BOMTime}} and at - {{param|EOMTime}} and subtracting. - - - - - - - - - - - The total number of {{units}} (at the IP layer) sent on the Interface - between {{param|BOMTime}} and {{param|EOMTime}}. This MAY be - calculated by sampling Stats.BytesSent on the {{param|#.Interface}} - object at {{param|BOMTime}} and at {{param|EOMTime}} and subtracting. - - - - - - - - - - - Request time in UTC, which MUST be specified to microsecond - precision. - - For example: 2008-04-09T15:01:05.123456Z - - * For HTTP this is the time at which the TCP socket open (SYN) was - sent for the HTTP connection. - - * For FTP this is the time at which the TCP socket open (SYN) was - sent for the data connection. - - - - - - - - - Response time in UTC, which MUST be specified to microsecond - precision. - - For example: 2008-04-09T15:01:05.123456Z - - * For HTTP this is the time at which the TCP ACK to the socket - opening the HTTP connection was received. - - * For FTP this is the time at which the TCP ACK to the socket opening - the data connection was received. - - - - - - - - - - Results for time segmented tests (tests where - {{param|#.TimeBasedTestDuration}} > 0 and - {{param|#.TimeBasedTestMeasurementInterval}} > 0). This data is - totaled across all connections in the test. A new object is created - every {{param|#.TimeBasedTestMeasurementInterval}} after that interval - has completed. Instance numbers MUST start at 1 and sequentially - increment as new instances are created. All instances are removed when - {{param|#.DiagnosticsState}} is set to - {{enum|Requested|#.DiagnosticsState}} or - {{enum|None|#.DiagnosticsState}}. - - - - - Change in the value of {{param|#.TestBytesReceivedUnderFullLoading}} - between {{param|StartTime}} and {{param|EndTime}}, measured in - {{units}}. - - - - - - - - - - - The total number of {{units}} (at the IP layer) received on the - Interface between {{param|StartTime}} and {{param|EndTime}}. This MAY - be calculated by sampling Stats.BytesReceived on the - {{param|#.Interface}} object at {{param|StartTime}} and at - {{param|EndTime}} and subtracting. If {{param|#.Interface}} is - {{empty}}, this parameter cannot be determined and SHOULD be 0. - - - - - - - - - - - The total number of {{units}} (at the IP layer) sent on the Interface - between {{param|StartTime}} and {{param|EndTime}}. This MAY be - calculated by sampling Stats.BytesSent on the {{param|#.Interface}} - object at {{param|StartTime}} and at {{param|EndTime}} and - subtracting. If {{param|#.Interface}} is {{empty}}, this parameter - cannot be determined and SHOULD be 0. - - - - - - - - - - - The start time of this interval which MUST be specified to - microsecond precision. - - For example: 2008-04-09T15:01:05.123456Z - - - - - - - - - The end time of this interval which MUST be specified to microsecond - precision. - - For example: 2008-04-09T15:01:05.123456Z - - - - - - - - - - Contains the array of hop results returned. If a route could not be - determined, this array will be empty - - - - - Result parameter indicating the Host Name if DNS is able to resolve - or IP Address of a hop along the discovered route. - - - - - - - - - - - If this parameter is not {{empty}} it will contain the last IP - address of the host returned for this hop and the {{param|Host}} will - contain the Host Name returned from the reverse DNS query. - - - - - - - - - Contains the error code returned for this hop. This code is directly - from the ICMP CODE field. - - - - - - - - - {{list}} Each list item contains one or more round trip times in - {{units}} (one for each repetition) for this hop. - - A list item of 0 indicates that the corresponding response was not - received. Round trip times of less than 1 {{units}} MUST be rounded - up to 1. - - The number of list entries is determined by the value of - {{param|#.NumberOfTries}}. - - - - - - - - - - - - - This object allows the CPE to be configured to perform the UDP Echo - Service defined in {{bibref|RFC862}} and UDP Echo Plus Service defined - in {{bibref|TR-143|Appendix A.1}}. - - - - - MUST be enabled to receive UDP echo. When enabled from a disabled - state all related timestamps, statistics and UDP Echo Plus counters - are cleared. - - - - - - - - - {{reference|IP-layer interface over which the CPE MUST listen and - receive UDP echo requests on}} - - The value of this parameter MUST be either a valid interface or - {{empty}}. An attempt to set this parameter to a different value MUST - be rejected as an invalid parameter value. - - If {{empty}} is specified, the CPE MUST listen and receive UDP echo - requests on all interfaces. - - Note: Interfaces behind a NAT MAY require port forwarding rules - configured in the Gateway to enable receiving the UDP packets. - - - - - - - - - - - - The Source IP address of the UDP echo packet. The CPE MUST only - respond to a UDP echo from this source IP address. - - - - - - - - - The UDP port on which the UDP server MUST listen and respond to UDP - echo requests. - - - - - - - - - If {{true}} the CPE will perform necessary packet processing for UDP - Echo Plus packets. - - - - - - - - - {{true}} if UDP Echo Plus is supported. - - - - - - - - - Incremented upon each valid UDP echo packet received. - - - - - - - - - Incremented for each UDP echo response sent. - - - - - - - - - The number of UDP received bytes including payload and UDP header - after the UDPEchoConfig is enabled. - - - - - - - - - The number of UDP responded bytes, including payload and UDP header - sent after the UDPEchoConfig is enabled. - - - - - - - - - Time in UTC, which MUST be specified to microsecond precision. - - For example: 2008-04-09T15:01:05.123456, - - The time that the server receives the first UDP echo packet after the - UDPEchoConfig is enabled. - - - - - - - - - Time in UTC, which MUST be specified to microsecond precision. - - For example: 2008-04-09T15:01:05.123456 - - The time that the server receives the most recent UDP echo packet. - - - - - - - @@ -66612,9 +66613,141 @@ + + + This object provides the results from individual UDPEchoPlus test + packets collected during a test if + {{param|#.EnableIndividualPacketResults}} is set to true. When + {{param|#.DiagnosticsState}} is set to + {{enum|Complete|#.DiagnosticsState}} it should contain + {{param|#.NumberOfRepetitions}} objects. Instance numbers MUST start at + 1 and sequentially increment as new instances are created. The instance + number should match the TestIterationNumber field of the request and + response packet. All instances are removed when + {{param|#.DiagnosticsState}} is set to + {{enum|Requested|#.DiagnosticsState}} or + {{enum|None|#.DiagnosticsState}}. + + + + + Indicates that the response to this UDP Echo Plus packet sent was + received by the client. When this value is {{true}}, then all the + remaining parameters in this instance are valid. Otherwise only the + values originally set by the CPE client (e.g. + {{param|PacketSendTime}} and {{param|TestGenSN}}) MAY be set to valid + values. + + + + + + + + + Time the client sent this UDP Echo Plus packet in UTC, which MUST be + specified to microsecond precision. + + For example: 2008-04-09T15:01:05.123456Z + + + + + + + + + Time the client receives the response packet in UTC, which MUST be + specified to microsecond precision. + + For example: 2008-04-09T15:01:05.123456Z + + If this response is never received, {{param}} SHOULD be set to the + Unknown Time value as specified in {{bibref|TR-106|Section 3.2.2}}. + + + + + + + + + The TestGenSN field in the UDPEcho Plus packet + {{bibref|TR-143|Section A.1.4}} sent by the CPE client. + + + + + + + + + The TestRespSN field in the response packet {{bibref|TR-143|Section + A.1.4}} from the UDP Echo Plus server (i.e. {{param|#.Host}}) for + this Echo Plus packet sent by the CPE client. If + {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. + + + + + + + + + The TestRespRcvTimeStamp field in the response packet + {{bibref|TR-143|Section A.1.4}} from the UDP Echo Plus server (i.e. + {{param|#.Host}}) to record the reception time in {{units}} of this + UDP Echo Plus packet sent from the CPE client. If + {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. + + + + + + + + + + + The TestRespReplyTimeStamp field in the response packet + {{bibref|TR-143|Section A.1.4}} from the UDP Echo Plus server (i.e. + {{param|#.Host}}) to record the server reply time in {{units}} of + this UDP Echo Plus packet sent from the CPE client. + + That is, the time that the server returned the UDP Echo Plus packet. + If {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. + + + + + + + + + + + The count value that was set by the UDP Echo Plus server (i.e. + {{param|#.Host}}) to record the number of dropped echo response + packets by the server. This count is incremented if a valid echo + request packet is received at a UDP EchoPlus server but for some + reason cannot be responded to (e.g. due to local buffer overflow, CPU + utilization, etc...). If {{param|PacketSuccess}} is {{false}}, + {{param}} SHOULD be 0. + + + + + + + This object defines the diagnostics configuration for a IP Layer @@ -68392,138 +68525,6 @@ - - - This object provides the results from individual UDPEchoPlus test - packets collected during a test if - {{param|#.EnableIndividualPacketResults}} is set to true. When - {{param|#.DiagnosticsState}} is set to - {{enum|Complete|#.DiagnosticsState}} it should contain - {{param|#.NumberOfRepetitions}} objects. Instance numbers MUST start at - 1 and sequentially increment as new instances are created. The instance - number should match the TestIterationNumber field of the request and - response packet. All instances are removed when - {{param|#.DiagnosticsState}} is set to - {{enum|Requested|#.DiagnosticsState}} or - {{enum|None|#.DiagnosticsState}}. - - - - - Indicates that the response to this UDP Echo Plus packet sent was - received by the client. When this value is {{true}}, then all the - remaining parameters in this instance are valid. Otherwise only the - values originally set by the CPE client (e.g. - {{param|PacketSendTime}} and {{param|TestGenSN}}) MAY be set to valid - values. - - - - - - - - - Time the client sent this UDP Echo Plus packet in UTC, which MUST be - specified to microsecond precision. - - For example: 2008-04-09T15:01:05.123456Z - - - - - - - - - Time the client receives the response packet in UTC, which MUST be - specified to microsecond precision. - - For example: 2008-04-09T15:01:05.123456Z - - If this response is never received, {{param}} SHOULD be set to the - Unknown Time value as specified in {{bibref|TR-106|Section 3.2.2}}. - - - - - - - - - The TestGenSN field in the UDPEcho Plus packet - {{bibref|TR-143|Section A.1.4}} sent by the CPE client. - - - - - - - - - The TestRespSN field in the response packet {{bibref|TR-143|Section - A.1.4}} from the UDP Echo Plus server (i.e. {{param|#.Host}}) for - this Echo Plus packet sent by the CPE client. If - {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. - - - - - - - - - The TestRespRcvTimeStamp field in the response packet - {{bibref|TR-143|Section A.1.4}} from the UDP Echo Plus server (i.e. - {{param|#.Host}}) to record the reception time in {{units}} of this - UDP Echo Plus packet sent from the CPE client. If - {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. - - - - - - - - - - - The TestRespReplyTimeStamp field in the response packet - {{bibref|TR-143|Section A.1.4}} from the UDP Echo Plus server (i.e. - {{param|#.Host}}) to record the server reply time in {{units}} of - this UDP Echo Plus packet sent from the CPE client. - - That is, the time that the server returned the UDP Echo Plus packet. - If {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. - - - - - - - - - - - The count value that was set by the UDP Echo Plus server (i.e. - {{param|#.Host}}) to record the number of dropped echo response - packets by the server. This count is incremented if a valid echo - request packet is received at a UDP EchoPlus server but for some - reason cannot be responded to (e.g. due to local buffer overflow, CPU - utilization, etc...). If {{param|PacketSuccess}} is {{false}}, - {{param}} SHOULD be 0. - - - - - - - @@ -92507,44 +92508,6 @@ - - - This diagnostics test is vendor-specific and MAY include testing - hardware, software, and/or firmware. - - - - - {{datatype|expand}} - - - - - - - - - - - - - - - - Results of self-test (vendor specific). - - - - - - - - - @@ -118296,6 +118259,43 @@ + + + This diagnostics test is vendor-specific and MAY include testing + hardware, software, and/or firmware. + + + + + {{datatype|expand}} + + + + + + + + + + + + + + + + Results of self-test (vendor specific). + + + + + + + + + @@ -120015,8 +120015,9 @@ The following describes the meaning of the permissions for Object type of Targets: - # Read: Grants the capability to read the meta-information of the - Object via GetSupportedDM. + # Read: Grants the capability for Get to resolve Object paths. Grants + the capability to read the meta-information of the Object via + GetSupportedDM. # Write: Grants no capabilities for Static Objects. Grants the capability to create a new instance of a Multi-Instanced Object via diff --git a/test/tools/01-tr-181-2-19-0-usp-full.xml b/test/tools/01-tr-181-2-19-1-usp-full.xml similarity index 99% rename from test/tools/01-tr-181-2-19-0-usp-full.xml rename to test/tools/01-tr-181-2-19-1-usp-full.xml index b8ab2d18..d28a246a 100644 --- a/test/tools/01-tr-181-2-19-0-usp-full.xml +++ b/test/tools/01-tr-181-2-19-1-usp-full.xml @@ -59,8 +59,8 @@ https://www.broadband-forum.org/cwmp/cwmp-datamodel-1-15.xsd urn:broadband-forum-org:cwmp:datamodel-report-1-0 https://www.broadband-forum.org/cwmp/cwmp-datamodel-report-1-0.xsd" - spec="urn:broadband-forum-org:tr-181-2-19-0-usp" - file="tr-181-2-19-0-usp.xml"> + spec="urn:broadband-forum-org:tr-181-2-19-1-usp" + file="tr-181-2-19-1-usp.xml"> @@ -129298,8 +129298,9 @@ The following describes the meaning of the permissions for Object type of Targets: - # Read: Grants the capability to read the meta-information of the - Object via GetSupportedDM. + # Read: Grants the capability for Get to resolve Object paths. Grants + the capability to read the meta-information of the Object via + GetSupportedDM. # Write: Grants no capabilities for Static Objects. Grants the capability to create a new instance of a Multi-Instanced Object via diff --git a/test/tools/04-tr-135-1-4-1-cwmp-full.xml b/test/tools/04-tr-135-1-4-1-cwmp-full.xml deleted file mode 100644 index 935262b3..00000000 --- a/test/tools/04-tr-135-1-4-1-cwmp-full.xml +++ /dev/null @@ -1,8125 +0,0 @@ - - - - - - {{docname|STBService:1.4 for CWMP}} - {{appdate|September 2019}} - {{trname|TR-135a3}} - August 2015: {{xmlref|tr-135-1-4-0|Original}} - * Added objects for Service Monitoring of Events - September 2019: {{xmlref|tr-135-1-4-1-cwmp|Corrigendum 1}} - * Added USP support (split XML into common, CWMP and USP files) - - - - A non-volatile handle used to reference this instance. - '''This is intended only for use in protocol-independent "common" definitions, and MUST NOT be used in protocol-specific definitions.''' - - - - - - - - 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 {{bibref|TR-069|3.6.1}} and described in {{bibref|TR-069|Appendix II}}, 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. - - - - - - 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. - - - - - - The value is measured in ''dBm/1000'', i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm. - - - - - - - Indicates the availability of diagnostics data. Enumeration of: - {{enum}} - If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are {{enum|Requested}} and {{enum|Canceled}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to {{enum|Requested}}. - When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. - When the test is completed, the value of this parameter MUST be either {{enum|Complete}} (if the test completed successfully), or one of the ''Error'' values listed above. - If the value of this parameter is anything other than {{enum|Complete}}, the values of the results parameters for this test are indeterminate. - When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code ''8 DIAGNOSTICS COMPLETE'' in the Inform message. - After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}. - Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}}. - While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}}. - While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. - While the test is in progress, setting this parameter to {{enum|Canceled}} MUST result in the test being canceled and the value of this parameter being set to {{enum|None}}. If the CPE does not support the {{enum|Canceled}} value, it MUST return a SPV error with "Invalid Parameter value" (9007) to the ACS instead. - - - - - - - - - - - - The IEEE EUI 64-bit identifier as defined in {{bibref|IEEE_EUI64}}. The IEEE defined 64-bit extended unique identifier (EUI-64) is a concatenation of: - * The 24-bit (OUI-24) or 36-bit (OUI-36) company_id value assigned by the IEEE Registration Authority (IEEE-RA), and - * The extension identifier (40 bits for OUI-24 or 28 bits for OUI-36) assigned by the organization with that company_id assignment. - - - - - - - - - - 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 {{bibref|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 {{bibref|RFC4007|Section 6}}. - Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be represented as empty strings unless otherwise specified by the parameter definition. - - - - - - - - IPv4 address (or subnet mask). - Can be any IPv4 address that is permitted by the ''IPAddress'' data type. - - - - - - - - IPv6 address. - Can be any IPv6 address that is permitted by the ''IPAddress'' data type. - - - - - - IPv4 or IPv6 routing prefix in Classless Inter-Domain Routing (CIDR) notation {{bibref|RFC4632}}. This is specified as an IP address followed by an appended "/n" suffix, where ''n'' (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the routing prefix. - * IPv4 example: 192.168.1.0/24 - * IPv6 example: 2001:edff:fe6a:f76::/64 - If the IP address part is unspecified or inapplicable, it MUST be {{empty}} unless otherwise specified by the parameter definition. In this case the IP prefix will be of the form "/n". - If the entire IP prefix is unspecified or inapplicable, it MUST be {{empty}} unless otherwise specified by the parameter definition. - - - - - - - - IPv4 address prefix. - Can be any IPv4 prefix that is permitted by the ''IPPrefix'' data type. - - - - - - - - - IPv6 address prefix. - Can be any IPv6 prefix that is permitted by the ''IPPrefix'' data type. - - - - - - A JSON Object as defined in {{bibref|RFC7159|Section 4}}. - - - - - - - All MAC addresses are represented as strings of 12 hexadecimal digits (digits 0-9, letters A-F or a-f) displayed as six pairs of digits separated by colons. Unspecified or inapplicable MAC addresses MUST be represented as empty strings unless otherwise specified by the parameter definition. - - - - - - - - - - A 32-bit statistics parameter, e.g. a byte counter. - This data type SHOULD NOT be used for statistics parameters whose values might become greater than the maximum value that can be represented as an ''unsignedInt'' (i.e. 0xffffffff, referred to below as ''maxval''). ''StatsCounter64'' SHOULD be used for such parameters. - The value ''maxval'' indicates that no data is available for this parameter. In the unlikely event that the actual value of the statistic is ''maxval'', the CPE SHOULD return ''maxval - 1''. - The actual value of the statistic might be greater than ''maxval''. Such values SHOULD wrap around through zero. - The term ''packet'' is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame. - - - - - - - A 64-bit statistics parameter, e.g. a byte counter. - This data type SHOULD be used for all statistics parameters whose values might become greater than the maximum value that can be represented as an ''unsignedInt''. - The maximum value that can be represented as an ''unsignedLong'' (i.e. 0xffffffffffffffff) indicates that no data is available for this parameter. - The term ''packet'' is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame. - - - - - - - Universally Unique Identifier. See {{bibref|RFC4122}}. - - - - - - - - - Uniform Resource Identifier. See {{bibref|RFC3986}}. - - - - - - - - Uniform Resource Name. See {{bibref|RFC3986}} (URI) and {{bibref|RFC8141}} (''urn'' URI scheme). - - - - - - - Uniform Resource Locator. See {{bibref|RFC3986}} (URI), {{bibref|IANA-uri-schemes}}, and individual URI scheme RFCs such as {{bibref|RFC7252}} (''coap'', ''coaps'') and {{bibref|RFC7230}} (''http'', ''https''). - - - - - - The ZigBee 16-bit network address (NWK) as defined in {{bibref|ZigBee2007}}. The address is assigned to a device by the network layer and used by the network layer for routing messages between devices. - - - - - - - - - - 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 {{bibref|TR-069|3.6.1}} and described in {{bibref|TR-069|Appendix II}}, 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. - - - - - - E-AC-3 - Digital Audio Compression (AC-3) Standard, Rev. B, document number A/52B - ATSC - June 2005 - - - DGTVi D-Book v1.0 - Compatible receivers for the Italian market - Sep 2004 - - - HDMI - High-Definition Multimedia Interface 1.4a - March 2010 - - - 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/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/IEC 13818-1 (2nd edition, 2000) - Information technology - Generic coding of moving picture and associated audio information: Systems - ISO/IEC - 2000 - - - ISO/IEC 13818-3 (2nd edition, 1998) - Information technology - Generic coding of moving picture and associated audio information: Audio - ISO/IEC - 1998 - - - 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/IEC 14496-3:2001 - Information technology - Coding of Audio-Visual objects - Part 3: Audio - ISO/IEC - 2001 - - - 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/IEC 23003-1:2007 - Information technology - MPEG audio technologies - Part 1: MPEG Surround - ISO/IEC - 2007 - - - RFC 1350 - The TFTP Protocol (Revision 2) - IETF - RFC - https://tools.ietf.org/html/rfc1350 - - - RFC 2228 - FTP Security Extensions - IETF - RFC - https://tools.ietf.org/html/rfc2228 - - - RFC 2326 - Real Time Streaming Protocol (RTSP) - IETF - RFC - https://tools.ietf.org/html/rfc2326 - - - RFC 2960 - Stream Control Transmission Protocol (SCTP) - IETF - RFC - https://tools.ietf.org/html/rfc2960 - - - RFC 3066 - Tags for the Identification of Languages - IETF - RFC - https://tools.ietf.org/html/rfc3066 - - - RFC 3376 - Internet Group Management Protocol (IGMP) Version 3 - IETF - RFC - https://tools.ietf.org/html/rfc3376 - - - RFC 3550 - RTP: A Transport Protocol for Real-Time Applications - IETF - RFC - July 2003 - https://tools.ietf.org/html/rfc3550 - - - RFC 4078 - The TV-Anytime Content Reference Identifier (CRID) - IETF - RFC - https://tools.ietf.org/html/rfc4078 - - - RFC 4122 - A Universally Unique IDentifier (UUID) URN Namespace - IETF - RFC - 2005 - https://tools.ietf.org/html/rfc4122 - - - RFC 4340 - Datagram Congestion Control Protocol (DCCP) - IETF - RFC - https://tools.ietf.org/html/rfc4340 - - - RFC 4585 - Extended RTP Profile for Real-time Transport Control Protocol (RTCP)-Based Feedback (RTP/AVPF) - IETF - RFC - https://tools.ietf.org/html/rfc4585 - - - RFC 4588 - RTP Retransmission Packet Format - IETF - RFC - https://tools.ietf.org/html/rfc4588 - - - SMPTE 20022-1 Application Layer Forward Error Correction - - - Simple Object Access Protocol (SOAP) 1.1 - W3C - https://www.w3.org/TR/2000/NOTE-SOAP-20000508 - - - S/PDIF - Sony/Philips Digital InterFace IEC-958 - IEC - - - SSH File Transfer Protocol - https://tools.ietf.org/wg/secsh/draft-ietf-secsh-filexfer - - - TR-106 Amendment 1 - Data Model Template for TR-069-Enabled Devices - Broadband Forum - Technical Report - November 2006 - https://www.broadband-forum.org/technical/download/TR-106_Amendment-1.pdf - - - TR-106 Amendment 8 - Data Model Template for CWMP Endpoints and USP Agents - Broadband Forum - Technical Report - May 2018 - https://www.broadband-forum.org/technical/download/TR-106_Amendment-8.pdf - - - TR-135 Amendment 3 - Data Model for a TR-069 Enabled STB - Broadband Forum - Technical Report - November 2012 - https://www.broadband-forum.org/technical/download/TR-135.pdf - - - TR-140 - TR-069 Data Model for Storage Service Devices - Broadband Forum - Technical Report - https://www.broadband-forum.org/technical/download/TR-140.pdf - - - ETSI TS 102 034 - Digital Video Broadcasting (DVB); Transport of MPEG-2 Based DVB Services - ETSI - - - ETSI TS 102 323 - Digital Video Broadcasting (DVB); Carriage and signalling of TV-Anytime information - in DVB transport streams - ETSI - - - SMPTE VC-1 - Compressed Video Bitstream Format and Decoding Process, document number 421M - SMPTE, Television - 2006 - - - - - - Number of entries in the {{object|STBService}} table. - - - - - - - - The top-level object for an STB CPE. - - - - - - - Enables or disables this {{object}} instance. - - - - - - - - {{datatype|expand}} - - - - - - - - - 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. - - - - Maximum number of simultaneously active AV streams supported by the STB. - A value of -1 indicates no specific limit on the number of active streams. - A value of 0, while not strictly illegal, would indicate an STB that doesn't support AV streams, which is extremely unlikely. - - - - - - - - - - Maximum number of simultaneously active AV players supported by the STB. An AV player is associated with a presentation device (such as a TV set). - Note that this is the strict maximum but, depending on the AV streams to be decoded, a given STB may not always have the resources to run all of these AV players, e.g. it might be able to decode one main picture and one PIP in standard definition, but just a main picture and no PIP in high definition. - A value of -1 indicates no specific limit on the number of active players. - A value of 0, while not strictly illegal, would indicate an STB that doesn't support AV players, which is extremely unlikely. - - - - - - - - - - - Front-end capabilities. - - - - - Capabilities of the DVB-T receiver. - - - - Maximum number of simultaneous active AV streams supported by the DVB-T FrontEnd. - A value of -1 indicates no specific limit on the number of active streams. - - - - - - - - - - Maximum number of logical channels that can be contained in a Service List Database. - A value of -1 indicates no specific limit on the number of logical channels. - - - - - - - - - - - IP front-end capabilities. - - - - Maximum number of simultaneous active AV streams supported by the IP FrontEnd. - A value of -1 indicates no specific limit on the number of active streams. - - - - - - - - - - Maximum number of simultaneous active Inbound AV streams supported by the IP FrontEnd. - A value of -1 indicates no specific limit on the number of active streams. - - - - - - - - - - Maximum number of simultaneous active Outbound AV streams supported by the IP FrontEnd. - A value of -1 indicates no specific limit on the number of active streams. - - - - - - - - - - Supported streaming control protocols. - - - - - - - supports RTSP {{bibref|RFC2326}} - - - - - supports IGMPv1 {{bibref|RFC3376}} - - - - - supports IGMPv2 and lower versions {{bibref|RFC3376}} - - - - - supports IGMPv3 and lower versions {{bibref|RFC3376}} - - - - - supports DSM-CC {{bibref|ISO/IEC13818-6}} - - - - - - - - Network protocols supported for AV streaming. - - - - - - - - - {{bibref|RFC2960}} - - - - - {{bibref|RFC4340}} - - - - - {{bibref|RFC3550}} - - - - - - - - - Transport control protocols supported for AV streaming in combination with RTP. - - - - - - - supports sending RTCP receiver reports as defined in {{bibref|RFC3550}} - - - - - as defined in {{bibref|RFC4585}} and {{bibref|RFC4588}} - - - - - as defined in {{bibref|SMPTE20022-1}} - - - - - - - - Network protocols supported for AV download. - - - - - - - - - - FTP/SSL {{bibref|RFC2228}} - - - - - SSH file transfer protocol {{bibref|SSH-FTP}} - - - - - {{bibref|RFC1350}} - - - - - - - - AV multiplex types supported by the front end. - - - - - - - - {{bibref|ISO/IEC11172-1}} - - - - - {{bibref|ISO/IEC13818-1}} - - - - - {{bibref|ISO/IEC13818-1}} - - - - - {{bibref|ISO/IEC13818-1}} - - - - - - - - Describes the maximum de-jittering buffer size, in {{units}}, supported by the STB. - A value of -1 indicates no specific limit on the buffer size. - - - - - - - - - - - - PVR capabilities. - - - - Maximum number of AV streams that the PVR can simultaneously record and playback. For example a time shift, consisting of a record and a play back is considered as 2 streams. - A value of -1 indicates no specific limit on the number of streams. - - - - - - - - - - Maximum number of AV streams that the PVR can simultaneously record. - A value of -1 indicates no specific limit on the number of streams. - - - - - - - - - - Maximum number of AV streams that the PVR can simultaneously play back. - A value of -1 indicates no specific limit on the number of streams. - - - - - - - - - - Maximum time delay, in {{units}}, that the PVR time-shift mode can support. - A value of -1 indicates no specific limit on the time delay. - - - - - - - - - - - - Audio decoder capabilities. - - - - Audio standards supported by this STB. - - - - - - - {{bibref|ISO/IEC11172-3}} - - - - - {{bibref|ISO/IEC11172-3}} - - - - - {{bibref|ISO/IEC13818-3}} - - - - - {{bibref|ISO/IEC13818-3}} - - - - - - - - Low Complexity {{bibref|ISO/IEC13818-3}} - - - - - Low Complexity {{bibref|ISO/IEC14496-3}} - - - - - Main Profile {{bibref|ISO/IEC14496-3}} - - - - - Scalable AAC {{bibref|ISO/IEC14496-3}} - - - - - High Efficiency Profile Level 2 {{bibref|ISO/IEC14496-3}} - - - - - {{bibref|ISO/IEC23003-1}} - - - - - Dolby Digital (AC-3) {{bibref|AC-3}} - - - - - Dolby Digital Plus {{bibref|AC-3}} - - - - - Digital Theatre System - - - - - - - - - - Video decoder capabilities. - - - - Video standards supported by this STB. - - - - - - - {{bibref|ISO/IEC13818-1}} - - - - - {{bibref|ISO/IEC13818-6}} - - - - - Same as MPEG4 AVC and H.264 {{bibref|ISO/IEC14496-10}} - - - - - {{bibref|VC-1}} - - - - - - - - - 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. - - - - Audio Standards supported by the Player when associated with MPEG2 Part 2 Video. - - - - - - - - - - - Number of instances of {{object|ProfileLevel}}. - - - - - - - - - Table to describe the set of profiles and levels combinations supported by the STB when MPEG2 Part 2 is used as video standard. - {{keys}} The table MUST include a distinct entry for each supported combination of these parameters. - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Identifier of the MPEG2 Part 2 profile. - - - - - - Simple Profile - - - - - Main Profile - - - - - SNR Scalable - - - - - Spatially Scalable - - - - - High Profile - - - - - - - - - Identifier of the MPEG2 part 2 level. - - - - - - Low Level - - - - - Main Level - - - - - High-1440 - - - - - High Level - - - - - - - - The maximum decoding capability for this video standard in {{units}}. This strictly depends on the profile and level selected. - - - - - - - - - - - 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. - - - - Audio Standards supported by the Player when associated with MPEG4 Part 2 video. - - - - - - - - - - - Number of instances of {{object|ProfileLevel}}. - - - - - - - - - Table to describe the set of profiles and levels combinations supported by the STB when MPEG4 Part 2 is used as video standard. - {{keys}} The table MUST include a distinct entry for each supported combination of these parameters. - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Identifier of the MPEG4 Part 2 profile. - - - - - - - - - - - - - - - - - - - - - - - - - - - - Identifier of the MPEG4 Part 2 level. - - - - - - - - - - - - - - - - - The maximum decoding capability for this video standard in {{units}}. This strictly depends on the profile and level selected. - - - - - - - - - - - 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. - - - - Audio Standards supported by the Player when associated with MPEG4 Part 10 video. - - - - - - - - - - - Number of instances of {{object|ProfileLevel}}. - - - - - - - - - Table to describe the set of profiles and levels combinations supported by the STB when MPEG4 Part 10 is used as video standard. - {{keys}} The table MUST include a distinct entry for each supported combination of these parameters. - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Supported MPEG4 Part 10 profiles. - - - - - - - - - - - - - - - - - Supported MPEG4 Part 10 Levels. - - - - - - - - - - - - - - - - - - - - - - - - - - The maximum decoding capability for this video standard in {{units}}. This strictly depends on the profile and level selected. - - - - - - - - - - - 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. - - - - Audio Standards supported by the Player when associated with SMPTE-VC-1 video. - - - - - - - - - - - Number of instances of {{object|ProfileLevel}}. - - - - - - - - - Table to describe the set of profiles and levels combinations supported by the STB when SMPTE-VC-1 is used as video standard. - {{keys}} The table MUST include a distinct entry for each supported combination of these parameters. - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Identifier of the SMPTE-VC-1 profile. - - - - - - Simple Profile - - - - - Main Profile - - - - - Advanced Profile - - - - - - - - Identifier of the SMPTE-VC-1 level. - - - - - - Low Level - - - - - Medium Level - - - - - High Level - - - - - Advanced Profile only - - - - - Advanced Profile only - - - - - Advanced Profile only - - - - - Advanced Profile only - - - - - Advanced Profile only - - - - - - - - The maximum decoding capability for this video standard in {{units}}. This strictly depends on the profile and level selected. - - - - - - - - - - - Audio output capabilities. The audio output stage may include selecting output formats, selecting output connectors, and copy protection. - - - - Supported audio output formats. {{enum}} - Note that these refer to supported output formats and not to physical connectors. - - - - - - - - - - - - - modulated analog signals on coax - - - - - - - - - Video output capabilities. The video output stage may include selecting output formats, selecting output connectors, and copy protection. - - - - Analog composite video standards supported for video output. This applies only to CVBS video output. - - - - - - - - - - - - - - - - - - - - - - - - - - Supported video output formats. {{enum}} - Note that these refer to supported output formats and not to physical connectors. - - - - - - - - same as Y/C - - - - - - RGB with Sync on Green - - - - - RGB with external Sync - - - - - - - modulated analog signals on coax - - - - - - - - Supported version of Macrovision digital content protection standard. - - - - - - - - - - Supported version of HDCP digital content protection standard. - - - - - - - - - - Each entry is a supported display format and MUST be in the form of “x:y”, such as for example “4:3, 16:9, 14:9". {{nopattern}} - - - - - - - {{nopattern}} - - - - - - - - - This object describes the characteristics of the HDMI interface, if any. - - - - Video resolutions supported for the HDMI video output. {{enum}} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Indicates whether the STB is supporting HDMI-CEC features as described in {{bibref|HDMI}}. - - - - - - - - Indicates whether the STB is supporting the 3D video formats mandated by {{bibref|HDMI}}. - - - - - - - - - This object describes the characteristics of the Content Download System, if any. - - - - Capability of providing a CDS Push service for the operator initiated download of content items to local storage via a broadband IP connection. - - - - - - - - Capability of providing a CDS Pull service for the user initiated download of content items to a local storage via a broadband IP connection. - - - - - - - - - This object describes the characteristics of the Conditional Access, if any. - - - - Unique identifiers (e.g. commercial names) of supported CA systems. - - - - - - - - - - - - This object describes the characteristics of the Digital Rights Management, if any. - - - - Unique identifiers (e.g. commercial names) of supported DRM systems. - - - - - - - - - - - - This object describes the capabilities of the {{object|.ServiceMonitoring}} object. - - - - Supported service types, each of which relates to an AV stream source. {{enum}} - Note that none of the standard service types cover LAN-sourced IP streams. - - - - - - - WAN-sourced IPTV stream - - - - - WAN-sourced VoD stream - - - - - WAN-sourced IP stream (includes IPTV and VoD - - - - - WAN-sourced Force monitoring IP stream from {{param|.Components.FrontEnd.{i}.IP.ForceMonitor.URI}} (either IPTV or VoD). - - - - - Any WAN-sourced IP stream (includes user and force monitoring streams, IPTV and VoD). - - - - - Cable, e.g. DVB-C, Front End stream - - - - - DTT, e.g. DVB-T, Front End stream - - - - - Satellite, e.g. DVB-S, Front End stream - - - - - PVR play-out stream - - - - - - - - Maximum number of events of each applicable statistic that the STB is able to store for each sample interval. - A value of -1 indicates no specific maximum number of events. - - - - - - - - - - - Maximum number of AV Main streams for which the STB can simultaneously collect statistics. - A value of -1 indicates no specific limit on the number of active streams. - - - - - - - - - - Minimum sample interval in {{units}} that the STB MUST be able to support. - A value of -1 indicates no specific minimum sample interval. - - - - - - - - - - - Maximum number of samples of each statistic that the STB is able to store and report. - A value of -1 indicates no specific maximum number of samples. - - - - - - - - - - The names of the supported high-level metrics. If a metric produces several different scores (e.g. an audio, a video, and an audiovisual score), then they MUST be explicitly named. Example (using "XYZ" as the name of the base metric): - "XYZAudio,XYZVideo,XYZAudiovisual". - - - - - - - - - - - Maximum number of event log entries that the STB is able to record for a MainStream object instance. - - - - - - - - - This object describes the capabilities of the {{object|.Applications.AudienceStats}} object. - - - - Maximum number of channels that the STB MUST support in the {{object|.Applications.AudienceStats}} object - A value of -1 indicates no specific limit on the number of channels. - - - - - - - - - - - Details of STB logical or physical internal components. Unlike the {{object|.Capabilities}} object, which is read-only and which doesn't describe individual instances, this object contains some writeable parameters. - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - - 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). - - - - - - - - - - Enables or disables this front-end. - - - - - - - - The status of this front-end. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this front-end. - - - - - - - - - - - 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 {{bibref|D-Book}}. - - - - - DVB-T modulation details. - - - - Indicates the current frequency in {{units}}. - The value of this parameter is undefined while installing the service list (see {{object|.Components.FrontEnd.{i}.DVBT.Install}}). - - - - - - - - - - Indicates the channel bandwidth in use. - - - - - - - - - - - - Indicates the current constellation in use. - - - - - - - - - - - - Hierarchical parameter alpha. The higher the value of alpha, the more noise-immune the High Priority Modulation is. - - - - - - no hierarchy - - - - - - - - - - - Indicates the current code rate in use. Code rate applies to HP in case of hierarchical coding. - - - - - - - - - - - - - - Indicates the current code rate in use. Code rate applies to LP in case of hierarchical coding. - - - - - - Coding is not hierarchical - - - - - - - - - - - - - Indicates the current guard interval in use. - - - - - - - - - - - - - Indicates the number of carriers in an OFDM frame. - - - - - - - - - - - Signal/Noise ratio in the carrier band, measured in {{units}}. - - - - - - - - - - Bit Error Ratio before correction, expressed in multiples of 1e-6. - - - - - - - - Bit Error Ratio after correction, expressed in multiples of 1e-9. - - - - - - - - Indicates whether or not the tuner is locked on a frequency. - - - - - - - - - DVB-T Current service details. - - - - It represents the logical channel object instance for the current service, For example: ''.Components.FrontEnd.1.DVBT.-ServiceListDatabase.LogicalChannel.12''. - - - - - - - - - - - It represents the service object instance for the current service. For example: ''.Components.FrontEnd.1.DVBT.ServiceListDatabase.LogicalChannel.12.Service.1''. - - - - - - - - - - - - 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 {{object|.Components.FrontEnd.{i}.DVBT.ServiceListDatabase}}. - - - - Starts (when set to {{true}}) or stops (when set to {{false}}) scanning for services. The value is not saved in device state and is always {{false}} when read. - Discovered services are merged with those already present in the service list database. This supports cases where the frequency spectrum is not continuous. - In order to force a re-install, the service list database needs to be reset (see {{param|.Components.FrontEnd.{i}.DVBT.ServiceListDatabase.Reset}}). - - - - - - - - Indicates the status of the scanning process. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - scanning is not in progress - - - - - scanning is in progress - - - - - - - - - Progression in {{units}} of the current scan. The value is undefined when a scan is not in progress. - - - - - - - - - - - Frequency (in {{units}}) at which to start the scanning process. - - - - - - - - - - Frequency (in {{units}}) at which to stop the scanning process. - - - - - - - - - - - DVB-T service list database. - - - - Total number of services defined in the service list database, i.e. the number of different DvbIds in the database. - - - - - - - - Number of logical channels in the service list database. - - - - - - - - When set to {{true}}, resets the service list database. Setting it to {{false}} has no effect. The value is not saved in device state and is always {{false}} when read. - - - - - - - - - DVB-T logical channel information. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Logical channel number. - - - - - - - - Number of services associated with this logical channel. - - - - - - - - - DVB-T service information. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this service, e.g. read from the DVB service information metadata. - - - - - - - - - - DVB Triplet {{bibref|TS102034}} that uniquely identifies the service in the service list database. - The DVB Triplet is a 12-byte string that is a concatenation of 4 hexadecimal characters for each of the following: Original Network Id, Transport Stream Id, Service Id. For example: - * OriginalNetworkId = 8442 = 0x20FA - * TransportStreamId = 4 = 0x0004 - * ServiceId = 257 = 0x0101 - -> DvbId = ''20FA00040101'' - - - - - - - - - - Transmitter frequency (in {{units}}) for this service. - - - - - - - - - - Bit Error Ratio before correction, expressed in multiples of 1e-6 (indicates the quality of this service). - - - - - - - - Bit Error Ratio after correction, expressed in {{units}} (indicates the quality of this service). - - - - - - - - - - Signal/Noise ratio in the carrier band, measured in {{units}} (indicates the quality of this service). - - - - - - - - - - When set to {{true}}, identifies this as the preferred service for this logical channel and automatically sets {{param}} to {{false}} for other services associated with this logical channel. - When set to {{false}}, cancels this service's preferred status and causes the service with the lowest {{param|BER}} (best received quality) to become the preferred service for this logical channel. - Whenever frequencies are re-scanned, all {{param}} parameters are implicitly reset to {{false}}, i.e. a re-scan will always use the {{param|BER}} to determine preferred services, and will discard any past explicit overrides. - - - - - - - - - Connect to a DVB-T logical channel. - - - - Logical channel number to connect to (the logical channel's preferred service will be connected to). - If a {{object|.ServiceMonitoring.MainStream}} instance with ''ServiceType'' = ''DTT'' is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance. - The value is not saved in device state. The value when read is not specified and need not be the value that was most recently written. - - - - - - - - - Connect to a DVB-T service. - - - - DvbId of the service to connect to. - If a {{object|.ServiceMonitoring.MainStream}} instance with ''ServiceType'' = ''DTT'' is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance. - The value is not saved in device state. The value when read is not specified and need not be the value that was most recently written. - - - - - - - - - - - IP front-end details. This object will normally be present if and only if the front-end is an IP front-end. - - - - Number of {{object|Inbound}} instances. - - - - - - - - Number of {{object|Outbound}} instances. - - - - - - - - Number of {{object|Inbound}} AV streams currently active (i.e. with ''Status'' != ''Disabled'', which means audio or AV data are being processed). - - - - - - - - Number of {{object|Outbound}} AV streams currently active (i.e. with ''Status'' != ''Disabled'', which means audio or AV data are being processed). - - - - - - - - - Parameters related to RTCP receiver report generation as defined in {{bibref|RFC3550}}. - - - - Enables or disables RTCP receiver report generation. - - - - - - - - The status of RTCP receiver report generation. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - Transmission repeat interval, in {{units}}. - - - - - - - - - - - - Parameters related to RTP AVPF configuration as defined in {{bibref|RFC4585}} and {{bibref|RFC4588}}. - - - - Enables or disables RTP/AVPF receiver report generation. - When set to {{true}}, enables the error correction operation, immediately ({{enum|Forced|OperationMode}} mode) or automatically when necessary ({{enum|Auto|OperationMode}} mode). - When set to {{false}}, disables the error correction operation. - - - - - - - - The operation mode of the Error Correction mechanism. {{enum}} - In {{enum|Auto}} mode, when Error Correction is enabled, the STB decides whether or not to run the Error Correction operation (e.g. after an error analysis). - In {{enum|Forced}} mode, when Error Correction is enabled the STB MUST run the Error Correction operation. - - - - - - - - - - - The status of RTP/AVPF operation. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - {{enum|Auto|OperationMode}} mode and EC is running - - - - - {{enum|Auto|OperationMode}} mode and EC is not running and EC data are not buffered). Note: this is equivalent of "Disabled" but this "Disabled" state is caused by STB under auto mode, not be set by operator - - - - - {{enum|Auto|OperationMode}} mode and EC is not running but EC data are buffered - - - - - {{enum|Forced|OperationMode}} mode and Enabled - - - - - - - - - The status of RTP/AVPF receiver report generation. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - Time in {{units}} the receiver shall wait for a retransmitted packet before considering it to be lost. - - - - - - - - - - Minimum number of lost packets the receiver shall wait for before generating a retransmission request. - - - - - - - - Maximum time in {{units}} the receiver shall wait between a lost packet and the generation of a retransmission request. - - - - - - - - - - Maximum number of consecutive lost packets for which the receiver shall attempt recovery. - - - - - - - - - Parameters related to AL-FEC configuration as defined in {{bibref|SMPTE20022-1}}. - - - - Enables or disables FEC decoder operation. - When set to {{true}}, enables the FEC decoder operation, immediately ({{enum|Forced|OperationMode}} mode) or automatically when necessary ({{enum|Auto|OperationMode}} mode). - When set to {{false}}, disables the FEC decoder operation. - - - - - - - - The operation mode of the FEC decoder. {{enum}} - In {{enum|Auto}} mode, when Error Correction is enabled the STB decides whether or not to run the AL_FEC decoding (e.g. after an error analysis). - In {{enum|Forced}} mode, when Error Correction is enabled the STB MUST run the FEC decoding. - - - - - - - - - - - The status of FEC decoder operation. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - {{enum|Auto|OperationMode}} mode and EC is running - - - - - {{enum|Auto|OperationMode}} mode and EC is not running and EC data are not buffered). Note: this is equivalent of "Disabled", but this "Disabled" state is caused by STB under auto mode, not be set by operator - - - - - {{enum|Auto|OperationMode}} mode and EC is not running but EC data are buffered - - - - - {{enum|Forced|OperationMode}} mode and Enabled - - - - - - - - - - Parameters that are specific to IGMP clients when changing channels. - - - - Enables or disables all IGMP support on the receiver side of the CPE. - - - - - - - - Status of IGMP support on the receiver side of the CPE. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - Maximum number of group memberships allowed simultaneously. - For example, this would need to be at least 2 in order to support a Multicast-delivered main picture and a Multicast-delivered PIP. - - - - - - - - Maximum number of groups for which statistics will be tracked. - This relates only to the maintenance of statistics, and does not affect the operation of the STB. - - - - - - - - Controls logging of IGMP traffic. - The CPE MAY choose to throttle log entries, e.g. if joins and leaves are occurring at an excessive rate. - - - - - - - - Diffserv code point to be used for outgoing IGMP packets. - - - - - - - - - - VLAN ID (as defined in 802.1Q) to be used for outgoing IGMP packets. A value of -1 indicates the default value is to be used. - If either the {{param}} or {{param|EthernetPriorityMark}} is greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged. - - - - - - - - - - Ethernet priority code (as defined in 802.1D) to be used for outgoing IGMP packets. A value of -1 indicates the default value is to be used. - If either the {{param|VLANIDMark}} or {{param}} are greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged. - - - - - - - - - - The highest IGMP version supported by the IGMP Client. - - - - - - - - - - - - Robustness is a way of indicating how vulnerable the network is to lost packets. IGMP can recover from robustness minus 1 lost IGMP packets. - RFC 3376 specifies a default of 2. - - - - - - - - The number of {{units}} between repetitions of a host's initial report of membership in a group. - RFC 3376 specifies a default of 1s. - - - - - - - - - - - Number of entries in the {{object|ClientGroup}} table. - - - - - - - - Number of entries in the {{object|ClientGroupStats}} table. - - - - - - - - - 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. - - - - - - - - - - {{datatype|expand}} - - - - - - - - The IP multicast group address for which this entry contains information. - - - - - - - - Time elapsed in {{units}} since the multicast group has been a member on this interface. - - - - - - - - - - - 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. - - - - - - - - - - {{datatype|expand}} - - - - - - - - The IP multicast group address for which this entry contains information. - - - - - - - - Number of {{units}} since the beginning of the period used for collection of {{object|Total}} statistics. - Statistics SHOULD continue to be accumulated across CPE reboots, though this may not always be possible. - - - - - - - - - - Number of {{units}} since the beginning of the period used for collection of {{object|CurrentDay}} statistics. - The CPE MAY align the beginning of each {{object|CurrentDay}} interval with days in the UTC time zone, but is not required to do so. - Statistics SHOULD continue to be accumulated across CPE reboots, though this may not always be possible. - - - - - - - - - - Number of {{units}} since the beginning of the period used for collection of {{object|QuarterHour}} statistics. - The CPE MAY align the beginning of each {{object|QuarterHour}} interval with real-time quarter-hour intervals, but is not required to do so. - Statistics SHOULD continue to be accumulated across CPE reboots, though this may not always be possible. - - - - - - - - - - - Total statistics for this multicast group. - - - - Number of IGMP joins during this period. - - - - - - - - Number of IGMP leaves during this period. - - - - - - - - Maximum latency delay, in {{units}}, from the sending of a Join message for this group to the arrival of the first IP packet for this group during this period. - - - - - - - - - - - Current day statistics for this multicast group. - - - - Number of IGMP joins during this period. - - - - - - - - Number of IGMP leaves during this period. - - - - - - - - Maximum latency delay, in {{units}}, from the sending of a Join message for this group to the arrival of the first IP packet for this group during this period. - - - - - - - - - - - Current quarter hour statistics for this multicast group. - - - - Number of IGMP joins during this period. - - - - - - - - Number of IGMP leaves during this period. - - - - - - - - Maximum latency delay, in {{units}}, from the sending of a Join message for this group to the arrival of the first IP packet for this group during this period. - - - - - - - - - - - Parameters related to the de-jittering buffer configuration for all inbound IP streams. - - - - De-jittering buffer size, measured in {{units}}, on the receiver side of the CPE. The STB is responsible for converting this into the actual buffer size in ''bytes''. - - - - - - - - - - Describes the number of {{units}} worth of data that should be in the receiver side dejittering buffer before play-out can start. Typically this would be half of the buffer size. - - - - - - - - - - - Inbound IP streams currently entering the STB via this front-end. - - - - - - - - - - The status of this Inbound stream. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Unique human-readable name associated with this inbound IP instance. - - - - - - - - - - Network protocol currently used for controlling streaming of the source content, or {{empty}} if the content is not being streamed or is being streamed but is not being controlled. - - - - - - - - - - Network protocol currently used for streaming the source content, or an empty string if the content is not being streamed. - - - - - - - - - - Transport control protocol currently used for streaming the source content, or an empty string if the content is not being streamed. - - - - - - - - - - AV multiplex type currently used for the source content, or an empty string if the content is not being demultiplexed. - - - - - - - - - - Network protocol currently used for downloading the source content, or an empty string if the content is not being downloaded. - - - - - - - - - - IP address of the source of the current stream content. - - - - - - - - TCP or UDP port number of the source of the current stream content, or 0 if the content is not being delivered via IP or if not applicable. - - - - - - - - - - IP address of the destination of the current stream content, or {{empty}} if the content is not being delivered via IP. - - - - - - - - TCP or UDP port number of the destination of the current stream content, or 0 if the content is not being delivered via IP or if not applicable. - - - - - - - - - - RFC 3986 URI that indicates the current source (possibly including Multicast group and port, if relevant) of the stream content, or {{empty}} if the source is not known or cannot be represented as a URI. - For example, for a WAN-delivered stream this might be a content provider's URL, or for a LAN-delivered stream it might be an UPnP AV URN. - If specified, the URI MUST be consistent with the other source-related parameters. - - - - - - - - - - - Parameters related to an outbound IP stream. - - - - - - - - - - The status of this Outbound stream. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Unique human-readable name associated with this outbound IP instance. - - - - - - - - - - AV multiplex type currently used for the destination content, or an empty string if the content is not being demultiplexed. - - - - - - - - - - RFC 3986 URI that indicates the current destination (possibly including Multicast group and port, if relevant) of the stream content, or an empty string if the destination is not known or cannot be represented as a URI. - For example, this might be an UPnP AV URN. - - - - - - - - - - - Parameters used to force connection to a dedicated IP stream for test purposes. - - - - RFC 3986 URI that describes the service to connect to in the form: - * <trsp>://<addr>:<port>?StrCtrl=<strctrl>?StrTrspCtrl=<trspctrl>?MuxType=<muxtype> - where: - * '''<addr>''' is the IP address of the service source (for Unicast) or IGMP group (for Multicast). - * '''<port>''' is the associated TCP/UDP port. If not specified, the STB is assumed to know and use an appropriate default port. - * '''<trsp>''' is the streaming transport protocol and MUST be one of the values in {{param|.Capabilities.FrontEnd.IP.StreamingTransportProtocols}}, which SHOULD be converted to lower-case. - * '''<strctrl>''' is the streaming control protocol and MUST be one of the values in {{param|.Capabilities.FrontEnd.IP.StreamingControlProtocols}}. If not specified, no streaming control protocol is to be used. - * '''<trspctrl>''' is the streaming transport control protocol and MUST be one of the values in {{param|.Capabilities.FrontEnd.IP.StreamingTransportControlProtocols}}. If not specified, no streaming transport control protocol is to be used. - * '''<muxtype>''' is the multiplex type and MUST be one of the values in {{param|.Capabilities.FrontEnd.IP.MultiplexTypes}}. This tells the STB which multiplex type to expect. If not specified, the STB is assumed to know, or to be able to determine, the multiplex type. - Note that download protocols are not supported by the above syntax. However, the specified syntax is just a baseline, and STBs MAY support an extended syntax. - Example of Multicast MPEG2-TS over RTP with no transport control: - * rtp://224.112.15.18:3257?StrCtrl=IGMP?MuxType=MPEG2-TS - Example of Multicast MPEG2-TS over RTP with AL-FEC transport control: - * rtp://224.112.15.18:3257?StrCtrl=IGMP?StrTrspCtrl=AL-FEC?MuxType=MPEG2-TS - Example of Unicast MPEG2-TS over UDP with RTSP transport control: - * udp://174.146.35.12:3257?StrCtrl=RTSP?MuxType=MPEG2-TS - Example of Unicast raw AV over RTP with RTCP control and RTSP transport control: - * rtp://174.146.35.12:3257?StrCtrl=RTSP?StrTrspCtrl=RTCP?MuxType=None - If a {{object|.ServiceMonitoring.MainStream}} instance with ''ServiceType'' = ''IP'' or ''IPTV'' (or ''VoD'' if the URI accesses a VoD service) is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance. - The value is not saved in device state. The value when read is not specified and need not be the value that was most recently written. - - - - - - - - - - - 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 {{param|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. - - - - When set to {{true}}, forces the operation mode in ForceMonitor mode - When set to {{false}}, forces operation mode in Normal mode. - - - - - - - - Indicates the status of the statistic mode of operation. {{enum}} - - - - - - - - - - - Describes the service to connect to for force monitoring purposes with the same syntax as {{param|#.ServiceConnect.URI}}. - If a {{object|.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. - - - - - - - - - - - PVR details. This is a read-only object that exists only to reference PVR storage objects. - - - - Number of {{object|Storage}} instances. - - - - - - - - - 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. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Unique human-readable name associated with this storage instance. - - - - - - - - - - References the corresponding ''StorageService'' {{bibref|TR-140}} instance, or an object contained within such an instance, e.g. a ''PhysicalMedium'', ''LogicalVolume'' or ''Folder'' instance. - The value is the full hierarchical name of the corresponding object. Example: ''Device.Services.StorageService.1'' - - - - - - - - - - - Audio decoder instance table. It contains data representing the current status of the Audio decoder. - - - - - - - - - - Enables or disables this audio decoder. - - - - - - - - The status of this audio decoder. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this audio decoder. - - - - - - - - - - Audio standard currently being processed by this audio decoder, or an empty string if no audio standard is currently being processed. - - - - - - - - - - - Video decoder instance table. It contains data representing the current status of the video decoder. - - - - - - - - - - Enables or disables this video decoder. - - - - - - - - The status of this video decoder. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this video decoder. - - - - - - - - - - MPEG2 Part 2 profile and level object instance, or {{empty}} if MPEG2 Part 2 is not used. For example: - ''.Capabilities.VideoDecoder.MPEG2Part2.ProfileLevel.2'' - - - - - - - - - - - MPEG4 Part 2 profile and level object instance, or {{empty}} if MPEG4 Part 2 is not used). For example: - ''.Capabilities.VideoDecoder.MPEG4Part2.ProfileLevel.2'' - - - - - - - - - - - MPEG4 Part 10 profile and level object instance, or {{empty}} if MPEG4 Part 10 is not used. For example: - ''.Capabilities.VideoDecoder.MPEG4Part10.ProfileLevel.2'' - - - - - - - - - - - SMPTE-VC-1 profile and level object instance, or {{empty}} if SMPTE-VC-1 is not used. For example: - ''.Capabilities.VideoDecoder.SMPTEVC1.ProfileLevel.2'' - - - - - - - - - - - Indicates the native aspect ratio of the content available at this decoder. - - - - - - - - - - - - Audio output instance table. - - - - - - - - - - Enables or disables this audio output. - - - - - - - - The status of this audio output. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - i.e. Enabled and Muted - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this audio output. - - - - - - - - - - Currently active audio output format, or {{empty}} if no audio output format is currently active. - Note that this parameter refers to output formats and not to physical connectors. - - - - - - - - - - The audio level on this audio output in {{units}} (0 is quietest and 100 is loudest). This setting is independent of the mute status. - For some audio formats, the audio level is not meaningful, in which case this parameter SHOULD have a fixed value of 0. - - - - - - - - - - - When set to {{true}}, cancels this audio output's mute status. Setting it to {{false}} has no effect. The value is not saved in device state and is always {{false}} when read. - - - - - - - - SCART object instances associated with this audio output, or {{empty}} if not associated with any SCART object instances. For example: - * ''.Components.SCART.2'' - * ''.Components.SCART.2,.Components.SCART.3'' - - - - - - - - - - - - - - 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 {{bibref|SPDIF}}. - - - - - - - - - - Enables or disables the S/PDIF output. - - - - - - - - The status of this S/PDIF output. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this output. - - - - - - - - - - When set to {{true}}, forces the audio format over S/PDIF to be in PCM mode. - When set to {{false}}, let the compressed audio format be carried over S/PDIF (passthrough). - - - - - - - - When in Passthrough mode, the STB sends the audio stream over S/PDIF without decoding it. - - - - - - - - Audio delay value, in {{units}}, currently being applied to the audio stream on the S/PDIF interface. The audio delay is entered by the user via his local UI, when necessary for correcting the lipsync. - - - - - - - - - - - Video output instance table. - - - - - - - - - - Enables or disables this video output. - - - - - - - - The status of this video output. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Enables or disables the color bar display. - When set to {{true}}, the CPE MUST suspend the running service currently using the video output (e.g. IPTV broadcast reception) and MUST display the color bar. - When set to {{false}}, the CPE MUST resume the previousely running service. - This parameter MUST be always initialized with the value {{false}} on STB boot. - - - - - - - - Human-readable name associated with this Video output. - - - - - - - - - - The type of analog video standard currently in use or {{empty}} if no analog video standard is currently in use. - Note that this parameter applies only to the CVBS output format. - - - - - - - - - - Currently active video output format, or {{empty}} if no video output format is currently active. - Note that this parameter refers to output formats and not to physical connectors. - - - - - - - - - - Indicates the aspect ratio behaviour for display on monitors with an aspect ratio different from that of the content, which is specified in {{param|.Components.VideoDecoder.{i}.ContentAspectRatio}}. - - - - - - - DEPRECATED and replaced by following values - - - - - - - - DEPRECATED and replaced by following values - - - - - - - - - - Display format being connected to this VideoOutput. - This parameter is used by the STB to determine whether an aspect ratio conversion is required. - - - - - - - - - - Indicates whether Macrovision analog protection is being used on this video output. - The Macrovision version supported is indicated in {{param|.Capabilities.VideoOutput.Macrovision}}. - - - - - - - - Indicates whether HDCP is being used on this video output. - The HDCP version supported is indicated in {{param|.Capabilities.VideoOutput.HDCP}}. - - - - - - - - SCART object instances associated with this video output, or {{empty}} if not associated with any SCART object instances. For example: - * ''.Components.SCART.2'' - * ''.Components.SCART.2,.Components.SCART.3'' - - - - - - - - - - - - - - SCART configuration. This object allows configuration of the STB's AV switching. - - - - - - - - - - Enables or disables this SCART connector. - - - - - - - - The status of this SCART connector. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this connector. - - - - - - - - - - Enables or disables the Presence control signal (pin 8 of the SCART connector), an output from the STB to control the display device connected to the SCART. - When enabled (set to {{true}}) the STB MUST drive pin 8 to the appropriate level to indicate the output video format (SD or HD) to the connected device. - When disabled (set to {{false}}) the STB MUST NOT drive pin 8. - - - - - - - - - HDMI instance table. This object allows configuration of the STB’s HDMI output. - - - - - - - - - - Enables or disables the HDMI output. - - - - - - - - The status of HDMI output. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this output. - - - - - - - - - - The resolution mode of the HDMI output. - In {{enum|Auto}} mode, the resolution is automatically set at the best format via HDMI protocols. - In {{enum|Manual}} mode, the resolution to be applied to the HDMI output is given by the ResolutionValue parameter. - - - - - - - - - - - When {{param|ResolutionMode}} is set to {{enum|Manual|ResolutionMode}} mode, a write action configures the resolution to be applied to the HDMI output, - When {{param|ResolutionMode}} is set to {{enum|Auto|ResolutionMode}}, a write action as no effect. - A read action provides the current resolution of the HDMI output. - - - - - - - - - - - HDMI connected display device configuration. This object provides parameters from the HDMI connected device if any. - - - - The status of the connected HDMI Display device. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - Human-readable name associated with this display device. - - - - - - - - - - Enhanced Extended Display Information Data (E-EDID) retrieved from the connected HDMI device. - - - - - - - - - - Each entry is a supported resolution of the connected HDMI device and MUST be one element of {{param|.Capabilities.HDMI.SupportedResolutions}}. - - - - - - - - - Preferred connected HDMI device resolution format. - - - - - - - - - - Video latency, in {{units}}, being applied in the connected HDMI device. This parameter is extracted from the E-EDID and can be used to compensate the video latency to preserve lipsync. - - - - - - - - - - When set to {{true}}, indicates the connected HDMI device is supporting HDMI-CEC features. - When set to {{false}}, indicates the connected HDMI device does not support HDMI CEC. - - - - - - - - When set to {{true}}, indicates the connected display device supports auto lip synchronization. This mode consists in communicating over HDMI, the delay to be applied by the STB to the audio in order to preserve the lip sync. - - - - - - - - When set to {{true}}, indicates the connected display device supports the 3D video formats mandated by {{bibref|HDMI}}. - - - - - - - - - This object describes the characteristics of the Conditional Access, if any. - - - - - - - - - - Enables or disables this CA system. - - - - - - - - The status of this CA system. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Indicates a unique identifier (e.g. the commercial name: ''La 7 piu'', ''Mediaset Premium'') for this CA system. - - - - - - - - - - - Path name of the smart card reader object instance containing the smart card (if any) associated with this CA system. - The value MUST be {{empty}} (if not associated with a smart card) or else be the full path name of the corresponding smart card reader object. For example: - ''Device.SmartCardReader.1'' - - - - - - - - - - - This object describes the characteristics of the Digital Rights Management, if any. - - - - - - - - - - Enables or disables this DRM system. - - - - - - - - The status of this DRM system. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Indicates a unique identifier (e.g. the commercial name: ''La 7 piu'', ''Mediaset Premium'') for this DRM system. - - - - - - - - - - - Path name of the smart card reader object instance containing the smart card (if any) associated with this DRM system. - The value MUST be {{empty}} (if not associated with a smart card) or else be the full path name of the corresponding smart card reader object. For example: - ''Device.SmartCardReader.1'' - - - - - - - - - - - AV Streams object. If more than one AV stream can be active at a time, it may contain several {{object|AVStream}} instances. - - - - Number of AV streams currently active (i.e. with ''Status'' != ''Disabled'', which means audio or AV data are being processed). - - - - - - - - Number of {{object|AVStream}} instances. - - - - - - - - - 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). - - - - - - - - - - The status of this AV stream. {{enum}} - An AV stream is disabled if any of the referenced objects are disabled. - If an AV stream is disabled then the values of other AV stream parameters are not significant. - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - Unspecified error - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this stream, e.g. read from the DVB service information metadata. - - - - - - - - - - Indicates whether this stream is using the PVR and, if so, the PVR state. {{enum}} - PVR record state can be inferred from whether the stream has an input FrontEnd: if so and {{param}} is not {{enum|Disabled}}, the PVR is recording. - - - - - - PVR not used by this stream - - - - - PVR playback not active - - - - - PVR playback active (and playing) - - - - - PVR playback active (paused) - - - - - PVR playback active (fast forward) - - - - - PVR playback active (rewind) - - - - - - - - Input FrontEnd object instance associated with this AV stream, or {{empty}} if not associated with a FrontEnd object). For example: - ''.Components.FrontEnd.2'' - - - - - - - - - - - Inbound IP stream object instance associated with the FrontEnd for this AV stream, or {{empty}} if the inbound stream is not delivered over IP. For example: - ''.Components.FrontEnd.2.IP.Inbound.3'' - - - - - - - - - - - Outbound IP stream object instance associated with the output FrontEnd for this AV stream (which is always the IP FrontEnd), or {{empty}} if the outbound stream is not delivered over IP. For example: - ''.Components.FrontEnd.2.IP.Outbound.3'' - - - - - - - - - - - Audio Decoder object instance associated with this AV stream, or {{empty}} if not associated with an Audio Decoder object. For example: - ''.Components.AudioDecoder.2'' - - - - - - - - - - - Video Decoder object instance associated with this AV stream, or {{empty}} if not associated with a Video Decoder object. For example: - ''.Components.VideoDecoder.2'' - - - - - - - - - - - CA system object instance associated with this AV stream, or {{empty}} if not associated with a CA object. For example: - ''.Components.CA.2'' - - - - - - - - - - - DRM system object instance associated with this AV stream, or {{empty}} if not associated with a DRM object. For example: - ''.Components.DRM.2'' - - - - - - - - - - - - AV Players object. If more than one AV player can be active at a time, it may contain several {{object|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. - - - - Number of AV players currently active (i.e. with ''Status'' != ''Disabled'', which means the {{object|AVPlayer}} is processing an audio or AV stream). - - - - - - - - Number of {{object|AVPlayer}} instances. - - - - - - - - Human-readable string, as specified in {{bibref|RFC3066}}, describing the audio language that SHOULD be used by the STB when receiving a multi-language audio multiplex. - {{empty}} indicates that there is no preferred audio language. - - - - - - - - - - Human-readable string, as specified in {{bibref|RFC3066}}, describing the subtitling language that SHOULD be used by the STB when receiving multi-language subtitling. - A value of ''None'' indicates that no subtitling is required. - {{empty}} indicates that there is no preferred subtitling language. - - - - - - - - - - Aspect ratio behaviour preference for display on monitor. - If non-empty, the string MUST be one of the .Components.VideoOutput.{i}. AspectRatioBehaviour values. - - - - - - - - - - When set to {{true}}, the master PIN code for the STB is set to 0000. Setting it to {{false}} has no effect. The value is not saved in device state and is always {{false}} when read. 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. - - - - - - - - - List of AV Player objects. Each item is one particular AV player being processed by the STB. - - - - - - - - - - Enables or disables this AV player. - - - - - - - - The status of this AV player. {{enum}} - If an AV player is disabled then the values of other AV player parameters are not significant. - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this AV player. - - - - - - - - - - Human-readable string, as specified in {{bibref|RFC3066}}, describing the audio language being currently processed by the AV player. - - - - - - - - - - The status of subtitling for this AV player. {{enum}} - Subtitles are assumed to be shown only on the main screen. - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - Human-readable string, as specified in {{bibref|RFC3066}}, describing the subtitling language being currently processed by the AV player. - Subtitles are assumed to be shown only on the main screen. - - - - - - - - - - Audio output object instances associated with this AV player, or {{empty}} if not associated with any audio output object instances. For example: - ''.Components.AudioOutput.2'' - - - - - - - - - - - - - Video output object instances associated with this AV player, or {{empty}} if not associated with any video output object instances. For example: - ''.Components.VideoOutput.2'' - - - - - - - - - - - - - AV stream object instance associated with this AV player that is being sent to the main screen, or {{empty}} if not associated with an AV stream object. For example: - ''.AVStreams.AVStream.2'' - - - - - - - - - - - AV stream object instances associated with this AV player that are being displayed as Picture In Picture (PIP), or {{empty}} if not associated with any PIP AV stream objects. For example: - * ''.AVStreams.AVStream.2'' - * ''.AVStreams.AVStream.2,.AVStreams.AVStream.3'' - - - - - - - - - - - - - - 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 {{object|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 {{bibref|TR-135|I.3}} for non-normative explanation of the operation of the ''ServiceMonitoring'' object. - - - - Enables or disables collection of Sample statistics. - When collection of Sample statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. - - - - - - - - Indicates availability of Sample statistics. {{enum}} - The {{enum|Trigger}} value is only used for triggering the ACS to fetch the collected data and can only be used when {{param|FetchSamples}} is in the range [1:{{param|ReportSamples}}]. - The transition from {{enum|Enabled}} -> {{enum|Trigger}} -> {{enum|Enabled}} MUST be instantaneous and so will result in only a single value change for notification purposes. - - - - - - Collection is disabled - - - - - Collection is enabled - - - - - Collection is enabled and the ACS should now fetch the collected data - - - - - - - - The sample interval in {{units}}. Each statistic is measured over this sample interval. - The STB MAY reject a request to set {{param}} to less than {{param|.Capabilities.ServiceMonitoring.MinSampleInterval}}. - Sample intervals MUST begin every {{param}} seconds, with no delay between samples. - If {{param}} is changed while collection of Sample statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. - For example, if {{param|ReportSamples}} is 24 and {{param}} is 3600 (an hour), the STB can store up to a day's worth of samples for each statistic. - - - - - - - - - - - The number of samples that the STB can store and report for each statistic. - The STB MUST permit {{param}} to be set to any value in the range from 1 to {{param|.Capabilities.ServiceMonitoring.MaxReportSamples}}. - If {{param}} is changed while collection of Sample statistics is enabled, the STB will truncate or extend its statistics buffers as appropriate, but statistics collection MUST NOT otherwise be affected. - For example, if {{param}} is 24 and {{param|SampleInterval}} is 3600 (an hour), the STB can store up to a day's worth of samples for each statistic. - - - - - - - - - - The number of event measurements of each applicable statistic that the STB is able to store for each sample interval. - The STB MUST permit {{param}} to be set to any value in the range from 1 to {{param|.Capabilities.ServiceMonitoring.MaxEventsPerSampleInterval}}. - If {{param}} is changed while collection of Sample statistic is enabled, the STB will truncate or extend its event measurement buffers as appropriate, but event measurement collection MUST NOT otherwise be affected. - For example, if {{param|ReportSamples}} is 24 and {{param|SampleInterval}} is 3600 (an hour), and {{param}} is 60, the STB can store up 60 event measurements per hour, or in total 1440 event measurements per day. - - - - - - - - - - If collection of Sample statistics is enabled and {{param}} is in the range [1:{{param|ReportSamples}}] then {{param|SampleState}} MUST transition from {{enum|Enabled|SampleState}} -> {{enum|Trigger|SampleState}} -> {{enum|Enabled|SampleState}} on completion of every {{param}} sample intervals. Otherwise, this transition MUST NOT occur. - For example, if {{param|ReportSamples}} is 25 and {{param}} is 24, then the STB will store 25 values for each statistic and the above {{param|SampleState}} transition will occur every 24 sample intervals, which means that the ACS could delay for up to two sample intervals before reading the stored values and would still not miss any samples (see also {{param|ForceSample}}). - - - - - - - - An absolute time reference in UTC to determine when sample intervals will complete. Each sample interval MUST complete at this reference time plus or minus an integer multiple of {{param|SampleInterval}}. - This time reference also determines when the {{param|SampleState}} {{enum|Enabled|SampleState}} -> {{enum|Trigger|SampleState}} -> {{enum|Enabled|SampleState}} transitions that are controlled by {{param|FetchSamples}} will occur. If collection of Sample statistics is enabled and {{param|FetchSamples}} is in the range [1:{{param|ReportSamples}}] then each such {{param|SampleState}} transition MUST occur at this reference time plus or minus an integer multiple of {{param|FetchSamples}} * {{param|SampleInterval}} (the fetch interval). - {{param}} is used only to set the "phase" of the sample and fetch intervals. The actual value of {{param}} can be arbitrarily far into the past or future. - If {{param}} is changed while collection of Sample statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. - The Unknown Time value defined in {{bibref|TR-106a1}} indicates that no particular time reference is specified. That is, the STB MAY locally choose the time reference, and is required only to adhere to the specified sample and fetch intervals. - If absolute time is not available to the STB, its sample and fetch interval behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value. - For example, if {{param|SampleInterval}} is 3600 (an hour) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then sample intervals will complete on each UTC hour (00:00, 01:00, 02:00 etc). - If, in addition, {{param|FetchSamples}} is 24, then the fetch interval is 86400 (a day) and {{param|SampleState}} {{enum|Enabled|SampleState}} -> {{enum|Trigger|SampleState}} -> {{enum|Enabled|SampleState}} transitions will occur every day at UTC midnight. - Note that, if {{param}} is set to a time other than the Unknown Time, the first sample interval (which has to begin immediately) will almost certainly be shorter than {{param|SampleInterval}}). This is why {{param}} is defined in terms of when sample intervals complete rather than start. - - - - - - - - When set to {{true}}, forces statistics for the current sample to be calculated and updated in the data model. Setting it to {{false}} has no effect. The value is not saved in device state and is always {{false}} when read. - If this is the first time that {{param}} has been set to true 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 {{param|ReportEndTime}} and all ''SampleSeconds'' parameters MUST be updated accordingly. - If this is not the first time that {{param}} has been set to {{true}} during the current sample interval, then the new values that were added as described in the previous paragraph, and the {{param|ReportEndTime}} and all ''SampleSeconds'' parameters, MUST be updated accordingly. - Note that {{param}} 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 {{param}} was set to {{true}} during the sample interval then the new values that were added as described above, and the {{param|ReportEndTime}} and all ''SampleSeconds'' parameters, will be updated accordingly. In other words, the partial sample data that was created when {{param}} was set to {{true}} will be updated one last time at the end of the sample interval. - - - - - - - - The absolute time at which the sample interval for the first stored sample (for each statistic) started. - - - - - - - - The absolute time at which the sample interval for the last stored sample (for each statistic) ended. - If {{param|ForceSample}} has been used to force statistics for the current sample to be calculated and updated in the data model, then {{param}} MUST be updated to reflect the actual time over which stored data was collected. - - - - - - - - Number of {{object|MainStream}} instances. - - - - - - - - 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. - - - - - - - - - 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. {{param|.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. - - - - - - - - - - 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 {{param|##.ServiceMonitoring.EventCollectionEnable}} to be {{true}}. - - - - - - - - Total and Sample statistics and event collection status for this object instance. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - Time based UUID {{bibref|RFC4122|Section 4.2}} that is the identifier for the associated {{param|AVStream}} parameter when available to the device. - - - - - - - - {{datatype|expand}} - - - - - - - - Service type associated with this main stream instance, or {{empty}} if this instance is disabled. - The STB MUST reject a request that would result in a given AV stream contributing to more than one {{object|.ServiceMonitoring.MainStream}} instance, e.g. it would reject a request to enable simultaneous collection of both IPTV and IP statistics, or to collect IPTV statistics on more than one instance. - - - - - - - - - - Main AV stream object instance currently associated with this ''ServiceMonitoring'' main stream instance. For example: - ''.AVStreams.AVStream.2'' - Note that, during the period of time over which Sample statistics are stored, this ''ServiceMonitoring'' main stream instance might be associated with many different ''AVStream'' instances. This parameter just provides information about which ''AVStream'' is currently being monitored. - - - - - - - - - - - Minimum number of consecutive received packets after the end of an RTP Loss Event. A Loss Event is defined as as a sequence of lost packets, possibly including islands of received packets. Each island consists of up to - ({{param}} - 1) received packets (a sequence of {{param}} received packets terminates the Loss Event, and so is not an island). - - - - - - - - The minimum distance required between error events before an RTP Loss Event is considered severe. Used in the calculation of ''SevereLossIndexCount'' and ''SevereLossIndexCountBeforeEC''. - - - - - - - - The minimum value for the count of lost packets per RTP Loss Event before the count of lost packets is considered severe. Used in the calculation of ''SevereLossLengthCount'' and ''SevereLossLengthCountBeforeEC''. - - - - - - - - Time period, in {{units}}, between a user channel change request (defined as the instant of transmission of the relevant control protocol message (IGMP JOIN or RTSP SETUP) or a tuner command in case of DTT), and the display of the first I frame for the current AVStream, above which a channel change is considered as failed. - - - - - - - - - - {{list}} Definition of the histogram intervals for counting loss events according to their size (in {{units}}). Each value indicates the maximum value of the interval. For example, "1,2,4,8," defines the five intervals: 1 packet lost, 2 packets, 3 or 4 packets, 5 to 8 packets and 9 or more packets. (No value after the last comma means no upper bound.) - If this parameter is set to an empty string, no PacketsLostByEvent stats will be collected. - - - - - - - - - - - - {{list}} Definition of the histogram intervals for counting loss events according to their delay (in {{units}}) after the preceding loss event. Each value indicates the maximum value of the interval. For example, "10,20,50,100,1000,60000,3600000," defines the intervals up to 10 ms, to 20 ms, to 50 ms, to 100 ms, to 1 s, to 1 mn, to 1 h and more than 1 h. (No value after the last comma means no upper bound.) - If this parameter is set to an empty string, no DelayBetweenLossEvents stats will be collected. - - - - - - - - - - - - {{list}} Definition of the histogram intervals for counting severe loss events according to their duration (in {{units}}). Each value indicates the maximum value of the interval. For example, "50,100,500,1000,2000,5000,10000,120000," defines the intervals up to 50 ms, to 100 ms, to 500 ms, to 1 s, to 2 s etc. (No value after the last comma means no upper bound.) - If this parameter is set to an empty string, no DurationSevereLossEvents stats will be collected. - - - - - - - - - - - - - Total statistics since this ''ServiceMonitoring'' main stream instance was last enabled or Total statistics were last reset. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than the {{param|ResetTime}}, for several reasons, including the STB was not receiving any data (Standby mode without force monitoring). - - - - - - - - When set to {{true}}, resets Total statistics for this ''ServiceMonitoring'' main stream instance. Setting it to {{false}} has no effect. The value is not saved in device state and is always {{false}} when read. - - - - - - - - Number of seconds since the Total statistics were last enabled or reset for this ''ServiceMonitoring'' main stream instance. - - - - - - - - - Total de-jittering statistics for this ''ServiceMonitoring'' main stream instance. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}, for several reasons, including: - * Any of the reasons for which the {{param}} values might be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}. - * De-jittering data collection is not appropriate or possible for this AV stream. - - - - - - - - Total time, in {{units}}, for which the playout was stopped due to buffer issues (empty or too low level) for this AV stream. - - - - - - - - - - Total number of times the receive jitter buffer has overrun for this AV stream. - - - - - - - - Total number of times the receive jitter buffer has underrun for this AV stream. - - - - - - - - - Total TCP statistics for this ServiceMonitoring main stream instance. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}, for several reasons, including: - * Any of the reasons for which the {{param}} values might be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}. - * TCP data collection is not appropriate or possible for this AV stream. - - - - - - - - Total number of TCP packets correctly received for this AV stream. - - - - - - - - Total number of TCP packets being retransmitted for this AV stream. - - - - - - - - Total number of bytes received for this AV stream. - - - - - - - - - Total RTP statistics for this ''ServiceMonitoring'' main stream instance. - If no EC is applied the ''BeforeEC'' statistics provide the same values as the corresponding statistics, e.g. when there is no EC, {{param|PacketsReceivedBeforeEC}} = {{param|PacketsReceived}}. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}, for several reasons, including: - * Any of the reasons for which the {{param}} values might be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}. - * RTP data collection is not appropriate or possible for this AV stream. - - - - - - - - Total number of RTP packets expected for this AV stream as described in {{bibref|RFC3550|A.3}}. - - - - - - - - Total number of packets discarded at the RTP layer for this AV stream because they were too late for playout, regardless of their being out of sequence or not. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - Total number of packets out of sequence at the RTP level for this AV stream, regardless of their being too late for playout or not. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - Total number of RTP packets received for this AV stream. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - Total number of RTP packets received for this AV stream. - These statistics are collected before any EC, if available, is applied. - - - - - - - - Total number of RTP packets lost for this stream. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - Total number of RTP packets lost for this stream. - These statistics are collected before any EC, if available, is applied. - - - - - - - - {{list}} Total number of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by {{param|##.PacketsLostByEventHistogramIntervals}}. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - {{list}} Total number of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by {{param|##.PacketsLostByEventHistogramIntervals}}. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Total number of Loss Events for this stream. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - Total number of Loss Events for this stream. - These statistics are collected before any EC, if available, is applied. - - - - - - - - {{list}} Total number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by {{param|##.DelayBetweenLossEventsHistogramIntervals}}. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - {{list}} Total number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by {{param|##.DelayBetweenLossEventsHistogramIntervals}}. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Total number of Loss Events closer than ''SevereLossMinDistance''. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - Total number of Loss Events closer than ''SevereLossMinDistance''. - These statistics are collected before any EC, if available, is applied. - - - - - - - - Total number of Loss Events longer than ''SevereLossMinLength''. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - Total number of Loss Events longer than ''SevereLossMinLength''. - These statistics are collected before any EC, if available, is applied. - - - - - - - - {{list}} Total number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by {{param|##.DurationSevereLossEventsHistogramIntervals}}. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - {{list}} Total number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by {{param|##.DurationSevereLossEventsHistogramIntervals}}. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Total number of RTP/AVPF retransmission timeouts ({{bibref|RFC4585}}, {{bibref|RFC4588}}) - If RTP/AVPF is not used this parameter does not increment - - - - - - - - - Total MPEG2-TS statistics for this ''ServiceMonitoring'' main stream instance. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}, for several reasons, including: - * Any of the reasons for which the {{param}} values might be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}. - * MPEG2 TS data collection is not appropriate or possible for this AV stream. - - - - - - - - Total number of MPEG2-TS packets received for this AV stream. - - - - - - - - Total number of MPEG2-TS packets with an invalid transport sync byte received for this AV stream. - Not meaningful when MPEG2-TS is transported over IP. - - - - - - - - Total number of MPEG2-TS Loss of Synchronization Events for this AV stream. - Not meaningful when MPEG2-TS is transported over IP. - - - - - - - - Total number of MPEG2-TS Discontinuity errors that have been captured for this AV stream. This parameter accumulates all of the discontinuities observed for all currently monitored PIDs. - These statistics are collected when no CA decryption scheme is in use or after any CA decryption if in use. - - - - - - - - Total number of MPEG2-TS Discontinuity errors that have been captured for this AV stream. This parameter accumulates all of the discontinuities observed for all currently monitored PIDs. - These statistics are collected before any CA decryption scheme, if used, is applied. - - - - - - - - - Total video decoder application layer statistics for this ''ServiceMonitoring'' main stream instance. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}, for several reasons, including: - * Any of the reasons for which the {{param}} values might be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}. - * Video Decoder data collection is not appropriate or possible for this AV stream. - - - - - - - - The latest frame rate at which the STB played out the video content for this AV stream. Also the reported rate will be rounded off to the nearest integer. - - - - - - - - The number of video frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream. - - - - - - - - The number of video frames that could not be reproduced by the STB for this AV stream. - - - - - - - - The number of video frames that were reproduced by the STB for which some information was missing and loss concealment was applied for this AV stream. - - - - - - - - The number of I frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream. - - - - - - - - The number of I frames that could not be reproduced by the STB for this AV stream. - - - - - - - - The number of I frames that were reproduced by the STB for which some information was missing and loss concealment applied for this AV stream. - - - - - - - - The number of P frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream. - - - - - - - - The number of P frames that could not be reproduced by the STB for this AV stream. - - - - - - - - The number of P frames that were reproduced by the STB for which some information was missing and loss concealment applied for this AV stream. - - - - - - - - The number of B frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream. - - - - - - - - The number of B frames that could not be reproduced by the STB for this AV stream. - - - - - - - - The number of B frames that were reproduced by the STB for which some information was missing and loss concealment applied for this AV stream. - - - - - - - - The number of AV resynchronizations that were performed by the STB for this AV stream. - - - - - - - - - Total audio decoder application layer statistics for this ''ServiceMonitoring'' main stream instance. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}, for several reasons, including: - * Any of the reasons for which the {{param}} values might be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}. - * Audio Decoder data collection is not appropriate or possible for this AV stream. - - - - - - - - The number of audio frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream. - - - - - - - - The number of audio decoding errors detected for this AV stream. - - - - - - - - - Total video response statistics for this ''ServiceMonitoring'' main stream instance. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}, for several reasons, including: - * Any of the reasons for which the {{param}} values might be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}. - * Video response data collection is not appropriate or possible for this AV stream. - - - - - - - - Number of channel change failures. A channel change is considered as failed when the time period between a user channel change request and the display of the first I frame for this AVStream is above {{param|.ServiceMonitoring.MainStream.{i}.ChannelChangeFailureTimeout}}. - - - - - - - - Each entry represents a channel for which a channel change failed. Channels MAY be described as IP address, URL or Service names as appropriate. Only last 10 failures are required to be reported. - - - - - - - - - Minimum time period, in {{units}}, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. - - - - - - - - - - Maximum time period, in {{units}}, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. - - - - - - - - - - Total number of RTSP protocol requests to start a VoD program display. - Only meaningful for VoD. - - - - - - - - Total number of successful VoD attempts. An attempt is considered successful when the first I-frame is displayed by the client. - Only meaningful for VoD. - - - - - - - - Total number of completed VoD requests. An attempt is defined successful if it continues until a RTSP protocol request to end the session is sent by the STB. - Only meaningful for VoD. - - - - - - - - Minimum time period (in {{units}}) between the instant of transmitting an IGMP JOIN command or an RTSP SETUP command, and the display of the first I frame for this AV stream. - - - - - - - - - - Maximum time period (in {{units}}) between the instant of transmitting an IGMP JOIN command or an RTSP SETUP command, and the display of the first I frame for this AV stream. - - - - - - - - - - - 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. - Each comma-separated list can contain up to {{param|##.ReportSamples}} statistics values. When the list is full, each new value causes the oldest one to be discarded. - Some comma-separated lists contain terms that are comma-separated lists themselves and are used to store measurements on an event basis. These sub-lists can contain up to {{param|.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. - - - - Each entry is the number of seconds during which data was collected for this AV stream during the sample interval. Each statistics category (Dejittering, RTP etc) has its own ''SampleSeconds'' parameter, which indicates the number of seconds during which data was collected for that statistics category during the sample interval. - Individual ''SampleSeconds'' values can be less than the ''SampleInterval'', for several reasons, including: - * The STB was not receiving any data for the corresponding ServiceType for all or part of the sample interval. - * ''TimeReference'' has been set to a time other than the Unknown Time and the current sample interval started part of the way through a scheduled sample interval. - * ''ForceSample'' has been used to force statistics for the current sample to be calculated and updated in the data model. - - - - - - - - - - - Each entry is the total number of times that a channel change (or other potentially disruptive event) occurred for this AV stream during the sample interval. - - - - - - - - - Each entry is a Boolean that indicates whether the PVR, with a non-zero time-shift, was used at any time for this AV stream during the sample interval. - - - - - - - - - Number of {{object|HighLevelMetricStats}} instances. - - - - - - - - - De-jittering Sample statistics for this ''ServiceMonitoring'' main stream instance. - - - - Each entry is the number of seconds during which de-jittering data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * De-jittering data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - Each entry is the total number of times the receive jitter buffer has overrun for this AV stream during the sample interval. - - - - - - - - - Each entry is the total number of times the receive jitter buffer has underrun for this AV stream during the sample interval. - - - - - - - - - Each entry is the time period, in {{units}}, for which the playout was stopped due to buffer issues (empty or too low level) for this AV stream during the sample interval. - - - - - - - - - - - - TCP sample statistics for this ''ServiceMonitoring'' main stream instance. - - - - Each entry is the number of seconds during which de-jittering data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * TCP data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - Each entry is the total number of TCP packets received for this AV stream during the sample interval. - - - - - - - - - Each entry is the total number of TCP packets being retransmitted this AV stream.during the sample interval. - - - - - - - - - Each entry is the total number of bytes received for this AV stream.during the sample interval. - - - - - - - - - - RTP Sample statistics for this ''ServiceMonitoring'' main stream instance. - If no EC is applied the ''BeforeEC'' statistics provide the same values as the corresponding statistics, e.g. when there is no EC, {{param|PacketsReceivedBeforeEC}} = {{param|PacketsReceived}}. - - - - Each entry is the number of seconds during which RTP data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * RTP data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - Each entry is the total number of RTP packets expected for this AV stream during the sample interval as described in {{bibref|RFC3550|A.3}}. - - - - - - - - - Each entry is the number of packets that were discarded at the RTP layer for this AV stream during the sample interval because they were too late for playout, regardless of their being out of sequence or not. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - Each entry is the number of packets out of sequence at the RTP level for this AV stream during the sample interval, regardless of their being too late for playout or not. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - Each entry is the total number of RTP packets received for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - Each entry is the total number of RTP packets received for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Each entry is the number of RTP/AVPF retransmission timeouts ({{bibref|RFC4585}}, {{bibref|RFC4588}}) for this AV stream during the sample interval. - - - - - - - - - Each entry is the total number of RTP packets lost for this AV stream during the sample interval. - Calculated by looking for missing RTP sequence headers. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - Each entry is the total number of RTP packets lost for this AV stream during the sample interval. - Calculated by looking for missing RTP sequence headers. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - {{list}} Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by {{param|##.PacketsLostByEventHistogramIntervals}}. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - {{list}} Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by {{param|##.PacketsLostByEventHistogramIntervals}}. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Each entry is the total number of Loss Events for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - Each entry is the total number of Loss Events for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - {{list}} Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by {{param|##.DelayBetweenLossEventsHistogramIntervals}}. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - {{list}} Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by {{param|##.DelayBetweenLossEventsHistogramIntervals}}. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Each entry is the total number of Loss Events that occurred at a distance shorter than ''SevereLossMinDistance'' from the previous Loss Event for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - Each entry is the total number of Loss Events that occurred at a distance shorter than ''SevereLossMinDistance'' from the previous Loss Event for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Each entry is the average distance in {{units}} between consecutive Loss Events for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - - - Each entry is the average distance in {{units}} between consecutive loss events for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - - - Each entry is the length in {{units}} of the shortest distance between consecutive Loss Events for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - - - Each entry is the length in {{units}} of the shortest distance between consecutive Loss Events for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - - - Each entry is the total number of Loss Events with length in RTP packets greater than ''SevereLossMinLength'' for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - Each entry is the total number of Loss Events with length in RTP packets greater than ''SevereLossMinLength'' for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - {{list}} Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by {{param|##.DurationSevereLossEventsHistogramIntervals}}. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - {{list}} Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by {{param|##.DurationSevereLossEventsHistogramIntervals}}. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Each entry is the length in {{units}} of the longest Loss Event for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - - - Each entry is the length in {{units}} of the longest Loss Event for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - - - Each entry is the average length in {{units}} of Loss Events for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - - - Each entry is the average length in {{units}} of Loss Events for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - - - Each entry is the length in {{units}} of the shortest RTP Loss Event for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - - - Each entry is the length in {{units}} of the shortest RTP Loss Event for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - - - - MPEG2-TS Sample statistics for this ''ServiceMonitoring'' main stream instance. - - - - Each entry is the number of seconds during which MPEG2-TS data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * MPEG2-TS data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - Each entry is the total number of MPEG2-TS packets received for this AV stream during the sample interval. - - - - - - - - - Each entry is the total number of good MPEG2-TS packets removed from the buffer for this AV stream during the sample interval. - Packets received minus packets drained provides an indication how close the buffer came to over or under running during the sample interval. - - - - - - - - - Each entry is the total number of MPEG2-TS packets with an invalid transport sync byte for this AV stream during the sample interval. - Not meaningful when MPEG2-TS is transported over IP. - - - - - - - - - Each entry is the total number of MPEG2-TS Loss of Synchronization Events for this AV stream during the sample interval. - Not meaningful when MPEG2-TS is transported over IP. - - - - - - - - - Each entry is the total number of MPEG2-TS Discontinuity errors that were captured for this AV stream during the sample interval. - These statistics are collected when no CA decryption scheme is in use or after any CA decryption if in use. - - - - - - - - - Each entry is the total number of MPEG2-TS Discontinuity errors that were captured for this AV stream during the sample interval. - These statistics are collected before any CA decryption scheme, if used, is applied. - - - - - - - - - - Video decoder Sample statistics for this ''ServiceMonitoring'' main stream instance. - - - - Each entry is the number of seconds during which video decoder data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * Video Decoder data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - Each entry is the last frame rate at which the STB played out the video content for this AV stream during the sample interval. . Also the reported rate will be rounded off to the nearest integer. - - - - - - - - - Each entry is the number of video frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of video frames that could not be reproduced by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of video frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment was applied. - - - - - - - - - Each entry is the number of I frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of I frames that could not be reproduced by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of I frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment applied. - - - - - - - - - Each entry is the number of P frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of P frames that could not be reproduced by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of P frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment applied. - - - - - - - - - Each entry is the number of B frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of B frames that could not be reproduced by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of B frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment applied. - - - - - - - - - Each entry is the number of AV resynchronizations that were performed by the STB for this AV stream during the sample interval. - - - - - - - - - - Audio decoder Sample statistics for this ''ServiceMonitoring'' main stream instance. - - - - Each entry is the number of seconds during which audio decoder data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * Audio decoder data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - Each entry is the number of audio frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of audio decoding errors detected by the STB for this AV stream during the sample interval. - - - - - - - - - - Video response Sample statistics for this ''ServiceMonitoring'' main stream instance. - - - - Each entry is the number of seconds during which video response data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * Video response data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - Each entry is the time period (in {{units}}) between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame, computed as the average of the VideoSystemResponse events that occured for this AV stream during the sample interval. - - - - - - - - - - - Each entry is the minimum time period (in {{units}}) between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame for this AV stream during the sample interval. - - - - - - - - - - - Each entry is the maximum time period (in {{units}}) between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame for this AV stream during the sample interval. - - - - - - - - - - - Each entry is the time period, in {{units}}, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream, computed as the average of the VoDControlResponse events that occured for this AV stream during the sample interval. Only measured when started from a non-play state, i.e. either idle or paused. - - - - - - - - - - - Each entry is the minimum time period, in {{units}}, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. - - - - - - - - - - - Each entry is the maximum time period, in {{units}}, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. - - - - - - - - - - - Each entry is a colon separated list of time periods in milliseconds between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. - A comma separates measurements made in different sample intervals, while a colon separates individual measurements within a specific sample interval. - If no VoDControlResponse measurements were made during a specific sample interval then this MUST be represented by an empty string. - Example: ,837:453:1234,759,,,923:698,,,1284 - Here there were no measurements during first sample interval, three during the second, one during the third, etc. - The statistics values in this list MUST be in time order, with the oldest one first and the most recent one last. This applies both to sample intervals and to individual measurements during a specific sample interval. {{nopattern}} - - - - - - - {{nopattern}} - - - - - - - - Each entry is a colon separated list of time periods in milliseconds between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame that occurred for this AV stream during the sample interval. - A comma separates measurements made in different sample intervals, while a colon separates individual measurements within a specific sample interval. - If no VideoSystemResponse measurements were made during a specific sample interval then this MUST be represented by an empty string. - Example: ,837:453:1234,759,,,923:698,,,1284 - Here there were no measurements during first sample interval, three during the second, one during the third, etc. - The statistics values in this list MUST be in time order, with the oldest one first and the most recent one last. This applies both to sample intervals and to individual measurements during a specific sample interval. {{nopattern}} - - - - - - - {{nopattern}} - - - - - - - - Each entry is the number of RTSP protocol requests to start a VoD program display during the sample interval. - Only meaningful for VoD. - - - - - - - - - Each entry is the number of successful VoD attempts during the sample interval. An attempt is considered successful when the first I-frame is displayed by the client. - Only meaningful for VoD. - - - - - - - - - Each entry is the number of completed VoD requests during the sample interval. An attempt is defined successful if it continues until a RTSP protocol request to end the session is sent by the STB. - Only meaningful for VoD. - - - - - - - - - Each entry is the number of channel change failures. A channel change is considered as failed when the time period between a user channel change request and the display of the first I frame for this AVStream is above {{param|.ServiceMonitoring.MainStream.{i}.ChannelChangeFailureTimeout}}. - - - - - - - - - - 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 {{param|.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStatsNumberOfEntries}}. - - - - - - - - - - Enables or disables this Metric instance. - - - - - - - - The status of this Metric instance. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Indicates a unique identifier for this high-level metric. - - - - - - - - - - - This parameter is DEPRECATED and replaced by the {{param|MetricThreshold}} parameter and, if needed, several instances of {{object|.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.}}. - - - - - - - - - - This parameter is DEPRECATED and replaced by the {{param|MetricThreshold}} parameter and, if needed, several instances of {{object|.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.}}. - - - - - - - - - - Each entry is the number of seconds during which this high-level metric's data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * This high-level metric's data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - This parameter is DEPRECATED and replaced by the {{param|Metric}} parameter and, if needed, several instances of {{object|.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.}}. - - - - - - - - - - - This parameter is DEPRECATED and replaced by the {{param|Metric}} parameter and, if needed, several instances of {{object|.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.}}. - - - - - - - - - - - This parameter is DEPRECATED and replaced by the {{param|MetricFailures}} parameter and, if needed, several instances of {{object|.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.}}. - - - - - - - - This parameter is DEPRECATED and replaced by the {{param|MetricFailures}} parameter and, if needed, several instances of {{object|.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.}}. - - - - - - - - A time period measured in {{units}}. A new value for the high level metric is calculated every {{param}} seconds. - The value for {{param}} MUST be less than, or equal to, {{param|.ServiceMonitoring.SampleInterval}}. - {{param}} SHOULD be chosen such that {{param|.ServiceMonitoring.SampleInterval}} is an integer multiple of {{param}}. If not, the last metric sample interval in each sample interval MUST be shortened so that the last metric sample interval ends when the sample interval ends. - The value for {{param}} is algorithm-specific. - - - - - - - - - - The threshold value that controls the calculation of the {{param|MetricFailures}} parameter. - - - - - - - - - - Each entry is a high-level metric calculated for this AV stream during the sample interval as the average of the high level metric values calculated on a metric sample interval basis. The length of the metric sample interval is given by {{param|MetricSampleInterval}}. - The interpretation of the metric values is algorithm-specific; the only constraints are that values have to be numeric, in the range [0:65535] and that lower values indicate worse QoE than do higher values. - - - - - - - - - - - Counts the number of times (since the last time this ''MainStream'' and Sample statistics collection were both enabled) that a newly-calculated value of high-level metric {{param|Metric}} was less than or equal to {{param|MetricThreshold}}. - This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval. - - - - - - - - - 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 {{param|###.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. - - - - When set to true, clears the events from the event log and the value of {{param|Entry.{i}.SequenceNumber}} parameter is reset to the parameter's minimum value. - - - - - - - - {{numentries}} - - - - - - - - - This object represents an entry (e.g., start session, channel change) in the event log. - - - - - - - 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. - - - - - - - - - - Type of the event. The values for this parameter are vendor specific. - - - - - - - - Timestamp of the event. - - - - - - - - {{numentries}} - - - - - - - - - This object represents an instance of a parameter that is associated with the Entry object Instance. - - - - Name of the parameter (vendor-specific). - - - - - - - - Value of the parameter. - - - - - - - - - Global operations statistics. - - - - - Global operations total statistics. - - - - The time period in, {{units}}, between the first message (e.g. DHCP Discover) sent by the STB during boot-up and the first multicast I-frame for the default channel displayed by the STB. - - - - - - - - - - Minimum portal latency defined as the minimum time period, in {{units}}, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information. - - - - - - - - - - Maximum portal latency defined as the maximum time period, in {{units}}, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information. - - - - - - - - - - - Global operations sample statistics. - - - - Each entry is the minimum portal latency defined as the minimum time period, in {{units}}, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information during the sample interval. - - - - - - - - - - - Each entry is the maximum portal latency defined as the maximum time period, in {{units}}, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information during the sample interval. - - - - - - - - - - - Each entry is a colon separated list of time periods (in milliseconds) between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information. - A comma separates measurements made in different sample intervals, while a colon separates individual measurements within a specific sample interval. - If no PortalResponse measurements were made during a specific sample interval then this MUST be represented by an empty string. - Example: ,837:453:1234,759,,,923:698,,,1284 - Here there were no measurements during first sample interval, three during the second, one during the third, etc. - The statistics values in this list MUST be in time order, with the oldest one first and the most recent one last. This applies both to sample intervals and to individual measurements during a specific sample interval. {{nopattern}} - - - - - - - {{nopattern}} - - - - - - - - - Applications. - - - - Number of Service Provider instances. - - - - - - - - - Audience viewing statistics. - - - - Enables or disables collection of viewing statistics. Enabling collection of viewing statistics also resets the viewing statistics table. - - - - - - - - When set to {{true}} resets the viewing statistics table. Setting it to {{false}} has no effect. The value is not saved in device state and is always {{false}} when read. - Resetting statistics MUST reset all {{param|Channel.{i}.Duration}} parameters. - - - - - - - - Number of {{units}} since the Audience statistics were last enabled or reset. - - - - - - - - - - Number of instances of {{object|Channel}}. - - - - - - - - - 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). - - - - - - - - - - {{datatype|expand}} - - - - - - - - String describing the TV channel being displayed in the main screen. MUST be the value of the corresponding {{param|.AVStreams.AVStream.{i}.Name}} parameter. - - - - - - - - - - The cumulative duration of this channel in {{units}}. - - - - - - - - - - - Details of STB CDS Push logical internal parameters. - - - - It references the object instance dedicated to the CDS Push service. Example: “Device.Services.StorageService.1.LogicalVolume.1.Folder.1”. - - - - - - - - - - - {{numentries}} - - - - - - - - - Content Item instance table. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Unique Content Item reference as defined in {{bibref|TS102323}}, or {{bibref|RFC4078}}. - - - - - - - - Version number of the stored content item (a content item could be updated with a new version e.g. in case of errors in the video preventing the play out). - - - - - - - - - - - When set to {{true}}, deletes this Content Item instance. The value is not saved in device state and is always {{false}} when read. - - - - - - - - - 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. - - - - It references the object instance dedicated to the CDS Pull service. Example: “Device.Services.StorageService.1.LogicalVolume.1.Folder.1”. - - - - - - - - - - - {{numentries}} - - - - - - - - - Content Item instance table. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Unique Content Item reference as defined in {{bibref|TS102323}}, or {{bibref|RFC4078}}. - - - - - - - - Version number of the stored content item (a content item could be updated with a new version e.g. in case of errors in the video preventing the play out). - - - - - - - - - - - When set to {{true}}, deletes this Content Item instance. The value is not saved in device state and is always {{false}} when read. - - - - - - - - - Service Provider instance table. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Service Provider name. - - - - - - - - - - Service Provider domain URI. - - - - - - - - - - Service Provider’s Service Discovery Server. It MAY be configured in the format of IMS Public Service Identifier, or IP address or URL. - - - - - - - - - - Comma separated list of the BCG (Broadband Content Guide) server URLs the STB is currently retrieving IPTV service information from. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/test/tools/05-tr-135-1-4-1-usp-full.xml b/test/tools/05-tr-135-1-4-1-usp-full.xml deleted file mode 100644 index 329753f4..00000000 --- a/test/tools/05-tr-135-1-4-1-usp-full.xml +++ /dev/null @@ -1,8064 +0,0 @@ - - - - - - {{docname|STBService:1.4 for USP}} - {{appdate|September 2019}} - {{trname|TR-135a3}} - August 2015: - * Added objects for Service Monitoring of Events - September 2019: {{xmlref|tr-135-1-4-1-usp|Corrigendum 1}} - * Added USP support (split XML into common, CWMP and USP files) - - - - A non-volatile handle used to reference this instance. - '''This is intended only for use in protocol-independent "common" definitions, and MUST NOT be used in protocol-specific definitions.''' - - - - - - - - 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 {{bibref|TR-069|3.6.1}} and described in {{bibref|TR-069|Appendix II}}, 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. - - - - - - 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. - - - - - - The value is measured in ''dBm/1000'', i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm. - - - - - - - Indicates the availability of diagnostics data. Enumeration of: - {{enum}} - If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are {{enum|Requested}} and {{enum|Canceled}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to {{enum|Requested}}. - When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. - When the test is completed, the value of this parameter MUST be either {{enum|Complete}} (if the test completed successfully), or one of the ''Error'' values listed above. - If the value of this parameter is anything other than {{enum|Complete}}, the values of the results parameters for this test are indeterminate. - When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code ''8 DIAGNOSTICS COMPLETE'' in the Inform message. - After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}. - Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}}. - While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}}. - While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. - While the test is in progress, setting this parameter to {{enum|Canceled}} MUST result in the test being canceled and the value of this parameter being set to {{enum|None}}. If the CPE does not support the {{enum|Canceled}} value, it MUST return a SPV error with "Invalid Parameter value" (9007) to the ACS instead. - - - - - - - - - - - - The IEEE EUI 64-bit identifier as defined in {{bibref|IEEE_EUI64}}. The IEEE defined 64-bit extended unique identifier (EUI-64) is a concatenation of: - * The 24-bit (OUI-24) or 36-bit (OUI-36) company_id value assigned by the IEEE Registration Authority (IEEE-RA), and - * The extension identifier (40 bits for OUI-24 or 28 bits for OUI-36) assigned by the organization with that company_id assignment. - - - - - - - - - - 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 {{bibref|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 {{bibref|RFC4007|Section 6}}. - Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be represented as empty strings unless otherwise specified by the parameter definition. - - - - - - - - IPv4 address (or subnet mask). - Can be any IPv4 address that is permitted by the ''IPAddress'' data type. - - - - - - - - IPv6 address. - Can be any IPv6 address that is permitted by the ''IPAddress'' data type. - - - - - - IPv4 or IPv6 routing prefix in Classless Inter-Domain Routing (CIDR) notation {{bibref|RFC4632}}. This is specified as an IP address followed by an appended "/n" suffix, where ''n'' (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the routing prefix. - * IPv4 example: 192.168.1.0/24 - * IPv6 example: 2001:edff:fe6a:f76::/64 - If the IP address part is unspecified or inapplicable, it MUST be {{empty}} unless otherwise specified by the parameter definition. In this case the IP prefix will be of the form "/n". - If the entire IP prefix is unspecified or inapplicable, it MUST be {{empty}} unless otherwise specified by the parameter definition. - - - - - - - - IPv4 address prefix. - Can be any IPv4 prefix that is permitted by the ''IPPrefix'' data type. - - - - - - - - - IPv6 address prefix. - Can be any IPv6 prefix that is permitted by the ''IPPrefix'' data type. - - - - - - A JSON Object as defined in {{bibref|RFC7159|Section 4}}. - - - - - - - All MAC addresses are represented as strings of 12 hexadecimal digits (digits 0-9, letters A-F or a-f) displayed as six pairs of digits separated by colons. Unspecified or inapplicable MAC addresses MUST be represented as empty strings unless otherwise specified by the parameter definition. - - - - - - - - - - A 32-bit statistics parameter, e.g. a byte counter. - This data type SHOULD NOT be used for statistics parameters whose values might become greater than the maximum value that can be represented as an ''unsignedInt'' (i.e. 0xffffffff, referred to below as ''maxval''). ''StatsCounter64'' SHOULD be used for such parameters. - The value ''maxval'' indicates that no data is available for this parameter. In the unlikely event that the actual value of the statistic is ''maxval'', the CPE SHOULD return ''maxval - 1''. - The actual value of the statistic might be greater than ''maxval''. Such values SHOULD wrap around through zero. - The term ''packet'' is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame. - - - - - - - A 64-bit statistics parameter, e.g. a byte counter. - This data type SHOULD be used for all statistics parameters whose values might become greater than the maximum value that can be represented as an ''unsignedInt''. - The maximum value that can be represented as an ''unsignedLong'' (i.e. 0xffffffffffffffff) indicates that no data is available for this parameter. - The term ''packet'' is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame. - - - - - - - Universally Unique Identifier. See {{bibref|RFC4122}}. - - - - - - - - - Uniform Resource Identifier. See {{bibref|RFC3986}}. - - - - - - - - Uniform Resource Name. See {{bibref|RFC3986}} (URI) and {{bibref|RFC8141}} (''urn'' URI scheme). - - - - - - - Uniform Resource Locator. See {{bibref|RFC3986}} (URI), {{bibref|IANA-uri-schemes}}, and individual URI scheme RFCs such as {{bibref|RFC7252}} (''coap'', ''coaps'') and {{bibref|RFC7230}} (''http'', ''https''). - - - - - - The ZigBee 16-bit network address (NWK) as defined in {{bibref|ZigBee2007}}. The address is assigned to a device by the network layer and used by the network layer for routing messages between devices. - - - - - - - - - - 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. - - - - - - E-AC-3 - Digital Audio Compression (AC-3) Standard, Rev. B, document number A/52B - ATSC - June 2005 - - - DGTVi D-Book v1.0 - Compatible receivers for the Italian market - Sep 2004 - - - HDMI - High-Definition Multimedia Interface 1.4a - March 2010 - - - 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/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/IEC 13818-1 (2nd edition, 2000) - Information technology - Generic coding of moving picture and associated audio information: Systems - ISO/IEC - 2000 - - - ISO/IEC 13818-3 (2nd edition, 1998) - Information technology - Generic coding of moving picture and associated audio information: Audio - ISO/IEC - 1998 - - - 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/IEC 14496-3:2001 - Information technology - Coding of Audio-Visual objects - Part 3: Audio - ISO/IEC - 2001 - - - 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/IEC 23003-1:2007 - Information technology - MPEG audio technologies - Part 1: MPEG Surround - ISO/IEC - 2007 - - - RFC 1350 - The TFTP Protocol (Revision 2) - IETF - RFC - https://tools.ietf.org/html/rfc1350 - - - RFC 2228 - FTP Security Extensions - IETF - RFC - https://tools.ietf.org/html/rfc2228 - - - RFC 2326 - Real Time Streaming Protocol (RTSP) - IETF - RFC - https://tools.ietf.org/html/rfc2326 - - - RFC 2960 - Stream Control Transmission Protocol (SCTP) - IETF - RFC - https://tools.ietf.org/html/rfc2960 - - - RFC 3066 - Tags for the Identification of Languages - IETF - RFC - https://tools.ietf.org/html/rfc3066 - - - RFC 3376 - Internet Group Management Protocol (IGMP) Version 3 - IETF - RFC - https://tools.ietf.org/html/rfc3376 - - - RFC 3550 - RTP: A Transport Protocol for Real-Time Applications - IETF - RFC - July 2003 - https://tools.ietf.org/html/rfc3550 - - - RFC 4078 - The TV-Anytime Content Reference Identifier (CRID) - IETF - RFC - https://tools.ietf.org/html/rfc4078 - - - RFC 4122 - A Universally Unique IDentifier (UUID) URN Namespace - IETF - RFC - 2005 - https://tools.ietf.org/html/rfc4122 - - - RFC 4340 - Datagram Congestion Control Protocol (DCCP) - IETF - RFC - https://tools.ietf.org/html/rfc4340 - - - RFC 4585 - Extended RTP Profile for Real-time Transport Control Protocol (RTCP)-Based Feedback (RTP/AVPF) - IETF - RFC - https://tools.ietf.org/html/rfc4585 - - - RFC 4588 - RTP Retransmission Packet Format - IETF - RFC - https://tools.ietf.org/html/rfc4588 - - - SMPTE 20022-1 Application Layer Forward Error Correction - - - Simple Object Access Protocol (SOAP) 1.1 - W3C - https://www.w3.org/TR/2000/NOTE-SOAP-20000508 - - - S/PDIF - Sony/Philips Digital InterFace IEC-958 - IEC - - - SSH File Transfer Protocol - https://tools.ietf.org/wg/secsh/draft-ietf-secsh-filexfer - - - TR-106 Amendment 1 - Data Model Template for TR-069-Enabled Devices - Broadband Forum - Technical Report - November 2006 - https://www.broadband-forum.org/technical/download/TR-106_Amendment-1.pdf - - - TR-106 Amendment 8 - Data Model Template for CWMP Endpoints and USP Agents - Broadband Forum - Technical Report - May 2018 - https://www.broadband-forum.org/technical/download/TR-106_Amendment-8.pdf - - - TR-135 Amendment 3 - Data Model for a TR-069 Enabled STB - Broadband Forum - Technical Report - November 2012 - https://www.broadband-forum.org/technical/download/TR-135.pdf - - - TR-140 - TR-069 Data Model for Storage Service Devices - Broadband Forum - Technical Report - https://www.broadband-forum.org/technical/download/TR-140.pdf - - - ETSI TS 102 034 - Digital Video Broadcasting (DVB); Transport of MPEG-2 Based DVB Services - ETSI - - - ETSI TS 102 323 - Digital Video Broadcasting (DVB); Carriage and signalling of TV-Anytime information - in DVB transport streams - ETSI - - - SMPTE VC-1 - Compressed Video Bitstream Format and Decoding Process, document number 421M - SMPTE, Television - 2006 - - - - - - Number of entries in the {{object|STBService}} table. - - - - - - - - The top-level object for an STB CPE. - - - - - - - Enables or disables this {{object}} instance. - - - - - - - - {{datatype|expand}} - - - - - - - - - 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. - - - - Maximum number of simultaneously active AV streams supported by the STB. - A value of -1 indicates no specific limit on the number of active streams. - A value of 0, while not strictly illegal, would indicate an STB that doesn't support AV streams, which is extremely unlikely. - - - - - - - - - - Maximum number of simultaneously active AV players supported by the STB. An AV player is associated with a presentation device (such as a TV set). - Note that this is the strict maximum but, depending on the AV streams to be decoded, a given STB may not always have the resources to run all of these AV players, e.g. it might be able to decode one main picture and one PIP in standard definition, but just a main picture and no PIP in high definition. - A value of -1 indicates no specific limit on the number of active players. - A value of 0, while not strictly illegal, would indicate an STB that doesn't support AV players, which is extremely unlikely. - - - - - - - - - - - Front-end capabilities. - - - - - Capabilities of the DVB-T receiver. - - - - Maximum number of simultaneous active AV streams supported by the DVB-T FrontEnd. - A value of -1 indicates no specific limit on the number of active streams. - - - - - - - - - - Maximum number of logical channels that can be contained in a Service List Database. - A value of -1 indicates no specific limit on the number of logical channels. - - - - - - - - - - - IP front-end capabilities. - - - - Maximum number of simultaneous active AV streams supported by the IP FrontEnd. - A value of -1 indicates no specific limit on the number of active streams. - - - - - - - - - - Maximum number of simultaneous active Inbound AV streams supported by the IP FrontEnd. - A value of -1 indicates no specific limit on the number of active streams. - - - - - - - - - - Maximum number of simultaneous active Outbound AV streams supported by the IP FrontEnd. - A value of -1 indicates no specific limit on the number of active streams. - - - - - - - - - - Supported streaming control protocols. - - - - - - - supports RTSP {{bibref|RFC2326}} - - - - - supports IGMPv1 {{bibref|RFC3376}} - - - - - supports IGMPv2 and lower versions {{bibref|RFC3376}} - - - - - supports IGMPv3 and lower versions {{bibref|RFC3376}} - - - - - supports DSM-CC {{bibref|ISO/IEC13818-6}} - - - - - - - - Network protocols supported for AV streaming. - - - - - - - - - {{bibref|RFC2960}} - - - - - {{bibref|RFC4340}} - - - - - {{bibref|RFC3550}} - - - - - - - - - Transport control protocols supported for AV streaming in combination with RTP. - - - - - - - supports sending RTCP receiver reports as defined in {{bibref|RFC3550}} - - - - - as defined in {{bibref|RFC4585}} and {{bibref|RFC4588}} - - - - - as defined in {{bibref|SMPTE20022-1}} - - - - - - - - Network protocols supported for AV download. - - - - - - - - - - FTP/SSL {{bibref|RFC2228}} - - - - - SSH file transfer protocol {{bibref|SSH-FTP}} - - - - - {{bibref|RFC1350}} - - - - - - - - AV multiplex types supported by the front end. - - - - - - - - {{bibref|ISO/IEC11172-1}} - - - - - {{bibref|ISO/IEC13818-1}} - - - - - {{bibref|ISO/IEC13818-1}} - - - - - {{bibref|ISO/IEC13818-1}} - - - - - - - - Describes the maximum de-jittering buffer size, in {{units}}, supported by the STB. - A value of -1 indicates no specific limit on the buffer size. - - - - - - - - - - - - PVR capabilities. - - - - Maximum number of AV streams that the PVR can simultaneously record and playback. For example a time shift, consisting of a record and a play back is considered as 2 streams. - A value of -1 indicates no specific limit on the number of streams. - - - - - - - - - - Maximum number of AV streams that the PVR can simultaneously record. - A value of -1 indicates no specific limit on the number of streams. - - - - - - - - - - Maximum number of AV streams that the PVR can simultaneously play back. - A value of -1 indicates no specific limit on the number of streams. - - - - - - - - - - Maximum time delay, in {{units}}, that the PVR time-shift mode can support. - A value of -1 indicates no specific limit on the time delay. - - - - - - - - - - - - Audio decoder capabilities. - - - - Audio standards supported by this STB. - - - - - - - {{bibref|ISO/IEC11172-3}} - - - - - {{bibref|ISO/IEC11172-3}} - - - - - {{bibref|ISO/IEC13818-3}} - - - - - {{bibref|ISO/IEC13818-3}} - - - - - - - - Low Complexity {{bibref|ISO/IEC13818-3}} - - - - - Low Complexity {{bibref|ISO/IEC14496-3}} - - - - - Main Profile {{bibref|ISO/IEC14496-3}} - - - - - Scalable AAC {{bibref|ISO/IEC14496-3}} - - - - - High Efficiency Profile Level 2 {{bibref|ISO/IEC14496-3}} - - - - - {{bibref|ISO/IEC23003-1}} - - - - - Dolby Digital (AC-3) {{bibref|AC-3}} - - - - - Dolby Digital Plus {{bibref|AC-3}} - - - - - Digital Theatre System - - - - - - - - - - Video decoder capabilities. - - - - Video standards supported by this STB. - - - - - - - {{bibref|ISO/IEC13818-1}} - - - - - {{bibref|ISO/IEC13818-6}} - - - - - Same as MPEG4 AVC and H.264 {{bibref|ISO/IEC14496-10}} - - - - - {{bibref|VC-1}} - - - - - - - - - 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. - - - - Audio Standards supported by the Player when associated with MPEG2 Part 2 Video. - - - - - - - - - - - Number of instances of {{object|ProfileLevel}}. - - - - - - - - - Table to describe the set of profiles and levels combinations supported by the STB when MPEG2 Part 2 is used as video standard. - {{keys}} The table MUST include a distinct entry for each supported combination of these parameters. - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Identifier of the MPEG2 Part 2 profile. - - - - - - Simple Profile - - - - - Main Profile - - - - - SNR Scalable - - - - - Spatially Scalable - - - - - High Profile - - - - - - - - - Identifier of the MPEG2 part 2 level. - - - - - - Low Level - - - - - Main Level - - - - - High-1440 - - - - - High Level - - - - - - - - The maximum decoding capability for this video standard in {{units}}. This strictly depends on the profile and level selected. - - - - - - - - - - - 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. - - - - Audio Standards supported by the Player when associated with MPEG4 Part 2 video. - - - - - - - - - - - Number of instances of {{object|ProfileLevel}}. - - - - - - - - - Table to describe the set of profiles and levels combinations supported by the STB when MPEG4 Part 2 is used as video standard. - {{keys}} The table MUST include a distinct entry for each supported combination of these parameters. - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Identifier of the MPEG4 Part 2 profile. - - - - - - - - - - - - - - - - - - - - - - - - - - - - Identifier of the MPEG4 Part 2 level. - - - - - - - - - - - - - - - - - The maximum decoding capability for this video standard in {{units}}. This strictly depends on the profile and level selected. - - - - - - - - - - - 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. - - - - Audio Standards supported by the Player when associated with MPEG4 Part 10 video. - - - - - - - - - - - Number of instances of {{object|ProfileLevel}}. - - - - - - - - - Table to describe the set of profiles and levels combinations supported by the STB when MPEG4 Part 10 is used as video standard. - {{keys}} The table MUST include a distinct entry for each supported combination of these parameters. - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Supported MPEG4 Part 10 profiles. - - - - - - - - - - - - - - - - - Supported MPEG4 Part 10 Levels. - - - - - - - - - - - - - - - - - - - - - - - - - - The maximum decoding capability for this video standard in {{units}}. This strictly depends on the profile and level selected. - - - - - - - - - - - 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. - - - - Audio Standards supported by the Player when associated with SMPTE-VC-1 video. - - - - - - - - - - - Number of instances of {{object|ProfileLevel}}. - - - - - - - - - Table to describe the set of profiles and levels combinations supported by the STB when SMPTE-VC-1 is used as video standard. - {{keys}} The table MUST include a distinct entry for each supported combination of these parameters. - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Identifier of the SMPTE-VC-1 profile. - - - - - - Simple Profile - - - - - Main Profile - - - - - Advanced Profile - - - - - - - - Identifier of the SMPTE-VC-1 level. - - - - - - Low Level - - - - - Medium Level - - - - - High Level - - - - - Advanced Profile only - - - - - Advanced Profile only - - - - - Advanced Profile only - - - - - Advanced Profile only - - - - - Advanced Profile only - - - - - - - - The maximum decoding capability for this video standard in {{units}}. This strictly depends on the profile and level selected. - - - - - - - - - - - Audio output capabilities. The audio output stage may include selecting output formats, selecting output connectors, and copy protection. - - - - Supported audio output formats. {{enum}} - Note that these refer to supported output formats and not to physical connectors. - - - - - - - - - - - - - modulated analog signals on coax - - - - - - - - - Video output capabilities. The video output stage may include selecting output formats, selecting output connectors, and copy protection. - - - - Analog composite video standards supported for video output. This applies only to CVBS video output. - - - - - - - - - - - - - - - - - - - - - - - - - - Supported video output formats. {{enum}} - Note that these refer to supported output formats and not to physical connectors. - - - - - - - - same as Y/C - - - - - - RGB with Sync on Green - - - - - RGB with external Sync - - - - - - - modulated analog signals on coax - - - - - - - - Supported version of Macrovision digital content protection standard. - - - - - - - - - - Supported version of HDCP digital content protection standard. - - - - - - - - - - Each entry is a supported display format and MUST be in the form of “x:y”, such as for example “4:3, 16:9, 14:9". {{nopattern}} - - - - - - - {{nopattern}} - - - - - - - - - This object describes the characteristics of the HDMI interface, if any. - - - - Video resolutions supported for the HDMI video output. {{enum}} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Indicates whether the STB is supporting HDMI-CEC features as described in {{bibref|HDMI}}. - - - - - - - - Indicates whether the STB is supporting the 3D video formats mandated by {{bibref|HDMI}}. - - - - - - - - - This object describes the characteristics of the Content Download System, if any. - - - - Capability of providing a CDS Push service for the operator initiated download of content items to local storage via a broadband IP connection. - - - - - - - - Capability of providing a CDS Pull service for the user initiated download of content items to a local storage via a broadband IP connection. - - - - - - - - - This object describes the characteristics of the Conditional Access, if any. - - - - Unique identifiers (e.g. commercial names) of supported CA systems. - - - - - - - - - - - - This object describes the characteristics of the Digital Rights Management, if any. - - - - Unique identifiers (e.g. commercial names) of supported DRM systems. - - - - - - - - - - - - This object describes the capabilities of the {{object|.ServiceMonitoring}} object. - - - - Supported service types, each of which relates to an AV stream source. {{enum}} - Note that none of the standard service types cover LAN-sourced IP streams. - - - - - - - WAN-sourced IPTV stream - - - - - WAN-sourced VoD stream - - - - - WAN-sourced IP stream (includes IPTV and VoD - - - - - WAN-sourced Force monitoring IP stream from {{param|.Components.FrontEnd.{i}.IP.ForceMonitor.URI}} (either IPTV or VoD). - - - - - Any WAN-sourced IP stream (includes user and force monitoring streams, IPTV and VoD). - - - - - Cable, e.g. DVB-C, Front End stream - - - - - DTT, e.g. DVB-T, Front End stream - - - - - Satellite, e.g. DVB-S, Front End stream - - - - - PVR play-out stream - - - - - - - - Maximum number of events of each applicable statistic that the STB is able to store for each sample interval. - A value of -1 indicates no specific maximum number of events. - - - - - - - - - - - Maximum number of AV Main streams for which the STB can simultaneously collect statistics. - A value of -1 indicates no specific limit on the number of active streams. - - - - - - - - - - Minimum sample interval in {{units}} that the STB MUST be able to support. - A value of -1 indicates no specific minimum sample interval. - - - - - - - - - - - Maximum number of samples of each statistic that the STB is able to store and report. - A value of -1 indicates no specific maximum number of samples. - - - - - - - - - - The names of the supported high-level metrics. If a metric produces several different scores (e.g. an audio, a video, and an audiovisual score), then they MUST be explicitly named. Example (using "XYZ" as the name of the base metric): - "XYZAudio,XYZVideo,XYZAudiovisual". - - - - - - - - - - - Maximum number of event log entries that the STB is able to record for a MainStream object instance. - - - - - - - - - This object describes the capabilities of the {{object|.Applications.AudienceStats}} object. - - - - Maximum number of channels that the STB MUST support in the {{object|.Applications.AudienceStats}} object - A value of -1 indicates no specific limit on the number of channels. - - - - - - - - - - - Details of STB logical or physical internal components. Unlike the {{object|.Capabilities}} object, which is read-only and which doesn't describe individual instances, this object contains some writeable parameters. - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - - 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). - - - - - - - - - - Enables or disables this front-end. - - - - - - - - The status of this front-end. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this front-end. - - - - - - - - - - - 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 {{bibref|D-Book}}. - - - - Progression in {{units}} of the current scan. The value is undefined when a scan is not in progress. - - - - - - - - - - - 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 {{object|.Components.FrontEnd.{i}.DVBT.ServiceListDatabase}}. - - - - Input arguments. - - - - Frequency (in {{units}}) at which to start the scanning process. - - - - - - - - - - Frequency (in {{units}}) at which to stop the scanning process. - - - - - - - - - - - - Connect to a DVB-T logical channel. - - - - Input arguments. - - - - Logical channel number to connect to (the logical channel's preferred service will be connected to). - If a {{object|.ServiceMonitoring.MainStream}} instance with ''ServiceType'' = ''DTT'' is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance. - - - - - - - - - - Connect to a DVB-T service. - - - - Input arguments. - - - - DvbId of the service to connect to. - If a {{object|.ServiceMonitoring.MainStream}} instance with ''ServiceType'' = ''DTT'' is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance. - - - - - - - - - - - - - DVB-T modulation details. - - - - Indicates the current frequency in {{units}}. - The value of this parameter is undefined while installing the service list (see {{command|.Components.FrontEnd.{i}.DVBT.Install()}}). - - - - - - - - - - Indicates the channel bandwidth in use. - - - - - - - - - - - - Indicates the current constellation in use. - - - - - - - - - - - - Hierarchical parameter alpha. The higher the value of alpha, the more noise-immune the High Priority Modulation is. - - - - - - no hierarchy - - - - - - - - - - - Indicates the current code rate in use. Code rate applies to HP in case of hierarchical coding. - - - - - - - - - - - - - - Indicates the current code rate in use. Code rate applies to LP in case of hierarchical coding. - - - - - - Coding is not hierarchical - - - - - - - - - - - - - Indicates the current guard interval in use. - - - - - - - - - - - - - Indicates the number of carriers in an OFDM frame. - - - - - - - - - - - Signal/Noise ratio in the carrier band, measured in {{units}}. - - - - - - - - - - Bit Error Ratio before correction, expressed in multiples of 1e-6. - - - - - - - - Bit Error Ratio after correction, expressed in multiples of 1e-9. - - - - - - - - Indicates whether or not the tuner is locked on a frequency. - - - - - - - - - DVB-T Current service details. - - - - It represents the logical channel object instance for the current service, For example: ''.Components.FrontEnd.1.DVBT.-ServiceListDatabase.LogicalChannel.12''. - - - - - - - - - - - It represents the service object instance for the current service. For example: ''.Components.FrontEnd.1.DVBT.ServiceListDatabase.LogicalChannel.12.Service.1''. - - - - - - - - - - - - DVB-T service list database. - - - - Resets the service list database. - - - - - Total number of services defined in the service list database, i.e. the number of different DvbIds in the database. - - - - - - - - Number of logical channels in the service list database. - - - - - - - - - DVB-T logical channel information. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Logical channel number. - - - - - - - - Number of services associated with this logical channel. - - - - - - - - - DVB-T service information. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this service, e.g. read from the DVB service information metadata. - - - - - - - - - - DVB Triplet {{bibref|TS102034}} that uniquely identifies the service in the service list database. - The DVB Triplet is a 12-byte string that is a concatenation of 4 hexadecimal characters for each of the following: Original Network Id, Transport Stream Id, Service Id. For example: - * OriginalNetworkId = 8442 = 0x20FA - * TransportStreamId = 4 = 0x0004 - * ServiceId = 257 = 0x0101 - -> DvbId = ''20FA00040101'' - - - - - - - - - - Transmitter frequency (in {{units}}) for this service. - - - - - - - - - - Bit Error Ratio before correction, expressed in multiples of 1e-6 (indicates the quality of this service). - - - - - - - - Bit Error Ratio after correction, expressed in {{units}} (indicates the quality of this service). - - - - - - - - - - Signal/Noise ratio in the carrier band, measured in {{units}} (indicates the quality of this service). - - - - - - - - - - When set to {{true}}, identifies this as the preferred service for this logical channel and automatically sets {{param}} to {{false}} for other services associated with this logical channel. - When set to {{false}}, cancels this service's preferred status and causes the service with the lowest {{param|BER}} (best received quality) to become the preferred service for this logical channel. - Whenever frequencies are re-scanned, all {{param}} parameters are implicitly reset to {{false}}, i.e. a re-scan will always use the {{param|BER}} to determine preferred services, and will discard any past explicit overrides. - - - - - - - - - IP front-end details. This object will normally be present if and only if the front-end is an IP front-end. - - - - Number of {{object|Inbound}} instances. - - - - - - - - Number of {{object|Outbound}} instances. - - - - - - - - Number of {{object|Inbound}} AV streams currently active (i.e. with ''Status'' != ''Disabled'', which means audio or AV data are being processed). - - - - - - - - Number of {{object|Outbound}} AV streams currently active (i.e. with ''Status'' != ''Disabled'', which means audio or AV data are being processed). - - - - - - - - Force connection to a dedicated IP stream for test purposes. - - - - Input arguments. - - - - RFC 3986 URI that describes the service to connect to in the form: - * <trsp>://<addr>:<port>?StrCtrl=<strctrl>?StrTrspCtrl=<trspctrl>?MuxType=<muxtype> - where: - * '''<addr>''' is the IP address of the service source (for Unicast) or IGMP group (for Multicast). - * '''<port>''' is the associated TCP/UDP port. If not specified, the STB is assumed to know and use an appropriate default port. - * '''<trsp>''' is the streaming transport protocol and MUST be one of the values in {{param|.Capabilities.FrontEnd.IP.StreamingTransportProtocols}}, which SHOULD be converted to lower-case. - * '''<strctrl>''' is the streaming control protocol and MUST be one of the values in {{param|.Capabilities.FrontEnd.IP.StreamingControlProtocols}}. If not specified, no streaming control protocol is to be used. - * '''<trspctrl>''' is the streaming transport control protocol and MUST be one of the values in {{param|.Capabilities.FrontEnd.IP.StreamingTransportControlProtocols}}. If not specified, no streaming transport control protocol is to be used. - * '''<muxtype>''' is the multiplex type and MUST be one of the values in {{param|.Capabilities.FrontEnd.IP.MultiplexTypes}}. This tells the STB which multiplex type to expect. If not specified, the STB is assumed to know, or to be able to determine, the multiplex type. - Note that download protocols are not supported by the above syntax. However, the specified syntax is just a baseline, and STBs MAY support an extended syntax. - Example of Multicast MPEG2-TS over RTP with no transport control: - * rtp://224.112.15.18:3257?StrCtrl=IGMP?MuxType=MPEG2-TS - Example of Multicast MPEG2-TS over RTP with AL-FEC transport control: - * rtp://224.112.15.18:3257?StrCtrl=IGMP?StrTrspCtrl=AL-FEC?MuxType=MPEG2-TS - Example of Unicast MPEG2-TS over UDP with RTSP transport control: - * udp://174.146.35.12:3257?StrCtrl=RTSP?MuxType=MPEG2-TS - Example of Unicast raw AV over RTP with RTCP control and RTSP transport control: - * rtp://174.146.35.12:3257?StrCtrl=RTSP?StrTrspCtrl=RTCP?MuxType=None - If a {{object|.ServiceMonitoring.MainStream}} instance with ''ServiceType'' = ''IP'' or ''IPTV'' (or ''VoD'' if the URI accesses a VoD service) is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance. - - - - - - - - - - - - - Parameters related to RTCP receiver report generation as defined in {{bibref|RFC3550}}. - - - - Enables or disables RTCP receiver report generation. - - - - - - - - The status of RTCP receiver report generation. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - Transmission repeat interval, in {{units}}. - - - - - - - - - - - - Parameters related to RTP AVPF configuration as defined in {{bibref|RFC4585}} and {{bibref|RFC4588}}. - - - - Enables or disables RTP/AVPF receiver report generation. - When set to {{true}}, enables the error correction operation, immediately ({{enum|Forced|OperationMode}} mode) or automatically when necessary ({{enum|Auto|OperationMode}} mode). - When set to {{false}}, disables the error correction operation. - - - - - - - - The operation mode of the Error Correction mechanism. {{enum}} - In {{enum|Auto}} mode, when Error Correction is enabled, the STB decides whether or not to run the Error Correction operation (e.g. after an error analysis). - In {{enum|Forced}} mode, when Error Correction is enabled the STB MUST run the Error Correction operation. - - - - - - - - - - - The status of RTP/AVPF operation. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - {{enum|Auto|OperationMode}} mode and EC is running - - - - - {{enum|Auto|OperationMode}} mode and EC is not running and EC data are not buffered). Note: this is equivalent of "Disabled" but this "Disabled" state is caused by STB under auto mode, not be set by operator - - - - - {{enum|Auto|OperationMode}} mode and EC is not running but EC data are buffered - - - - - {{enum|Forced|OperationMode}} mode and Enabled - - - - - - - - - The status of RTP/AVPF receiver report generation. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - Time in {{units}} the receiver shall wait for a retransmitted packet before considering it to be lost. - - - - - - - - - - Minimum number of lost packets the receiver shall wait for before generating a retransmission request. - - - - - - - - Maximum time in {{units}} the receiver shall wait between a lost packet and the generation of a retransmission request. - - - - - - - - - - Maximum number of consecutive lost packets for which the receiver shall attempt recovery. - - - - - - - - - Parameters related to AL-FEC configuration as defined in {{bibref|SMPTE20022-1}}. - - - - Enables or disables FEC decoder operation. - When set to {{true}}, enables the FEC decoder operation, immediately ({{enum|Forced|OperationMode}} mode) or automatically when necessary ({{enum|Auto|OperationMode}} mode). - When set to {{false}}, disables the FEC decoder operation. - - - - - - - - The operation mode of the FEC decoder. {{enum}} - In {{enum|Auto}} mode, when Error Correction is enabled the STB decides whether or not to run the AL_FEC decoding (e.g. after an error analysis). - In {{enum|Forced}} mode, when Error Correction is enabled the STB MUST run the FEC decoding. - - - - - - - - - - - The status of FEC decoder operation. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - {{enum|Auto|OperationMode}} mode and EC is running - - - - - {{enum|Auto|OperationMode}} mode and EC is not running and EC data are not buffered). Note: this is equivalent of "Disabled", but this "Disabled" state is caused by STB under auto mode, not be set by operator - - - - - {{enum|Auto|OperationMode}} mode and EC is not running but EC data are buffered - - - - - {{enum|Forced|OperationMode}} mode and Enabled - - - - - - - - - - Parameters that are specific to IGMP clients when changing channels. - - - - Enables or disables all IGMP support on the receiver side of the CPE. - - - - - - - - Status of IGMP support on the receiver side of the CPE. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - Maximum number of group memberships allowed simultaneously. - For example, this would need to be at least 2 in order to support a Multicast-delivered main picture and a Multicast-delivered PIP. - - - - - - - - Maximum number of groups for which statistics will be tracked. - This relates only to the maintenance of statistics, and does not affect the operation of the STB. - - - - - - - - Controls logging of IGMP traffic. - The CPE MAY choose to throttle log entries, e.g. if joins and leaves are occurring at an excessive rate. - - - - - - - - Diffserv code point to be used for outgoing IGMP packets. - - - - - - - - - - VLAN ID (as defined in 802.1Q) to be used for outgoing IGMP packets. A value of -1 indicates the default value is to be used. - If either the {{param}} or {{param|EthernetPriorityMark}} is greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged. - - - - - - - - - - Ethernet priority code (as defined in 802.1D) to be used for outgoing IGMP packets. A value of -1 indicates the default value is to be used. - If either the {{param|VLANIDMark}} or {{param}} are greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged. - - - - - - - - - - The highest IGMP version supported by the IGMP Client. - - - - - - - - - - - - Robustness is a way of indicating how vulnerable the network is to lost packets. IGMP can recover from robustness minus 1 lost IGMP packets. - RFC 3376 specifies a default of 2. - - - - - - - - The number of {{units}} between repetitions of a host's initial report of membership in a group. - RFC 3376 specifies a default of 1s. - - - - - - - - - - - Number of entries in the {{object|ClientGroup}} table. - - - - - - - - Number of entries in the {{object|ClientGroupStats}} table. - - - - - - - - - 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. - - - - - - - - - - {{datatype|expand}} - - - - - - - - The IP multicast group address for which this entry contains information. - - - - - - - - Time elapsed in {{units}} since the multicast group has been a member on this interface. - - - - - - - - - - - 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. - - - - - - - - - - {{datatype|expand}} - - - - - - - - The IP multicast group address for which this entry contains information. - - - - - - - - Number of {{units}} since the beginning of the period used for collection of {{object|Total}} statistics. - Statistics SHOULD continue to be accumulated across CPE reboots, though this may not always be possible. - - - - - - - - - - Number of {{units}} since the beginning of the period used for collection of {{object|CurrentDay}} statistics. - The CPE MAY align the beginning of each {{object|CurrentDay}} interval with days in the UTC time zone, but is not required to do so. - Statistics SHOULD continue to be accumulated across CPE reboots, though this may not always be possible. - - - - - - - - - - Number of {{units}} since the beginning of the period used for collection of {{object|QuarterHour}} statistics. - The CPE MAY align the beginning of each {{object|QuarterHour}} interval with real-time quarter-hour intervals, but is not required to do so. - Statistics SHOULD continue to be accumulated across CPE reboots, though this may not always be possible. - - - - - - - - - - - Total statistics for this multicast group. - - - - Number of IGMP joins during this period. - - - - - - - - Number of IGMP leaves during this period. - - - - - - - - Maximum latency delay, in {{units}}, from the sending of a Join message for this group to the arrival of the first IP packet for this group during this period. - - - - - - - - - - - Current day statistics for this multicast group. - - - - Number of IGMP joins during this period. - - - - - - - - Number of IGMP leaves during this period. - - - - - - - - Maximum latency delay, in {{units}}, from the sending of a Join message for this group to the arrival of the first IP packet for this group during this period. - - - - - - - - - - - Current quarter hour statistics for this multicast group. - - - - Number of IGMP joins during this period. - - - - - - - - Number of IGMP leaves during this period. - - - - - - - - Maximum latency delay, in {{units}}, from the sending of a Join message for this group to the arrival of the first IP packet for this group during this period. - - - - - - - - - - - Parameters related to the de-jittering buffer configuration for all inbound IP streams. - - - - De-jittering buffer size, measured in {{units}}, on the receiver side of the CPE. The STB is responsible for converting this into the actual buffer size in ''bytes''. - - - - - - - - - - Describes the number of {{units}} worth of data that should be in the receiver side dejittering buffer before play-out can start. Typically this would be half of the buffer size. - - - - - - - - - - - Inbound IP streams currently entering the STB via this front-end. - - - - - - - - - - The status of this Inbound stream. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Unique human-readable name associated with this inbound IP instance. - - - - - - - - - - Network protocol currently used for controlling streaming of the source content, or {{empty}} if the content is not being streamed or is being streamed but is not being controlled. - - - - - - - - - - Network protocol currently used for streaming the source content, or an empty string if the content is not being streamed. - - - - - - - - - - Transport control protocol currently used for streaming the source content, or an empty string if the content is not being streamed. - - - - - - - - - - AV multiplex type currently used for the source content, or an empty string if the content is not being demultiplexed. - - - - - - - - - - Network protocol currently used for downloading the source content, or an empty string if the content is not being downloaded. - - - - - - - - - - IP address of the source of the current stream content. - - - - - - - - TCP or UDP port number of the source of the current stream content, or 0 if the content is not being delivered via IP or if not applicable. - - - - - - - - - - IP address of the destination of the current stream content, or {{empty}} if the content is not being delivered via IP. - - - - - - - - TCP or UDP port number of the destination of the current stream content, or 0 if the content is not being delivered via IP or if not applicable. - - - - - - - - - - RFC 3986 URI that indicates the current source (possibly including Multicast group and port, if relevant) of the stream content, or {{empty}} if the source is not known or cannot be represented as a URI. - For example, for a WAN-delivered stream this might be a content provider's URL, or for a LAN-delivered stream it might be an UPnP AV URN. - If specified, the URI MUST be consistent with the other source-related parameters. - - - - - - - - - - - Parameters related to an outbound IP stream. - - - - - - - - - - The status of this Outbound stream. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Unique human-readable name associated with this outbound IP instance. - - - - - - - - - - AV multiplex type currently used for the destination content, or an empty string if the content is not being demultiplexed. - - - - - - - - - - RFC 3986 URI that indicates the current destination (possibly including Multicast group and port, if relevant) of the stream content, or an empty string if the destination is not known or cannot be represented as a URI. - For example, this might be an UPnP AV URN. - - - - - - - - - - - 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 {{param|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. - - - - When set to {{true}}, forces the operation mode in ForceMonitor mode - When set to {{false}}, forces operation mode in Normal mode. - - - - - - - - Indicates the status of the statistic mode of operation. {{enum}} - - - - - - - - - - - Describes the service to connect to for force monitoring purposes with the same syntax as {{param|#.ServiceConnect().URI}}. - If a {{object|.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. - - - - - - - - - - - PVR details. This is a read-only object that exists only to reference PVR storage objects. - - - - Number of {{object|Storage}} instances. - - - - - - - - - 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. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Unique human-readable name associated with this storage instance. - - - - - - - - - - References the corresponding ''StorageService'' {{bibref|TR-140}} instance, or an object contained within such an instance, e.g. a ''PhysicalMedium'', ''LogicalVolume'' or ''Folder'' instance. - The value is the full hierarchical name of the corresponding object. Example: ''Device.Services.StorageService.1'' - - - - - - - - - - - Audio decoder instance table. It contains data representing the current status of the Audio decoder. - - - - - - - - - - Enables or disables this audio decoder. - - - - - - - - The status of this audio decoder. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this audio decoder. - - - - - - - - - - Audio standard currently being processed by this audio decoder, or an empty string if no audio standard is currently being processed. - - - - - - - - - - - Video decoder instance table. It contains data representing the current status of the video decoder. - - - - - - - - - - Enables or disables this video decoder. - - - - - - - - The status of this video decoder. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this video decoder. - - - - - - - - - - MPEG2 Part 2 profile and level object instance, or {{empty}} if MPEG2 Part 2 is not used. For example: - ''.Capabilities.VideoDecoder.MPEG2Part2.ProfileLevel.2'' - - - - - - - - - - - MPEG4 Part 2 profile and level object instance, or {{empty}} if MPEG4 Part 2 is not used). For example: - ''.Capabilities.VideoDecoder.MPEG4Part2.ProfileLevel.2'' - - - - - - - - - - - MPEG4 Part 10 profile and level object instance, or {{empty}} if MPEG4 Part 10 is not used. For example: - ''.Capabilities.VideoDecoder.MPEG4Part10.ProfileLevel.2'' - - - - - - - - - - - SMPTE-VC-1 profile and level object instance, or {{empty}} if SMPTE-VC-1 is not used. For example: - ''.Capabilities.VideoDecoder.SMPTEVC1.ProfileLevel.2'' - - - - - - - - - - - Indicates the native aspect ratio of the content available at this decoder. - - - - - - - - - - - - Audio output instance table. - - - - - - - - - - Enables or disables this audio output. - - - - - - - - The status of this audio output. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - i.e. Enabled and Muted - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this audio output. - - - - - - - - - - Currently active audio output format, or {{empty}} if no audio output format is currently active. - Note that this parameter refers to output formats and not to physical connectors. - - - - - - - - - - The audio level on this audio output in {{units}} (0 is quietest and 100 is loudest). This setting is independent of the mute status. - For some audio formats, the audio level is not meaningful, in which case this parameter SHOULD have a fixed value of 0. - - - - - - - - - - - SCART object instances associated with this audio output, or {{empty}} if not associated with any SCART object instances. For example: - * ''.Components.SCART.2'' - * ''.Components.SCART.2,.Components.SCART.3'' - - - - - - - - - - - - - Cancels this audio output's mute status. - - - - - - 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 {{bibref|SPDIF}}. - - - - - - - - - - Enables or disables the S/PDIF output. - - - - - - - - The status of this S/PDIF output. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this output. - - - - - - - - - - When set to {{true}}, forces the audio format over S/PDIF to be in PCM mode. - When set to {{false}}, let the compressed audio format be carried over S/PDIF (passthrough). - - - - - - - - When in Passthrough mode, the STB sends the audio stream over S/PDIF without decoding it. - - - - - - - - Audio delay value, in {{units}}, currently being applied to the audio stream on the S/PDIF interface. The audio delay is entered by the user via his local UI, when necessary for correcting the lipsync. - - - - - - - - - - - Video output instance table. - - - - - - - - - - Enables or disables this video output. - - - - - - - - The status of this video output. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Enables or disables the color bar display. - When set to {{true}}, the CPE MUST suspend the running service currently using the video output (e.g. IPTV broadcast reception) and MUST display the color bar. - When set to {{false}}, the CPE MUST resume the previousely running service. - This parameter MUST be always initialized with the value {{false}} on STB boot. - - - - - - - - Human-readable name associated with this Video output. - - - - - - - - - - The type of analog video standard currently in use or {{empty}} if no analog video standard is currently in use. - Note that this parameter applies only to the CVBS output format. - - - - - - - - - - Currently active video output format, or {{empty}} if no video output format is currently active. - Note that this parameter refers to output formats and not to physical connectors. - - - - - - - - - - Indicates the aspect ratio behaviour for display on monitors with an aspect ratio different from that of the content, which is specified in {{param|.Components.VideoDecoder.{i}.ContentAspectRatio}}. - - - - - - - DEPRECATED and replaced by following values - - - - - - - - DEPRECATED and replaced by following values - - - - - - - - - - Display format being connected to this VideoOutput. - This parameter is used by the STB to determine whether an aspect ratio conversion is required. - - - - - - - - - - Indicates whether Macrovision analog protection is being used on this video output. - The Macrovision version supported is indicated in {{param|.Capabilities.VideoOutput.Macrovision}}. - - - - - - - - Indicates whether HDCP is being used on this video output. - The HDCP version supported is indicated in {{param|.Capabilities.VideoOutput.HDCP}}. - - - - - - - - SCART object instances associated with this video output, or {{empty}} if not associated with any SCART object instances. For example: - * ''.Components.SCART.2'' - * ''.Components.SCART.2,.Components.SCART.3'' - - - - - - - - - - - - - - SCART configuration. This object allows configuration of the STB's AV switching. - - - - - - - - - - Enables or disables this SCART connector. - - - - - - - - The status of this SCART connector. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this connector. - - - - - - - - - - Enables or disables the Presence control signal (pin 8 of the SCART connector), an output from the STB to control the display device connected to the SCART. - When enabled (set to {{true}}) the STB MUST drive pin 8 to the appropriate level to indicate the output video format (SD or HD) to the connected device. - When disabled (set to {{false}}) the STB MUST NOT drive pin 8. - - - - - - - - - HDMI instance table. This object allows configuration of the STB’s HDMI output. - - - - - - - - - - Enables or disables the HDMI output. - - - - - - - - The status of HDMI output. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this output. - - - - - - - - - - The resolution mode of the HDMI output. - In {{enum|Auto}} mode, the resolution is automatically set at the best format via HDMI protocols. - In {{enum|Manual}} mode, the resolution to be applied to the HDMI output is given by the ResolutionValue parameter. - - - - - - - - - - - When {{param|ResolutionMode}} is set to {{enum|Manual|ResolutionMode}} mode, a write action configures the resolution to be applied to the HDMI output, - When {{param|ResolutionMode}} is set to {{enum|Auto|ResolutionMode}}, a write action as no effect. - A read action provides the current resolution of the HDMI output. - - - - - - - - - - - HDMI connected display device configuration. This object provides parameters from the HDMI connected device if any. - - - - The status of the connected HDMI Display device. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - Human-readable name associated with this display device. - - - - - - - - - - Enhanced Extended Display Information Data (E-EDID) retrieved from the connected HDMI device. - - - - - - - - - - Each entry is a supported resolution of the connected HDMI device and MUST be one element of {{param|.Capabilities.HDMI.SupportedResolutions}}. - - - - - - - - - Preferred connected HDMI device resolution format. - - - - - - - - - - Video latency, in {{units}}, being applied in the connected HDMI device. This parameter is extracted from the E-EDID and can be used to compensate the video latency to preserve lipsync. - - - - - - - - - - When set to {{true}}, indicates the connected HDMI device is supporting HDMI-CEC features. - When set to {{false}}, indicates the connected HDMI device does not support HDMI CEC. - - - - - - - - When set to {{true}}, indicates the connected display device supports auto lip synchronization. This mode consists in communicating over HDMI, the delay to be applied by the STB to the audio in order to preserve the lip sync. - - - - - - - - When set to {{true}}, indicates the connected display device supports the 3D video formats mandated by {{bibref|HDMI}}. - - - - - - - - - This object describes the characteristics of the Conditional Access, if any. - - - - - - - - - - Enables or disables this CA system. - - - - - - - - The status of this CA system. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Indicates a unique identifier (e.g. the commercial name: ''La 7 piu'', ''Mediaset Premium'') for this CA system. - - - - - - - - - - - Path name of the smart card reader object instance containing the smart card (if any) associated with this CA system. - The value MUST be {{empty}} (if not associated with a smart card) or else be the full path name of the corresponding smart card reader object. For example: - ''Device.SmartCardReader.1'' - - - - - - - - - - - This object describes the characteristics of the Digital Rights Management, if any. - - - - - - - - - - Enables or disables this DRM system. - - - - - - - - The status of this DRM system. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Indicates a unique identifier (e.g. the commercial name: ''La 7 piu'', ''Mediaset Premium'') for this DRM system. - - - - - - - - - - - Path name of the smart card reader object instance containing the smart card (if any) associated with this DRM system. - The value MUST be {{empty}} (if not associated with a smart card) or else be the full path name of the corresponding smart card reader object. For example: - ''Device.SmartCardReader.1'' - - - - - - - - - - - AV Streams object. If more than one AV stream can be active at a time, it may contain several {{object|AVStream}} instances. - - - - Number of AV streams currently active (i.e. with ''Status'' != ''Disabled'', which means audio or AV data are being processed). - - - - - - - - Number of {{object|AVStream}} instances. - - - - - - - - - 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). - - - - - - - - - - The status of this AV stream. {{enum}} - An AV stream is disabled if any of the referenced objects are disabled. - If an AV stream is disabled then the values of other AV stream parameters are not significant. - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - Unspecified error - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this stream, e.g. read from the DVB service information metadata. - - - - - - - - - - Indicates whether this stream is using the PVR and, if so, the PVR state. {{enum}} - PVR record state can be inferred from whether the stream has an input FrontEnd: if so and {{param}} is not {{enum|Disabled}}, the PVR is recording. - - - - - - PVR not used by this stream - - - - - PVR playback not active - - - - - PVR playback active (and playing) - - - - - PVR playback active (paused) - - - - - PVR playback active (fast forward) - - - - - PVR playback active (rewind) - - - - - - - - Input FrontEnd object instance associated with this AV stream, or {{empty}} if not associated with a FrontEnd object). For example: - ''.Components.FrontEnd.2'' - - - - - - - - - - - Inbound IP stream object instance associated with the FrontEnd for this AV stream, or {{empty}} if the inbound stream is not delivered over IP. For example: - ''.Components.FrontEnd.2.IP.Inbound.3'' - - - - - - - - - - - Outbound IP stream object instance associated with the output FrontEnd for this AV stream (which is always the IP FrontEnd), or {{empty}} if the outbound stream is not delivered over IP. For example: - ''.Components.FrontEnd.2.IP.Outbound.3'' - - - - - - - - - - - Audio Decoder object instance associated with this AV stream, or {{empty}} if not associated with an Audio Decoder object. For example: - ''.Components.AudioDecoder.2'' - - - - - - - - - - - Video Decoder object instance associated with this AV stream, or {{empty}} if not associated with a Video Decoder object. For example: - ''.Components.VideoDecoder.2'' - - - - - - - - - - - CA system object instance associated with this AV stream, or {{empty}} if not associated with a CA object. For example: - ''.Components.CA.2'' - - - - - - - - - - - DRM system object instance associated with this AV stream, or {{empty}} if not associated with a DRM object. For example: - ''.Components.DRM.2'' - - - - - - - - - - - - AV Players object. If more than one AV player can be active at a time, it may contain several {{object|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. - - - - Number of AV players currently active (i.e. with ''Status'' != ''Disabled'', which means the {{object|AVPlayer}} is processing an audio or AV stream). - - - - - - - - Number of {{object|AVPlayer}} instances. - - - - - - - - Human-readable string, as specified in {{bibref|RFC3066}}, describing the audio language that SHOULD be used by the STB when receiving a multi-language audio multiplex. - {{empty}} indicates that there is no preferred audio language. - - - - - - - - - - Human-readable string, as specified in {{bibref|RFC3066}}, describing the subtitling language that SHOULD be used by the STB when receiving multi-language subtitling. - A value of ''None'' indicates that no subtitling is required. - {{empty}} indicates that there is no preferred subtitling language. - - - - - - - - - - Aspect ratio behaviour preference for display on monitor. - If non-empty, the string MUST be one of the .Components.VideoOutput.{i}. AspectRatioBehaviour values. - - - - - - - - - - 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. - - - - - - List of AV Player objects. Each item is one particular AV player being processed by the STB. - - - - - - - - - - Enables or disables this AV player. - - - - - - - - The status of this AV player. {{enum}} - If an AV player is disabled then the values of other AV player parameters are not significant. - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Human-readable name associated with this AV player. - - - - - - - - - - Human-readable string, as specified in {{bibref|RFC3066}}, describing the audio language being currently processed by the AV player. - - - - - - - - - - The status of subtitling for this AV player. {{enum}} - Subtitles are assumed to be shown only on the main screen. - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - Human-readable string, as specified in {{bibref|RFC3066}}, describing the subtitling language being currently processed by the AV player. - Subtitles are assumed to be shown only on the main screen. - - - - - - - - - - Audio output object instances associated with this AV player, or {{empty}} if not associated with any audio output object instances. For example: - ''.Components.AudioOutput.2'' - - - - - - - - - - - - - Video output object instances associated with this AV player, or {{empty}} if not associated with any video output object instances. For example: - ''.Components.VideoOutput.2'' - - - - - - - - - - - - - AV stream object instance associated with this AV player that is being sent to the main screen, or {{empty}} if not associated with an AV stream object. For example: - ''.AVStreams.AVStream.2'' - - - - - - - - - - - AV stream object instances associated with this AV player that are being displayed as Picture In Picture (PIP), or {{empty}} if not associated with any PIP AV stream objects. For example: - * ''.AVStreams.AVStream.2'' - * ''.AVStreams.AVStream.2,.AVStreams.AVStream.3'' - - - - - - - - - - - - - - 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 {{object|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 {{bibref|TR-135|I.3}} for non-normative explanation of the operation of the ''ServiceMonitoring'' object. - - - - Enables or disables collection of Sample statistics. - When collection of Sample statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. - - - - - - - - Indicates availability of Sample statistics. {{enum}} - The {{enum|Trigger}} value is only used for triggering the ACS to fetch the collected data and can only be used when {{param|FetchSamples}} is in the range [1:{{param|ReportSamples}}]. - The transition from {{enum|Enabled}} -> {{enum|Trigger}} -> {{enum|Enabled}} MUST be instantaneous and so will result in only a single value change for notification purposes. - - - - - - Collection is disabled - - - - - Collection is enabled - - - - - Collection is enabled and the ACS should now fetch the collected data - - - - - - - - The sample interval in {{units}}. Each statistic is measured over this sample interval. - The STB MAY reject a request to set {{param}} to less than {{param|.Capabilities.ServiceMonitoring.MinSampleInterval}}. - Sample intervals MUST begin every {{param}} seconds, with no delay between samples. - If {{param}} is changed while collection of Sample statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. - For example, if {{param|ReportSamples}} is 24 and {{param}} is 3600 (an hour), the STB can store up to a day's worth of samples for each statistic. - - - - - - - - - - - The number of samples that the STB can store and report for each statistic. - The STB MUST permit {{param}} to be set to any value in the range from 1 to {{param|.Capabilities.ServiceMonitoring.MaxReportSamples}}. - If {{param}} is changed while collection of Sample statistics is enabled, the STB will truncate or extend its statistics buffers as appropriate, but statistics collection MUST NOT otherwise be affected. - For example, if {{param}} is 24 and {{param|SampleInterval}} is 3600 (an hour), the STB can store up to a day's worth of samples for each statistic. - - - - - - - - - - The number of event measurements of each applicable statistic that the STB is able to store for each sample interval. - The STB MUST permit {{param}} to be set to any value in the range from 1 to {{param|.Capabilities.ServiceMonitoring.MaxEventsPerSampleInterval}}. - If {{param}} is changed while collection of Sample statistic is enabled, the STB will truncate or extend its event measurement buffers as appropriate, but event measurement collection MUST NOT otherwise be affected. - For example, if {{param|ReportSamples}} is 24 and {{param|SampleInterval}} is 3600 (an hour), and {{param}} is 60, the STB can store up 60 event measurements per hour, or in total 1440 event measurements per day. - - - - - - - - - - If collection of Sample statistics is enabled and {{param}} is in the range [1:{{param|ReportSamples}}] then {{param|SampleState}} MUST transition from {{enum|Enabled|SampleState}} -> {{enum|Trigger|SampleState}} -> {{enum|Enabled|SampleState}} on completion of every {{param}} sample intervals. Otherwise, this transition MUST NOT occur. - For example, if {{param|ReportSamples}} is 25 and {{param}} is 24, then the STB will store 25 values for each statistic and the above {{param|SampleState}} transition will occur every 24 sample intervals, which means that the ACS could delay for up to two sample intervals before reading the stored values and would still not miss any samples (see also {{param|ForceSample}}). - - - - - - - - An absolute time reference in UTC to determine when sample intervals will complete. Each sample interval MUST complete at this reference time plus or minus an integer multiple of {{param|SampleInterval}}. - This time reference also determines when the {{param|SampleState}} {{enum|Enabled|SampleState}} -> {{enum|Trigger|SampleState}} -> {{enum|Enabled|SampleState}} transitions that are controlled by {{param|FetchSamples}} will occur. If collection of Sample statistics is enabled and {{param|FetchSamples}} is in the range [1:{{param|ReportSamples}}] then each such {{param|SampleState}} transition MUST occur at this reference time plus or minus an integer multiple of {{param|FetchSamples}} * {{param|SampleInterval}} (the fetch interval). - {{param}} is used only to set the "phase" of the sample and fetch intervals. The actual value of {{param}} can be arbitrarily far into the past or future. - If {{param}} is changed while collection of Sample statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. - The Unknown Time value defined in {{bibref|TR-106a1}} indicates that no particular time reference is specified. That is, the STB MAY locally choose the time reference, and is required only to adhere to the specified sample and fetch intervals. - If absolute time is not available to the STB, its sample and fetch interval behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value. - For example, if {{param|SampleInterval}} is 3600 (an hour) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then sample intervals will complete on each UTC hour (00:00, 01:00, 02:00 etc). - If, in addition, {{param|FetchSamples}} is 24, then the fetch interval is 86400 (a day) and {{param|SampleState}} {{enum|Enabled|SampleState}} -> {{enum|Trigger|SampleState}} -> {{enum|Enabled|SampleState}} transitions will occur every day at UTC midnight. - Note that, if {{param}} is set to a time other than the Unknown Time, the first sample interval (which has to begin immediately) will almost certainly be shorter than {{param|SampleInterval}}). This is why {{param}} is defined in terms of when sample intervals complete rather than start. - - - - - - - - The absolute time at which the sample interval for the first stored sample (for each statistic) started. - - - - - - - - The absolute time at which the sample interval for the last stored sample (for each statistic) ended. - If {{param|ForceSample}} has been used to force statistics for the current sample to be calculated and updated in the data model, then {{param}} MUST be updated to reflect the actual time over which stored data was collected. - - - - - - - - Number of {{object|MainStream}} instances. - - - - - - - - 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. - - - - - - - - Forces statistics for the current sample to be calculated and updated in the data model. - If this is the first time that {{command}} 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 {{param|ReportEndTime}} and all ''SampleSeconds'' parameters MUST be updated accordingly. - If this is not the first time that {{command}} has been invoked during the current sample interval, then the new values that were added as described in the previous paragraph, and the {{param|ReportEndTime}} and all ''SampleSeconds'' parameters, MUST be updated accordingly. - Note that {{command}} 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 {{command}} was invoked during the sample interval then the new values that were added as described above, and the {{param|ReportEndTime}} and all ''SampleSeconds'' parameters, will be updated accordingly. In other words, the partial sample data that was created when {{command}} was invoked will be updated one last time at the end of the sample interval. - - - - - - 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. {{param|.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. - - - - - - - - - - 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 {{param|##.ServiceMonitoring.EventCollectionEnable}} to be {{true}}. - - - - - - - - Total and Sample statistics and event collection status for this object instance. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - Time based UUID {{bibref|RFC4122|Section 4.2}} that is the identifier for the associated {{param|AVStream}} parameter when available to the device. - - - - - - - - {{datatype|expand}} - - - - - - - - Service type associated with this main stream instance, or {{empty}} if this instance is disabled. - The STB MUST reject a request that would result in a given AV stream contributing to more than one {{object|.ServiceMonitoring.MainStream}} instance, e.g. it would reject a request to enable simultaneous collection of both IPTV and IP statistics, or to collect IPTV statistics on more than one instance. - - - - - - - - - - Main AV stream object instance currently associated with this ''ServiceMonitoring'' main stream instance. For example: - ''.AVStreams.AVStream.2'' - Note that, during the period of time over which Sample statistics are stored, this ''ServiceMonitoring'' main stream instance might be associated with many different ''AVStream'' instances. This parameter just provides information about which ''AVStream'' is currently being monitored. - - - - - - - - - - - Minimum number of consecutive received packets after the end of an RTP Loss Event. A Loss Event is defined as as a sequence of lost packets, possibly including islands of received packets. Each island consists of up to - ({{param}} - 1) received packets (a sequence of {{param}} received packets terminates the Loss Event, and so is not an island). - - - - - - - - The minimum distance required between error events before an RTP Loss Event is considered severe. Used in the calculation of ''SevereLossIndexCount'' and ''SevereLossIndexCountBeforeEC''. - - - - - - - - The minimum value for the count of lost packets per RTP Loss Event before the count of lost packets is considered severe. Used in the calculation of ''SevereLossLengthCount'' and ''SevereLossLengthCountBeforeEC''. - - - - - - - - Time period, in {{units}}, between a user channel change request (defined as the instant of transmission of the relevant control protocol message (IGMP JOIN or RTSP SETUP) or a tuner command in case of DTT), and the display of the first I frame for the current AVStream, above which a channel change is considered as failed. - - - - - - - - - - {{list}} Definition of the histogram intervals for counting loss events according to their size (in {{units}}). Each value indicates the maximum value of the interval. For example, "1,2,4,8," defines the five intervals: 1 packet lost, 2 packets, 3 or 4 packets, 5 to 8 packets and 9 or more packets. (No value after the last comma means no upper bound.) - If this parameter is set to an empty string, no PacketsLostByEvent stats will be collected. - - - - - - - - - - - - {{list}} Definition of the histogram intervals for counting loss events according to their delay (in {{units}}) after the preceding loss event. Each value indicates the maximum value of the interval. For example, "10,20,50,100,1000,60000,3600000," defines the intervals up to 10 ms, to 20 ms, to 50 ms, to 100 ms, to 1 s, to 1 mn, to 1 h and more than 1 h. (No value after the last comma means no upper bound.) - If this parameter is set to an empty string, no DelayBetweenLossEvents stats will be collected. - - - - - - - - - - - - {{list}} Definition of the histogram intervals for counting severe loss events according to their duration (in {{units}}). Each value indicates the maximum value of the interval. For example, "50,100,500,1000,2000,5000,10000,120000," defines the intervals up to 50 ms, to 100 ms, to 500 ms, to 1 s, to 2 s etc. (No value after the last comma means no upper bound.) - If this parameter is set to an empty string, no DurationSevereLossEvents stats will be collected. - - - - - - - - - - - - - Total statistics since this ''ServiceMonitoring'' main stream instance was last enabled or Total statistics were last reset. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than the {{param|ResetTime}}, for several reasons, including the STB was not receiving any data (Standby mode without force monitoring). - - - - - - - - Number of seconds since the Total statistics were last enabled or reset for this ''ServiceMonitoring'' main stream instance. - - - - - - - - Resets Total statistics for this ''ServiceMonitoring'' main stream instance. - - - - - - Total de-jittering statistics for this ''ServiceMonitoring'' main stream instance. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}, for several reasons, including: - * Any of the reasons for which the {{param}} values might be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}. - * De-jittering data collection is not appropriate or possible for this AV stream. - - - - - - - - Total time, in {{units}}, for which the playout was stopped due to buffer issues (empty or too low level) for this AV stream. - - - - - - - - - - Total number of times the receive jitter buffer has overrun for this AV stream. - - - - - - - - Total number of times the receive jitter buffer has underrun for this AV stream. - - - - - - - - - Total TCP statistics for this ServiceMonitoring main stream instance. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}, for several reasons, including: - * Any of the reasons for which the {{param}} values might be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}. - * TCP data collection is not appropriate or possible for this AV stream. - - - - - - - - Total number of TCP packets correctly received for this AV stream. - - - - - - - - Total number of TCP packets being retransmitted for this AV stream. - - - - - - - - Total number of bytes received for this AV stream. - - - - - - - - - Total RTP statistics for this ''ServiceMonitoring'' main stream instance. - If no EC is applied the ''BeforeEC'' statistics provide the same values as the corresponding statistics, e.g. when there is no EC, {{param|PacketsReceivedBeforeEC}} = {{param|PacketsReceived}}. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}, for several reasons, including: - * Any of the reasons for which the {{param}} values might be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}. - * RTP data collection is not appropriate or possible for this AV stream. - - - - - - - - Total number of RTP packets expected for this AV stream as described in {{bibref|RFC3550|A.3}}. - - - - - - - - Total number of packets discarded at the RTP layer for this AV stream because they were too late for playout, regardless of their being out of sequence or not. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - Total number of packets out of sequence at the RTP level for this AV stream, regardless of their being too late for playout or not. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - Total number of RTP packets received for this AV stream. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - Total number of RTP packets received for this AV stream. - These statistics are collected before any EC, if available, is applied. - - - - - - - - Total number of RTP packets lost for this stream. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - Total number of RTP packets lost for this stream. - These statistics are collected before any EC, if available, is applied. - - - - - - - - {{list}} Total number of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by {{param|##.PacketsLostByEventHistogramIntervals}}. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - {{list}} Total number of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by {{param|##.PacketsLostByEventHistogramIntervals}}. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Total number of Loss Events for this stream. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - Total number of Loss Events for this stream. - These statistics are collected before any EC, if available, is applied. - - - - - - - - {{list}} Total number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by {{param|##.DelayBetweenLossEventsHistogramIntervals}}. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - {{list}} Total number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by {{param|##.DelayBetweenLossEventsHistogramIntervals}}. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Total number of Loss Events closer than ''SevereLossMinDistance''. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - Total number of Loss Events closer than ''SevereLossMinDistance''. - These statistics are collected before any EC, if available, is applied. - - - - - - - - Total number of Loss Events longer than ''SevereLossMinLength''. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - Total number of Loss Events longer than ''SevereLossMinLength''. - These statistics are collected before any EC, if available, is applied. - - - - - - - - {{list}} Total number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by {{param|##.DurationSevereLossEventsHistogramIntervals}}. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - {{list}} Total number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by {{param|##.DurationSevereLossEventsHistogramIntervals}}. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Total number of RTP/AVPF retransmission timeouts ({{bibref|RFC4585}}, {{bibref|RFC4588}}) - If RTP/AVPF is not used this parameter does not increment - - - - - - - - - Total MPEG2-TS statistics for this ''ServiceMonitoring'' main stream instance. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}, for several reasons, including: - * Any of the reasons for which the {{param}} values might be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}. - * MPEG2 TS data collection is not appropriate or possible for this AV stream. - - - - - - - - Total number of MPEG2-TS packets received for this AV stream. - - - - - - - - Total number of MPEG2-TS packets with an invalid transport sync byte received for this AV stream. - Not meaningful when MPEG2-TS is transported over IP. - - - - - - - - Total number of MPEG2-TS Loss of Synchronization Events for this AV stream. - Not meaningful when MPEG2-TS is transported over IP. - - - - - - - - Total number of MPEG2-TS Discontinuity errors that have been captured for this AV stream. This parameter accumulates all of the discontinuities observed for all currently monitored PIDs. - These statistics are collected when no CA decryption scheme is in use or after any CA decryption if in use. - - - - - - - - Total number of MPEG2-TS Discontinuity errors that have been captured for this AV stream. This parameter accumulates all of the discontinuities observed for all currently monitored PIDs. - These statistics are collected before any CA decryption scheme, if used, is applied. - - - - - - - - - Total video decoder application layer statistics for this ''ServiceMonitoring'' main stream instance. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}, for several reasons, including: - * Any of the reasons for which the {{param}} values might be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}. - * Video Decoder data collection is not appropriate or possible for this AV stream. - - - - - - - - The latest frame rate at which the STB played out the video content for this AV stream. Also the reported rate will be rounded off to the nearest integer. - - - - - - - - The number of video frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream. - - - - - - - - The number of video frames that could not be reproduced by the STB for this AV stream. - - - - - - - - The number of video frames that were reproduced by the STB for which some information was missing and loss concealment was applied for this AV stream. - - - - - - - - The number of I frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream. - - - - - - - - The number of I frames that could not be reproduced by the STB for this AV stream. - - - - - - - - The number of I frames that were reproduced by the STB for which some information was missing and loss concealment applied for this AV stream. - - - - - - - - The number of P frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream. - - - - - - - - The number of P frames that could not be reproduced by the STB for this AV stream. - - - - - - - - The number of P frames that were reproduced by the STB for which some information was missing and loss concealment applied for this AV stream. - - - - - - - - The number of B frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream. - - - - - - - - The number of B frames that could not be reproduced by the STB for this AV stream. - - - - - - - - The number of B frames that were reproduced by the STB for which some information was missing and loss concealment applied for this AV stream. - - - - - - - - The number of AV resynchronizations that were performed by the STB for this AV stream. - - - - - - - - - Total audio decoder application layer statistics for this ''ServiceMonitoring'' main stream instance. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}, for several reasons, including: - * Any of the reasons for which the {{param}} values might be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}. - * Audio Decoder data collection is not appropriate or possible for this AV stream. - - - - - - - - The number of audio frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream. - - - - - - - - The number of audio decoding errors detected for this AV stream. - - - - - - - - - Total video response statistics for this ''ServiceMonitoring'' main stream instance. - - - - The number of seconds during which data was collected for this AV stream since last reset - Each statistics category (Dejittering, RTP etc) has its own {{param}} parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. - Individual {{param}} values can be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}, for several reasons, including: - * Any of the reasons for which the {{param}} values might be less than {{param|.ServiceMonitoring.MainStream.{i}.Total.ResetTime}}. - * Video response data collection is not appropriate or possible for this AV stream. - - - - - - - - Number of channel change failures. A channel change is considered as failed when the time period between a user channel change request and the display of the first I frame for this AVStream is above {{param|.ServiceMonitoring.MainStream.{i}.ChannelChangeFailureTimeout}}. - - - - - - - - Each entry represents a channel for which a channel change failed. Channels MAY be described as IP address, URL or Service names as appropriate. Only last 10 failures are required to be reported. - - - - - - - - - Minimum time period, in {{units}}, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. - - - - - - - - - - Maximum time period, in {{units}}, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. - - - - - - - - - - Total number of RTSP protocol requests to start a VoD program display. - Only meaningful for VoD. - - - - - - - - Total number of successful VoD attempts. An attempt is considered successful when the first I-frame is displayed by the client. - Only meaningful for VoD. - - - - - - - - Total number of completed VoD requests. An attempt is defined successful if it continues until a RTSP protocol request to end the session is sent by the STB. - Only meaningful for VoD. - - - - - - - - Minimum time period (in {{units}}) between the instant of transmitting an IGMP JOIN command or an RTSP SETUP command, and the display of the first I frame for this AV stream. - - - - - - - - - - Maximum time period (in {{units}}) between the instant of transmitting an IGMP JOIN command or an RTSP SETUP command, and the display of the first I frame for this AV stream. - - - - - - - - - - - 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. - Each comma-separated list can contain up to {{param|##.ReportSamples}} statistics values. When the list is full, each new value causes the oldest one to be discarded. - Some comma-separated lists contain terms that are comma-separated lists themselves and are used to store measurements on an event basis. These sub-lists can contain up to {{param|.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. - - - - Each entry is the number of seconds during which data was collected for this AV stream during the sample interval. Each statistics category (Dejittering, RTP etc) has its own ''SampleSeconds'' parameter, which indicates the number of seconds during which data was collected for that statistics category during the sample interval. - Individual ''SampleSeconds'' values can be less than the ''SampleInterval'', for several reasons, including: - * The STB was not receiving any data for the corresponding ServiceType for all or part of the sample interval. - * ''TimeReference'' has been set to a time other than the Unknown Time and the current sample interval started part of the way through a scheduled sample interval. - * ''ForceSample'' has been used to force statistics for the current sample to be calculated and updated in the data model. - - - - - - - - - - - Each entry is the total number of times that a channel change (or other potentially disruptive event) occurred for this AV stream during the sample interval. - - - - - - - - - Each entry is a Boolean that indicates whether the PVR, with a non-zero time-shift, was used at any time for this AV stream during the sample interval. - - - - - - - - - Number of {{object|HighLevelMetricStats}} instances. - - - - - - - - - De-jittering Sample statistics for this ''ServiceMonitoring'' main stream instance. - - - - Each entry is the number of seconds during which de-jittering data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * De-jittering data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - Each entry is the total number of times the receive jitter buffer has overrun for this AV stream during the sample interval. - - - - - - - - - Each entry is the total number of times the receive jitter buffer has underrun for this AV stream during the sample interval. - - - - - - - - - Each entry is the time period, in {{units}}, for which the playout was stopped due to buffer issues (empty or too low level) for this AV stream during the sample interval. - - - - - - - - - - - - TCP sample statistics for this ''ServiceMonitoring'' main stream instance. - - - - Each entry is the number of seconds during which de-jittering data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * TCP data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - Each entry is the total number of TCP packets received for this AV stream during the sample interval. - - - - - - - - - Each entry is the total number of TCP packets being retransmitted this AV stream.during the sample interval. - - - - - - - - - Each entry is the total number of bytes received for this AV stream.during the sample interval. - - - - - - - - - - RTP Sample statistics for this ''ServiceMonitoring'' main stream instance. - If no EC is applied the ''BeforeEC'' statistics provide the same values as the corresponding statistics, e.g. when there is no EC, {{param|PacketsReceivedBeforeEC}} = {{param|PacketsReceived}}. - - - - Each entry is the number of seconds during which RTP data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * RTP data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - Each entry is the total number of RTP packets expected for this AV stream during the sample interval as described in {{bibref|RFC3550|A.3}}. - - - - - - - - - Each entry is the number of packets that were discarded at the RTP layer for this AV stream during the sample interval because they were too late for playout, regardless of their being out of sequence or not. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - Each entry is the number of packets out of sequence at the RTP level for this AV stream during the sample interval, regardless of their being too late for playout or not. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - Each entry is the total number of RTP packets received for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - Each entry is the total number of RTP packets received for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Each entry is the number of RTP/AVPF retransmission timeouts ({{bibref|RFC4585}}, {{bibref|RFC4588}}) for this AV stream during the sample interval. - - - - - - - - - Each entry is the total number of RTP packets lost for this AV stream during the sample interval. - Calculated by looking for missing RTP sequence headers. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - Each entry is the total number of RTP packets lost for this AV stream during the sample interval. - Calculated by looking for missing RTP sequence headers. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - {{list}} Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by {{param|##.PacketsLostByEventHistogramIntervals}}. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - {{list}} Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by {{param|##.PacketsLostByEventHistogramIntervals}}. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Each entry is the total number of Loss Events for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - Each entry is the total number of Loss Events for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - {{list}} Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by {{param|##.DelayBetweenLossEventsHistogramIntervals}}. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - {{list}} Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by {{param|##.DelayBetweenLossEventsHistogramIntervals}}. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Each entry is the total number of Loss Events that occurred at a distance shorter than ''SevereLossMinDistance'' from the previous Loss Event for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - Each entry is the total number of Loss Events that occurred at a distance shorter than ''SevereLossMinDistance'' from the previous Loss Event for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Each entry is the average distance in {{units}} between consecutive Loss Events for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - - - Each entry is the average distance in {{units}} between consecutive loss events for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - - - Each entry is the length in {{units}} of the shortest distance between consecutive Loss Events for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - - - Each entry is the length in {{units}} of the shortest distance between consecutive Loss Events for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - - - Each entry is the total number of Loss Events with length in RTP packets greater than ''SevereLossMinLength'' for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - Each entry is the total number of Loss Events with length in RTP packets greater than ''SevereLossMinLength'' for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - {{list}} Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by {{param|##.DurationSevereLossEventsHistogramIntervals}}. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - {{list}} Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by {{param|##.DurationSevereLossEventsHistogramIntervals}}. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - Each entry is the length in {{units}} of the longest Loss Event for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - - - Each entry is the length in {{units}} of the longest Loss Event for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - - - Each entry is the average length in {{units}} of Loss Events for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - - - Each entry is the average length in {{units}} of Loss Events for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - - - Each entry is the length in {{units}} of the shortest RTP Loss Event for this AV stream during the sample interval. - These statistics are collected when no EC is applied or after any EC if available. - - - - - - - - - - - Each entry is the length in {{units}} of the shortest RTP Loss Event for this AV stream during the sample interval. - These statistics are collected before any EC, if available, is applied. - - - - - - - - - - - - MPEG2-TS Sample statistics for this ''ServiceMonitoring'' main stream instance. - - - - Each entry is the number of seconds during which MPEG2-TS data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * MPEG2-TS data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - Each entry is the total number of MPEG2-TS packets received for this AV stream during the sample interval. - - - - - - - - - Each entry is the total number of good MPEG2-TS packets removed from the buffer for this AV stream during the sample interval. - Packets received minus packets drained provides an indication how close the buffer came to over or under running during the sample interval. - - - - - - - - - Each entry is the total number of MPEG2-TS packets with an invalid transport sync byte for this AV stream during the sample interval. - Not meaningful when MPEG2-TS is transported over IP. - - - - - - - - - Each entry is the total number of MPEG2-TS Loss of Synchronization Events for this AV stream during the sample interval. - Not meaningful when MPEG2-TS is transported over IP. - - - - - - - - - Each entry is the total number of MPEG2-TS Discontinuity errors that were captured for this AV stream during the sample interval. - These statistics are collected when no CA decryption scheme is in use or after any CA decryption if in use. - - - - - - - - - Each entry is the total number of MPEG2-TS Discontinuity errors that were captured for this AV stream during the sample interval. - These statistics are collected before any CA decryption scheme, if used, is applied. - - - - - - - - - - Video decoder Sample statistics for this ''ServiceMonitoring'' main stream instance. - - - - Each entry is the number of seconds during which video decoder data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * Video Decoder data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - Each entry is the last frame rate at which the STB played out the video content for this AV stream during the sample interval. . Also the reported rate will be rounded off to the nearest integer. - - - - - - - - - Each entry is the number of video frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of video frames that could not be reproduced by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of video frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment was applied. - - - - - - - - - Each entry is the number of I frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of I frames that could not be reproduced by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of I frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment applied. - - - - - - - - - Each entry is the number of P frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of P frames that could not be reproduced by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of P frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment applied. - - - - - - - - - Each entry is the number of B frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of B frames that could not be reproduced by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of B frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment applied. - - - - - - - - - Each entry is the number of AV resynchronizations that were performed by the STB for this AV stream during the sample interval. - - - - - - - - - - Audio decoder Sample statistics for this ''ServiceMonitoring'' main stream instance. - - - - Each entry is the number of seconds during which audio decoder data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * Audio decoder data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - Each entry is the number of audio frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval. - - - - - - - - - Each entry is the number of audio decoding errors detected by the STB for this AV stream during the sample interval. - - - - - - - - - - Video response Sample statistics for this ''ServiceMonitoring'' main stream instance. - - - - Each entry is the number of seconds during which video response data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * Video response data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - Each entry is the time period (in {{units}}) between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame, computed as the average of the VideoSystemResponse events that occured for this AV stream during the sample interval. - - - - - - - - - - - Each entry is the minimum time period (in {{units}}) between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame for this AV stream during the sample interval. - - - - - - - - - - - Each entry is the maximum time period (in {{units}}) between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame for this AV stream during the sample interval. - - - - - - - - - - - Each entry is the time period, in {{units}}, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream, computed as the average of the VoDControlResponse events that occured for this AV stream during the sample interval. Only measured when started from a non-play state, i.e. either idle or paused. - - - - - - - - - - - Each entry is the minimum time period, in {{units}}, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. - - - - - - - - - - - Each entry is the maximum time period, in {{units}}, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. - - - - - - - - - - - Each entry is a colon separated list of time periods in milliseconds between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. - A comma separates measurements made in different sample intervals, while a colon separates individual measurements within a specific sample interval. - If no VoDControlResponse measurements were made during a specific sample interval then this MUST be represented by an empty string. - Example: ,837:453:1234,759,,,923:698,,,1284 - Here there were no measurements during first sample interval, three during the second, one during the third, etc. - The statistics values in this list MUST be in time order, with the oldest one first and the most recent one last. This applies both to sample intervals and to individual measurements during a specific sample interval. {{nopattern}} - - - - - - - {{nopattern}} - - - - - - - - Each entry is a colon separated list of time periods in milliseconds between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame that occurred for this AV stream during the sample interval. - A comma separates measurements made in different sample intervals, while a colon separates individual measurements within a specific sample interval. - If no VideoSystemResponse measurements were made during a specific sample interval then this MUST be represented by an empty string. - Example: ,837:453:1234,759,,,923:698,,,1284 - Here there were no measurements during first sample interval, three during the second, one during the third, etc. - The statistics values in this list MUST be in time order, with the oldest one first and the most recent one last. This applies both to sample intervals and to individual measurements during a specific sample interval. {{nopattern}} - - - - - - - {{nopattern}} - - - - - - - - Each entry is the number of RTSP protocol requests to start a VoD program display during the sample interval. - Only meaningful for VoD. - - - - - - - - - Each entry is the number of successful VoD attempts during the sample interval. An attempt is considered successful when the first I-frame is displayed by the client. - Only meaningful for VoD. - - - - - - - - - Each entry is the number of completed VoD requests during the sample interval. An attempt is defined successful if it continues until a RTSP protocol request to end the session is sent by the STB. - Only meaningful for VoD. - - - - - - - - - Each entry is the number of channel change failures. A channel change is considered as failed when the time period between a user channel change request and the display of the first I frame for this AVStream is above {{param|.ServiceMonitoring.MainStream.{i}.ChannelChangeFailureTimeout}}. - - - - - - - - - - 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 {{param|.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStatsNumberOfEntries}}. - - - - - - - - - - Enables or disables this Metric instance. - - - - - - - - The status of this Metric instance. {{enum}} - The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Indicates a unique identifier for this high-level metric. - - - - - - - - - - - This parameter is DEPRECATED and replaced by the {{param|MetricThreshold}} parameter and, if needed, several instances of {{object|.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.}}. - - - - - - - - - - This parameter is DEPRECATED and replaced by the {{param|MetricThreshold}} parameter and, if needed, several instances of {{object|.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.}}. - - - - - - - - - - Each entry is the number of seconds during which this high-level metric's data was collected for this AV stream during the sample interval. - Individual {{param}} values can be less than the sample interval, for several reasons, including: - * Any of the reasons for which the {{param|.ServiceMonitoring.MainStream.{i}.Sample.SampleSeconds}} values might be less than the sample interval. - * This high-level metric's data collection is not appropriate or possible for this AV stream. - - - - - - - - - - - This parameter is DEPRECATED and replaced by the {{param|Metric}} parameter and, if needed, several instances of {{object|.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.}}. - - - - - - - - - - - This parameter is DEPRECATED and replaced by the {{param|Metric}} parameter and, if needed, several instances of {{object|.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.}}. - - - - - - - - - - - This parameter is DEPRECATED and replaced by the {{param|MetricFailures}} parameter and, if needed, several instances of {{object|.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.}}. - - - - - - - - This parameter is DEPRECATED and replaced by the {{param|MetricFailures}} parameter and, if needed, several instances of {{object|.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.}}. - - - - - - - - A time period measured in {{units}}. A new value for the high level metric is calculated every {{param}} seconds. - The value for {{param}} MUST be less than, or equal to, {{param|.ServiceMonitoring.SampleInterval}}. - {{param}} SHOULD be chosen such that {{param|.ServiceMonitoring.SampleInterval}} is an integer multiple of {{param}}. If not, the last metric sample interval in each sample interval MUST be shortened so that the last metric sample interval ends when the sample interval ends. - The value for {{param}} is algorithm-specific. - - - - - - - - - - The threshold value that controls the calculation of the {{param|MetricFailures}} parameter. - - - - - - - - - - Each entry is a high-level metric calculated for this AV stream during the sample interval as the average of the high level metric values calculated on a metric sample interval basis. The length of the metric sample interval is given by {{param|MetricSampleInterval}}. - The interpretation of the metric values is algorithm-specific; the only constraints are that values have to be numeric, in the range [0:65535] and that lower values indicate worse QoE than do higher values. - - - - - - - - - - - Counts the number of times (since the last time this ''MainStream'' and Sample statistics collection were both enabled) that a newly-calculated value of high-level metric {{param|Metric}} was less than or equal to {{param|MetricThreshold}}. - This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval. - - - - - - - - - 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 {{param|###.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. - - - - Clears the events from the event log and the value of {{param|Entry.{i}.SequenceNumber}} parameter is reset to the parameter's minimum value. - - - - - {{numentries}} - - - - - - - - - This object represents an entry (e.g., start session, channel change) in the event log. - - - - - - - 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. - - - - - - - - - - Type of the event. The values for this parameter are vendor specific. - - - - - - - - Timestamp of the event. - - - - - - - - {{numentries}} - - - - - - - - - This object represents an instance of a parameter that is associated with the Entry object Instance. - - - - Name of the parameter (vendor-specific). - - - - - - - - Value of the parameter. - - - - - - - - - Global operations statistics. - - - - - Global operations total statistics. - - - - The time period in, {{units}}, between the first message (e.g. DHCP Discover) sent by the STB during boot-up and the first multicast I-frame for the default channel displayed by the STB. - - - - - - - - - - Minimum portal latency defined as the minimum time period, in {{units}}, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information. - - - - - - - - - - Maximum portal latency defined as the maximum time period, in {{units}}, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information. - - - - - - - - - - - Global operations sample statistics. - - - - Each entry is the minimum portal latency defined as the minimum time period, in {{units}}, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information during the sample interval. - - - - - - - - - - - Each entry is the maximum portal latency defined as the maximum time period, in {{units}}, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information during the sample interval. - - - - - - - - - - - Each entry is a colon separated list of time periods (in milliseconds) between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information. - A comma separates measurements made in different sample intervals, while a colon separates individual measurements within a specific sample interval. - If no PortalResponse measurements were made during a specific sample interval then this MUST be represented by an empty string. - Example: ,837:453:1234,759,,,923:698,,,1284 - Here there were no measurements during first sample interval, three during the second, one during the third, etc. - The statistics values in this list MUST be in time order, with the oldest one first and the most recent one last. This applies both to sample intervals and to individual measurements during a specific sample interval. {{nopattern}} - - - - - - - {{nopattern}} - - - - - - - - - Applications. - - - - Number of Service Provider instances. - - - - - - - - - Audience viewing statistics. - - - - Enables or disables collection of viewing statistics. Enabling collection of viewing statistics also resets the viewing statistics table. - - - - - - - - Number of {{units}} since the Audience statistics were last enabled or reset. - - - - - - - - - - Number of instances of {{object|Channel}}. - - - - - - - - Resets the viewing statistics table. - Resetting statistics MUST reset all {{param|Channel.{i}.Duration}} parameters. - - - - - - 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). - - - - - - - - - - {{datatype|expand}} - - - - - - - - String describing the TV channel being displayed in the main screen. MUST be the value of the corresponding {{param|.AVStreams.AVStream.{i}.Name}} parameter. - - - - - - - - - - The cumulative duration of this channel in {{units}}. - - - - - - - - - - - Details of STB CDS Push logical internal parameters. - - - - It references the object instance dedicated to the CDS Push service. Example: “Device.Services.StorageService.1.LogicalVolume.1.Folder.1”. - - - - - - - - - - - {{numentries}} - - - - - - - - - Content Item instance table. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Unique Content Item reference as defined in {{bibref|TS102323}}, or {{bibref|RFC4078}}. - - - - - - - - Version number of the stored content item (a content item could be updated with a new version e.g. in case of errors in the video preventing the play out). - - - - - - - - - - - Deletes this Content Item instance. - - - - - - 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. - - - - It references the object instance dedicated to the CDS Pull service. Example: “Device.Services.StorageService.1.LogicalVolume.1.Folder.1”. - - - - - - - - - - - {{numentries}} - - - - - - - - - Content Item instance table. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Unique Content Item reference as defined in {{bibref|TS102323}}, or {{bibref|RFC4078}}. - - - - - - - - Version number of the stored content item (a content item could be updated with a new version e.g. in case of errors in the video preventing the play out). - - - - - - - - - - - Deletes this Content Item instance. - - - - - - Service Provider instance table. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Service Provider name. - - - - - - - - - - Service Provider domain URI. - - - - - - - - - - Service Provider’s Service Discovery Server. It MAY be configured in the format of IMS Public Service Identifier, or IP address or URL. - - - - - - - - - - Comma separated list of the BCG (Broadband Content Guide) server URLs the STB is currently retrieving IPTV service information from. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/tools/Dockerfile b/tools/Dockerfile index d3976a5f..8c1b5fbf 100644 --- a/tools/Dockerfile +++ b/tools/Dockerfile @@ -2,7 +2,7 @@ FROM ubuntu:22.04 LABEL maintainer="vivek.dutta@iopsys.eu" LABEL build="docker build -t bbfdm-tools ." -LABEL run="docker run -it --rm -v ${PWD}/..:/builds/bbfdm bbfdm-tools" +LABEL run="docker run -it --rm -v PWD/..:/builds/bbfdm bbfdm-tools" RUN \ apt-get update && \ @@ -13,6 +13,17 @@ RUN \ libssl-dev \ libcurl4-openssl-dev \ pkg-config \ + libtool \ + libnl-3-dev \ + libnl-genl-3-dev \ + libnl-route-3-dev \ + autoconf \ + automake \ + autotools-dev \ + binutils \ + net-tools \ + curl \ + sudo \ git RUN mkdir /opt/dev @@ -50,4 +61,30 @@ RUN \ make -j2 && \ make install -ENTRYPOINT ["/bin/bash"] +# 1. Create new unprivileged user "dev" +# 2. Install fixuid to accomodate for the host machine UID/GID +ARG FIXUID_VERSION=0.5.1 +RUN useradd -m -s /bin/bash dev && \ + curl -fsSL "https://github.com/boxboat/fixuid/releases/download/v${FIXUID_VERSION}/fixuid-${FIXUID_VERSION}-linux-amd64.tar.gz" | tar -C /usr/local/bin -xzf - + +# Copy fixuid configuration +COPY docker/fixuid.yml /etc/fixuid/config.yml + +# Copy git configuration to dev's home folder +COPY --chown=dev:dev docker/gitconfig /home/dev/.gitconfig + +RUN echo "dev ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers.d/10-dev + +ENTRYPOINT ["/usr/local/bin/fixuid", "-q"] +CMD ["bash"] + +RUN mkdir -p /builds/bbf/bbfdm /home/dev/.ssh \ + && chown -R dev:dev /builds/bbf/bbfdm \ + && chown -R dev:dev /home/dev \ + && chown -R dev:dev /opt/dev \ + && mkdir -p /usr/share/bbfdm \ + && chown -R dev:dev /usr/share/bbfdm + +USER dev:dev +WORKDIR /builds/bbf/bbfdm +VOLUME ["/builds/bbf/bbfdm"] diff --git a/tools/bbf_common.py b/tools/bbf_common.py index 2bbc9262..085bf9d6 100755 --- a/tools/bbf_common.py +++ b/tools/bbf_common.py @@ -178,7 +178,7 @@ def generate_shared_library(dm_name, source_files, vendor_prefix, return True except subprocess.CalledProcessError as e: print(f" Error during compilation: {e}") - return False + sys.exit(-1) def build_and_install_bbfdm(vendor_prefix): @@ -204,7 +204,7 @@ def build_and_install_bbfdm(vendor_prefix): "-DCMAKE_INSTALL_PREFIX=/" ] make_command = ["make"] - make_install_command = ["make", "install"] + make_install_command = ["sudo", "make", "install"] try: subprocess.check_call(cmake_command, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL) @@ -242,7 +242,7 @@ def build_and_install_dmcli(): try: subprocess.check_call(gcc_command, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL) - subprocess.check_call(["mv", "dm-cli", "/usr/sbin/dm-cli"], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL) + subprocess.check_call(["sudo", "mv", "dm-cli", "/usr/sbin/dm-cli"], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL) except subprocess.CalledProcessError as e: print(f"Error running commands: {e}") sys.exit(1) @@ -368,6 +368,11 @@ def download_and_build_plugins(plugins, vendor_prefix): repo_path = None name = os.path.basename(repo).replace('.git', '') + path = os.path.expanduser("~/.netrc") + if not os.path.isfile(path): + repo = repo.replace("https://dev.iopsys.eu/", "git@dev.iopsys.eu:") + + print(f"## Repo is {repo}") if not prefix: prefix = vendor_prefix diff --git a/tools/datamodel.json b/tools/datamodel.json index 51603b20..4d522342 100644 --- a/tools/datamodel.json +++ b/tools/datamodel.json @@ -14258,8468 +14258,6 @@ } } } - }, - "Device.Services.STBService.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "The top-level object for an STB CPE.", - "uniqueKeys": [ - "Alias" - ], - "access": false, - "array": true, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables this <> instance.", - "datatype": "boolean" - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Device.Services.STBService.{i}.Capabilities.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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.", - "access": false, - "array": false, - "MaxActiveAVStreams": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of simultaneously active AV streams supported by the STB. A value of -1 indicates no specific limit on the number of active streams. A value of 0, while not strictly illegal, would indicate an STB that doesnt support AV streams, which is extremely unlikely.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ] - }, - "MaxActiveAVPlayers": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of simultaneously active AV players supported by the STB. An AV player is associated with a presentation device (such as a TV set). Note that this is the strict maximum but, depending on the AV streams to be decoded, a given STB may not always have the resources to run all of these AV players, e.g. it might be able to decode one main picture and one PIP in standard definition, but just a main picture and no PIP in high definition. A value of -1 indicates no specific limit on the number of active players. A value of 0, while not strictly illegal, would indicate an STB that doesnt support AV players, which is extremely unlikely.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ] - }, - "Device.Services.STBService.{i}.Capabilities.FrontEnd.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Front-end capabilities.", - "access": false, - "array": false, - "Device.Services.STBService.{i}.Capabilities.FrontEnd.DVBT.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Capabilities of the DVB-T receiver.", - "access": false, - "array": false, - "MaxActiveDVBTStreams": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of simultaneous active AV streams supported by the DVB-T FrontEnd. A value of -1 indicates no specific limit on the number of active streams.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ] - }, - "MaxLogicalChannels": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of logical channels that can be contained in a Service List Database. A value of -1 indicates no specific limit on the number of logical channels.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ] - } - }, - "Device.Services.STBService.{i}.Capabilities.FrontEnd.IP.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "IP front-end capabilities.", - "access": false, - "array": false, - "MaxActiveIPStreams": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of simultaneous active AV streams supported by the IP FrontEnd. A value of -1 indicates no specific limit on the number of active streams.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ] - }, - "MaxActiveInboundIPStreams": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of simultaneous active Inbound AV streams supported by the IP FrontEnd. A value of -1 indicates no specific limit on the number of active streams.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ] - }, - "MaxActiveOutboundIPStreams": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of simultaneous active Outbound AV streams supported by the IP FrontEnd. A value of -1 indicates no specific limit on the number of active streams.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ] - }, - "StreamingControlProtocols": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Supported streaming control protocols.", - "list": { - "datatype": "string", - "enumerations": [ - "RTSP", - "IGMP", - "IGMPv2", - "IGMPv3", - "DSM-CC" - ] - } - }, - "StreamingTransportProtocols": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Network protocols supported for AV streaming.", - "list": { - "datatype": "string", - "enumerations": [ - "UDP", - "TCP", - "SCTP", - "DCCP", - "RTP", - "HTTP" - ] - } - }, - "StreamingTransportControlProtocols": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Transport control protocols supported for AV streaming in combination with RTP.", - "list": { - "datatype": "string", - "enumerations": [ - "RTCP", - "ARQ", - "AL-FEC" - ] - } - }, - "DownloadTransportProtocols": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Network protocols supported for AV download.", - "list": { - "datatype": "string", - "enumerations": [ - "HTTP", - "HTTPS", - "FTP", - "FTPS", - "SFTP", - "TFTP" - ] - } - }, - "MultiplexTypes": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "AV multiplex types supported by the front end.", - "list": { - "datatype": "string", - "enumerations": [ - "None", - "MPEG1-SYS", - "MPEG2-PS", - "VOB", - "MPEG2-TS" - ] - } - }, - "MaxDejitteringBufferSize": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Describes the maximum de-jittering buffer size, in <>, supported by the STB. A value of -1 indicates no specific limit on the buffer size.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ], - "unit": "bytes" - } - } - }, - "Device.Services.STBService.{i}.Capabilities.PVR.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "PVR capabilities.", - "access": false, - "array": false, - "MaxIOStreams": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of AV streams that the PVR can simultaneously record and playback. For example a time shift, consisting of a record and a play back is considered as 2 streams. A value of -1 indicates no specific limit on the number of streams.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ] - }, - "MaxRecordingStreams": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of AV streams that the PVR can simultaneously record. A value of -1 indicates no specific limit on the number of streams.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ] - }, - "MaxPlaybackStreams": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of AV streams that the PVR can simultaneously play back. A value of -1 indicates no specific limit on the number of streams.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ] - }, - "MaxTimeDelay": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum time delay, in <>, that the PVR time-shift mode can support. A value of -1 indicates no specific limit on the time delay.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ], - "unit": "seconds" - } - }, - "Device.Services.STBService.{i}.Capabilities.AudioDecoder.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Audio decoder capabilities.", - "access": false, - "array": false, - "AudioStandards": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Audio standards supported by this STB.", - "list": { - "datatype": "string", - "enumerations": [ - "MPEG1-Part3-Layer2", - "MPEG1-Part3-Layer3", - "MPEG2-Part3 -Layer2", - "MPEG2-Part3-Layer3", - "MPEG2.5", - "MP3-PRO", - "MP3-Surround", - "MPEG2-AAC-LC", - "MPEG4-AAC-LC", - "MPEG4-AAC-MP", - "MPEG4-BSAC", - "MPEG4-AAC-HE-v2", - "MPEG-Surround", - "DOLBY-AC3", - "DOLBY-DD+", - "DTS", - "DTS-HD" - ] - } - } - }, - "Device.Services.STBService.{i}.Capabilities.VideoDecoder.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Video decoder capabilities.", - "access": false, - "array": false, - "VideoStandards": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Video standards supported by this STB.", - "list": { - "datatype": "string", - "enumerations": [ - "MPEG2-Part2", - "MPEG4-Part2", - "MPEG4-Part10", - "SMPTE-VC-1" - ] - } - }, - "Device.Services.STBService.{i}.Capabilities.VideoDecoder.MPEG2Part2.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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.", - "access": false, - "array": false, - "AudioStandards": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Audio Standards supported by the Player when associated with MPEG2 Part 2 Video.", - "list": { - "datatype": "string" - } - }, - "ProfileLevelNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of instances of <>.", - "datatype": "unsignedInt" - }, - "Device.Services.STBService.{i}.Capabilities.VideoDecoder.MPEG2Part2.ProfileLevel.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Table to describe the set of profiles and levels combinations supported by the STB when MPEG2 Part 2 is used as video standard. <> The table MUST include a distinct entry for each supported combination of these parameters.", - "uniqueKeys": [ - "Profile", - "Level", - "Alias" - ], - "access": false, - "array": true, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Profile": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Identifier of the MPEG2 Part 2 profile.", - "datatype": "string", - "enumerations": [ - "SP", - "MP", - "SNR", - "Spt", - "HP", - "4:2:2" - ] - }, - "Level": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Identifier of the MPEG2 part 2 level.", - "datatype": "string", - "enumerations": [ - "LL", - "ML", - "H-14", - "HL" - ] - }, - "MaximumDecodingCapability": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The maximum decoding capability for this video standard in <>. This strictly depends on the profile and level selected.", - "datatype": "unsignedInt", - "unit": "Kilobits per second" - } - } - }, - "Device.Services.STBService.{i}.Capabilities.VideoDecoder.MPEG4Part2.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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.", - "access": false, - "array": false, - "AudioStandards": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Audio Standards supported by the Player when associated with MPEG4 Part 2 video.", - "list": { - "datatype": "string" - } - }, - "ProfileLevelNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of instances of <>.", - "datatype": "unsignedInt" - }, - "Device.Services.STBService.{i}.Capabilities.VideoDecoder.MPEG4Part2.ProfileLevel.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Table to describe the set of profiles and levels combinations supported by the STB when MPEG4 Part 2 is used as video standard. <> The table MUST include a distinct entry for each supported combination of these parameters.", - "uniqueKeys": [ - "Profile", - "Level", - "Alias" - ], - "access": false, - "array": true, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Profile": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Identifier of the MPEG4 Part 2 profile.", - "datatype": "string", - "enumerations": [ - "SIMPLE", - "SIMPLE SCALABLE", - "CORE", - "CORE SCALABLE", - "ADVANCED CORE", - "MAIN", - "N-BIT", - "ADVANCED REAL TIME SIMPLE", - "ADVANCED CODING EFFICIENCY", - "SIMPLE STUDIO", - "CORE STUDIO", - "ADVANCED SIMPLE", - "FINE GRANULARITY SCALABLE", - "ADVANCED SCALABLE TEXTURE", - "ANIMATED 2D MESH", - "BASIC ANIMATED TEXTURE", - "STILL SCALABLE TEXTURE", - "SIMPLE FACE", - "SIMPLE FBA" - ] - }, - "Level": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Identifier of the MPEG4 Part 2 level.", - "datatype": "string", - "enumerations": [ - "L5", - "L4", - "L4a", - "L3b", - "L3", - "L2", - "L1", - "L0" - ] - }, - "MaximumDecodingCapability": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The maximum decoding capability for this video standard in <>. This strictly depends on the profile and level selected.", - "datatype": "unsignedInt", - "unit": "Kilobits per second" - } - } - }, - "Device.Services.STBService.{i}.Capabilities.VideoDecoder.MPEG4Part10.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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.", - "access": false, - "array": false, - "AudioStandards": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Audio Standards supported by the Player when associated with MPEG4 Part 10 video.", - "list": { - "datatype": "string" - } - }, - "ProfileLevelNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of instances of <>.", - "datatype": "unsignedInt" - }, - "Device.Services.STBService.{i}.Capabilities.VideoDecoder.MPEG4Part10.ProfileLevel.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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.", - "uniqueKeys": [ - "Profile", - "Level", - "Alias" - ], - "access": false, - "array": true, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Profile": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Supported MPEG4 Part 10 profiles.", - "list": { - "datatype": "string", - "enumerations": [ - "BASELINE", - "MAIN", - "EXTENDED", - "HIGH", - "HIGH 10", - "HIGH 4:2:2", - "HIGH 4:4:4" - ] - } - }, - "Level": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Supported MPEG4 Part 10 Levels.", - "list": { - "datatype": "string", - "enumerations": [ - "1", - "1b", - "1.1", - "1.2", - "1.3", - "2", - "2.1", - "2.2", - "3", - "3.1", - "3.2", - "4", - "4.1", - "4.2", - "5", - "5.1" - ] - } - }, - "MaximumDecodingCapability": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The maximum decoding capability for this video standard in <>. This strictly depends on the profile and level selected.", - "datatype": "unsignedInt", - "unit": "Kilobits per second" - } - } - }, - "Device.Services.STBService.{i}.Capabilities.VideoDecoder.SMPTEVC1.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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.", - "access": false, - "array": false, - "AudioStandards": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Audio Standards supported by the Player when associated with SMPTE-VC-1 video.", - "list": { - "datatype": "string" - } - }, - "ProfileLevelNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of instances of <>.", - "datatype": "unsignedInt" - }, - "Device.Services.STBService.{i}.Capabilities.VideoDecoder.SMPTEVC1.ProfileLevel.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Table to describe the set of profiles and levels combinations supported by the STB when SMPTE-VC-1 is used as video standard. <> The table MUST include a distinct entry for each supported combination of these parameters.", - "uniqueKeys": [ - "Profile", - "Level", - "Alias" - ], - "access": false, - "array": true, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Profile": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Identifier of the SMPTE-VC-1 profile.", - "datatype": "string", - "enumerations": [ - "SP", - "MP", - "AP" - ] - }, - "Level": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Identifier of the SMPTE-VC-1 level.", - "datatype": "string", - "enumerations": [ - "LL", - "ML", - "HL", - "L0", - "L1", - "L2", - "L3", - "L4" - ] - }, - "MaximumDecodingCapability": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The maximum decoding capability for this video standard in <>. This strictly depends on the profile and level selected.", - "datatype": "unsignedInt", - "unit": "Kilobits per second" - } - } - } - }, - "Device.Services.STBService.{i}.Capabilities.AudioOutput.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Audio output capabilities. The audio output stage may include selecting output formats, selecting output connectors, and copy protection.", - "access": false, - "array": false, - "AudioFormats": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Supported audio output formats. Enumeration of: ANALOG-MONO, ANALOG-2-CHANNELS, ANALOG-5.1-CHANNELS, DIGITAL-OPTICAL-SP/DIF, DIGITAL-COAXIAL-SP/DIF, HDMI, RF. Note that these refer to supported output formats and not to physical connectors.", - "list": { - "datatype": "string", - "enumerations": [ - "ANALOG-MONO", - "ANALOG-2-CHANNELS", - "ANALOG-5.1-CHANNELS", - "DIGITAL-OPTICAL-SP/DIF", - "DIGITAL-COAXIAL-SP/DIF", - "HDMI", - "RF" - ] - } - } - }, - "Device.Services.STBService.{i}.Capabilities.VideoOutput.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Video output capabilities. The video output stage may include selecting output formats, selecting output connectors, and copy protection.", - "access": false, - "array": false, - "CompositeVideoStandards": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Analog composite video standards supported for video output. This applies only to CVBS video output.", - "list": { - "datatype": "string", - "enumerations": [ - "NTSC-J", - "NTSC-M", - "PAL-B", - "PAL-D", - "PAL-G", - "PAL-H", - "PAL-I", - "PAL-N", - "PAL-M", - "SECAM-B", - "SECAM-G", - "SECAM-H", - "SECAM-D", - "SECAM-K", - "SECAM-K1", - "SECAM-L" - ] - } - }, - "VideoFormats": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Supported video output formats. Enumeration of: CVBS, S-Video, YPrPb, RGsB, RGB, HDMI, DVI, RF. Note that these refer to supported output formats and not to physical connectors.", - "list": { - "datatype": "string", - "enumerations": [ - "CVBS", - "S-Video", - "YPrPb", - "RGsB", - "RGB", - "HDMI", - "DVI", - "RF" - ] - } - }, - "Macrovision": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Supported version of Macrovision digital content protection standard.", - "datatype": "string", - "range": [ - { - "max": 32 - } - ] - }, - "HDCP": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Supported version of HDCP digital content protection standard.", - "datatype": "string", - "range": [ - { - "max": 32 - } - ] - }, - "DisplayFormats": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is a supported display format and MUST be in the form of \u201cx:y\u201d, such as for example \u201c4:3, 16:9, 14:9. <>", - "list": { - "datatype": "string", - "pattern": [ - "\\d+:\\d+" - ] - } - } - }, - "Device.Services.STBService.{i}.Capabilities.HDMI.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "This object describes the characteristics of the HDMI interface, if any.", - "access": false, - "array": false, - "SupportedResolutions": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Video resolutions supported for the HDMI video output. Enumeration of: 640x480p/60Hz, 1280x720p/60Hz, 1920x1080i/60Hz, 720x480p/60Hz, 720(1440)x480i/60Hz, 1280x720p/50Hz, 1920x1080i/50Hz, 720x576p/50Hz, 720(1440)x240p/60Hz, 2880x480i/60Hz, 2880x240p/60Hz, 1440x480p/60Hz, 1920x1080p/60Hz, 720(1440)x288p/50Hz, 2880x576i/50Hz, 2880x288p/50Hz, 1440x576p/50Hz, 1920x1080p/50Hz, 1920x1080p/24Hz, 1920x1080p/25Hz, 1920x1080p/30Hz, 2880x480p/60Hz, 2880x576p/50Hz, 1920x1080i (1250 total)/50Hz, 720(1440)x480i/120Hz, 720x480p/120Hz, 1920x1080i/120Hz, 1280x720p/120Hz, 720(1440)x480i/240Hz, 720x480p/240Hz, 720(1440)x576i/100Hz, 720x576p/100Hz, 1920x1080i/100Hz, 1280x720p/100Hz, 720(1440)x576i/200Hz, 720x576p/200Hz, 1280x720p/24Hz, 1280x720p/25Hz, 1280x720p/30Hz, 1920x1080p/120Hz, 1920x1080p/100Hz.", - "list": { - "datatype": "string", - "enumerations": [ - "640x480p/60Hz", - "1280x720p/60Hz", - "1920x1080i/60Hz", - "720x480p/60Hz", - "720(1440)x480i/60Hz", - "1280x720p/50Hz", - "1920x1080i/50Hz", - "720x576p/50Hz", - "720(1440)x240p/60Hz", - "2880x480i/60Hz", - "2880x240p/60Hz", - "1440x480p/60Hz", - "1920x1080p/60Hz", - "720(1440)x288p/50Hz", - "2880x576i/50Hz", - "2880x288p/50Hz", - "1440x576p/50Hz", - "1920x1080p/50Hz", - "1920x1080p/24Hz", - "1920x1080p/25Hz", - "1920x1080p/30Hz", - "2880x480p/60Hz", - "2880x576p/50Hz", - "1920x1080i (1250 total)/50Hz", - "720(1440)x480i/120Hz", - "720x480p/120Hz", - "1920x1080i/120Hz", - "1280x720p/120Hz", - "720(1440)x480i/240Hz", - "720x480p/240Hz", - "720(1440)x576i/100Hz", - "720x576p/100Hz", - "1920x1080i/100Hz", - "1280x720p/100Hz", - "720(1440)x576i/200Hz", - "720x576p/200Hz", - "1280x720p/24Hz", - "1280x720p/25Hz", - "1280x720p/30Hz", - "1920x1080p/120Hz", - "1920x1080p/100Hz" - ] - } - }, - "CECSupport": { - "type": "boolean", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates whether the STB is supporting HDMI-CEC features as described in <>.", - "datatype": "boolean" - }, - "HDMI3D": { - "type": "boolean", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates whether the STB is supporting the 3D video formats mandated by <>.", - "datatype": "boolean" - } - }, - "Device.Services.STBService.{i}.Capabilities.CDS.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "This object describes the characteristics of the Content Download System, if any.", - "access": false, - "array": false, - "PushCapable": { - "type": "boolean", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Capability of providing a CDS Push service for the operator initiated download of content items to local storage via a broadband IP connection.", - "datatype": "boolean" - }, - "PullCapable": { - "type": "boolean", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Capability of providing a CDS Pull service for the user initiated download of content items to a local storage via a broadband IP connection.", - "datatype": "boolean" - } - }, - "Device.Services.STBService.{i}.Capabilities.CA.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "This object describes the characteristics of the Conditional Access, if any.", - "access": false, - "array": false, - "CASystems": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Unique identifiers (e.g. commercial names) of supported CA systems.", - "list": { - "datatype": "string", - "maxsize": 1024 - } - } - }, - "Device.Services.STBService.{i}.Capabilities.DRM.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "This object describes the characteristics of the Digital Rights Management, if any.", - "access": false, - "array": false, - "DRMSystems": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Unique identifiers (e.g. commercial names) of supported DRM systems.", - "list": { - "datatype": "string", - "maxsize": 1024 - } - } - }, - "Device.Services.STBService.{i}.Capabilities.ServiceMonitoring.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "This object describes the capabilities of the <> object.", - "access": false, - "array": false, - "ServiceTypes": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Supported service types, each of which relates to an AV stream source. Enumeration of: IPTV, VoD, IP, TEST, IP-All, CAB, DTT, SAT, PVR. Note that none of the standard service types cover LAN-sourced IP streams.", - "list": { - "datatype": "string", - "enumerations": [ - "IPTV", - "VoD", - "IP", - "TEST", - "IP-All", - "CAB", - "DTT", - "SAT", - "PVR" - ] - } - }, - "MaxEventsPerSampleInterval": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of events of each applicable statistic that the STB is able to store for each sample interval. A value of -1 indicates no specific maximum number of events.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ], - "unit": "bytes" - }, - "MaxActiveMainStreams": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of AV Main streams for which the STB can simultaneously collect statistics. A value of -1 indicates no specific limit on the number of active streams.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ] - }, - "MinSampleInterval": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Minimum sample interval in <> that the STB MUST be able to support. A value of -1 indicates no specific minimum sample interval.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ], - "unit": "seconds" - }, - "MaxReportSamples": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of samples of each statistic that the STB is able to store and report. A value of -1 indicates no specific maximum number of samples.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ] - }, - "HighLevelMetricNames": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The names of the supported high-level metrics. If a metric produces several different scores (e.g. an audio, a video, and an audiovisual score), then they MUST be explicitly named. Example (using XYZ as the name of the base metric): XYZAudio,XYZVideo,XYZAudiovisual.", - "list": { - "datatype": "string", - "maxsize": 1024 - } - }, - "MaxMainStreamEventLogEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of event log entries that the STB is able to record for a MainStream object instance.", - "datatype": "unsignedInt" - } - }, - "Device.Services.STBService.{i}.Capabilities.AudienceStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "This object describes the capabilities of the <> object.", - "access": false, - "array": false, - "MaxAudienceStatsChannels": { - "type": "int", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of channels that the STB MUST support in the <> object A value of -1 indicates no specific limit on the number of channels.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ] - } - } - }, - "Device.Services.STBService.{i}.Components.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Details of STB logical or physical internal components. Unlike the <> object, which is read-only and which doesnt describe individual instances, this object contains some writeable parameters.", - "access": false, - "array": false, - "FrontEndNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<>", - "datatype": "unsignedInt" - }, - "AudioDecoderNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<>", - "datatype": "unsignedInt" - }, - "VideoDecoderNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<>", - "datatype": "unsignedInt" - }, - "AudioOutputNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<>", - "datatype": "unsignedInt" - }, - "VideoOutputNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<>", - "datatype": "unsignedInt" - }, - "SCARTNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<>", - "datatype": "unsignedInt" - }, - "CANumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<>", - "datatype": "unsignedInt" - }, - "DRMNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<>", - "datatype": "unsignedInt" - }, - "HDMINumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<>", - "datatype": "unsignedInt" - }, - "SPDIFNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<>", - "datatype": "unsignedInt" - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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).", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables this front-end.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of this front-end. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable name associated with this front-end.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.DVBT.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <>.", - "access": false, - "array": false, - "InstallProgress": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "usp" - ], - "description": "Progression in <> of the current scan. The value is undefined when a scan is not in progress.", - "datatype": "unsignedInt", - "range": [ - { - "min": 0, - "max": 100 - } - ], - "unit": "%" - }, - "Install()": { - "type": "command", - "async": true, - "protocols": [ - "usp" - ], - "input": { - "StartFrequency": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "usp" - ], - "description": "Frequency (in <>) at which to start the scanning process.", - "datatype": "unsignedInt", - "unit": "kHz" - }, - "StopFrequency": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "usp" - ], - "description": "Frequency (in <>) at which to stop the scanning process.", - "datatype": "unsignedInt", - "unit": "kHz" - } - } - }, - "LogicalChannelConnect()": { - "type": "command", - "async": false, - "protocols": [ - "usp" - ], - "input": { - "LogicalChannelNumber": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "usp" - ], - "description": "Logical channel number to connect to (the logical channels preferred service will be connected to). If a <> instance with ServiceType = DTT is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance.", - "datatype": "unsignedInt" - } - } - }, - "ServiceConnect()": { - "type": "command", - "async": false, - "protocols": [ - "usp" - ], - "input": { - "DvbId": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "usp" - ], - "description": "DvbId of the service to connect to. If a <> instance with ServiceType = DTT is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance.", - "datatype": "string", - "range": [ - { - "max": 12 - } - ] - } - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.DVBT.Modulation.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "DVB-T modulation details.", - "access": false, - "array": false, - "Frequency": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates the current frequency in <>. The value of this parameter is undefined while installing the service list (see <.DVBT.Install>>).", - "datatype": "unsignedInt", - "unit": "kHz" - }, - "ChannelBandwidth": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates the channel bandwidth in use.", - "datatype": "string", - "enumerations": [ - "8MHz", - "7MHz", - "6MHz" - ] - }, - "Constellation": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates the current constellation in use.", - "datatype": "string", - "enumerations": [ - "QPSK", - "16QAM", - "64QAM" - ] - }, - "HierarchicalInformation": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Hierarchical parameter alpha. The higher the value of alpha, the more noise-immune the High Priority Modulation is.", - "datatype": "string", - "enumerations": [ - "0", - "1", - "2", - "4" - ] - }, - "CodeRateHP": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates the current code rate in use. Code rate applies to HP in case of hierarchical coding.", - "datatype": "string", - "enumerations": [ - "1/2", - "2/3", - "3/4", - "5/6", - "7/8" - ] - }, - "CodeRateLP": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates the current code rate in use. Code rate applies to LP in case of hierarchical coding.", - "datatype": "string", - "enumerations": [ - "0", - "1/2", - "2/3", - "3/4", - "5/6", - "7/8" - ] - }, - "GuardInterval": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates the current guard interval in use.", - "datatype": "string", - "enumerations": [ - "1/32", - "1/16", - "1/8", - "1/4" - ] - }, - "TransmissionMode": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates the number of carriers in an OFDM frame.", - "datatype": "string", - "enumerations": [ - "2k", - "8k" - ] - }, - "SNR": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Signal/Noise ratio in the carrier band, measured in <>.", - "datatype": "unsignedInt", - "unit": "dB" - }, - "BER": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Bit Error Ratio before correction, expressed in multiples of 1e-6.", - "datatype": "unsignedInt" - }, - "CBER": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Bit Error Ratio after correction, expressed in multiples of 1e-9.", - "datatype": "unsignedInt" - }, - "Locked": { - "type": "boolean", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates whether or not the tuner is locked on a frequency.", - "datatype": "boolean" - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.DVBT.Service.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "DVB-T Current service details.", - "access": false, - "array": false, - "CurrentLogicalChannel": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "It represents the logical channel object instance for the current service, For example: .Components.FrontEnd.1.DVBT.-ServiceListDatabase.LogicalChannel.12.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "CurrentService": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "It represents the service object instance for the current service. For example: .Components.FrontEnd.1.DVBT.ServiceListDatabase.LogicalChannel.12.Service.1.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.DVBT.Install.": { - "type": "object", - "protocols": [ - "cwmp" - ], - "description": "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 <.DVBT.ServiceListDatabase>>.", - "access": false, - "array": false, - "Start": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "Starts (when set to <>) or stops (when set to <>) scanning for services. The value is not saved in device state and is always <> when read. Discovered services are merged with those already present in the service list database. This supports cases where the frequency spectrum is not continuous. In order to force a re-install, the service list database needs to be reset (see <.DVBT.ServiceListDatabase.Reset>>).", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp" - ], - "description": "Indicates the status of the scanning process. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "Progress": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp" - ], - "description": "Progression in <> of the current scan. The value is undefined when a scan is not in progress.", - "datatype": "unsignedInt", - "range": [ - { - "min": 0, - "max": 100 - } - ], - "unit": "%" - }, - "StartFrequency": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "Frequency (in <>) at which to start the scanning process.", - "datatype": "unsignedInt", - "unit": "kHz" - }, - "StopFrequency": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "Frequency (in <>) at which to stop the scanning process.", - "datatype": "unsignedInt", - "unit": "kHz" - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceListDatabase.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "DVB-T service list database.", - "access": false, - "array": false, - "TotalServices": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of services defined in the service list database, i.e. the number of different DvbIds in the database.", - "datatype": "unsignedInt" - }, - "LogicalChannelNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of logical channels in the service list database.", - "datatype": "unsignedInt" - }, - "Reset": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "When set to <>, resets the service list database. Setting it to <> has no effect. The value is not saved in device state and is always <> when read.", - "datatype": "boolean" - }, - "Reset()": { - "type": "command", - "async": false, - "protocols": [ - "usp" - ] - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceListDatabase.LogicalChannel.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "DVB-T logical channel information.", - "uniqueKeys": [ - "LogicalChannelNumber", - "Alias" - ], - "access": false, - "array": true, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "LogicalChannelNumber": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Logical channel number.", - "datatype": "unsignedInt" - }, - "ServiceNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of services associated with this logical channel.", - "datatype": "unsignedInt" - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceListDatabase.LogicalChannel.{i}.Service.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "DVB-T service information.", - "uniqueKeys": [ - "DvbId", - "Alias" - ], - "access": false, - "array": true, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable name associated with this service, e.g. read from the DVB service information metadata.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "DvbId": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "DVB Triplet <> that uniquely identifies the service in the service list database. The DVB Triplet is a 12-byte string that is a concatenation of 4 hexadecimal characters for each of the following: Original Network Id, Transport Stream Id, Service Id. For example: * OriginalNetworkId = 8442 = 0x20FA * TransportStreamId = 4 = 0x0004 * ServiceId = 257 = 0x0101 -> DvbId = 20FA00040101", - "datatype": "string", - "range": [ - { - "max": 12 - } - ] - }, - "Frequency": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Transmitter frequency (in <>) for this service.", - "datatype": "unsignedInt", - "unit": "kHz" - }, - "BER": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Bit Error Ratio before correction, expressed in multiples of 1e-6 (indicates the quality of this service).", - "datatype": "unsignedInt" - }, - "CBER": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Bit Error Ratio after correction, expressed in <> (indicates the quality of this service).", - "datatype": "unsignedInt", - "unit": "multiples of 1e-9" - }, - "SNR": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Signal/Noise ratio in the carrier band, measured in <> (indicates the quality of this service).", - "datatype": "unsignedInt", - "unit": "dB" - }, - "Preferred": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "When set to <>, identifies this as the preferred service for this logical channel and automatically sets <> to <> for other services associated with this logical channel. When set to <>, cancels this services preferred status and causes the service with the lowest <> (best received quality) to become the preferred service for this logical channel. Whenever frequencies are re-scanned, all <> parameters are implicitly reset to <>, i.e. a re-scan will always use the <> to determine preferred services, and will discard any past explicit overrides.", - "datatype": "boolean" - } - } - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.DVBT.LogicalChannelConnect.": { - "type": "object", - "protocols": [ - "cwmp" - ], - "description": "Connect to a DVB-T logical channel.", - "access": false, - "array": false, - "LogicalChannelNumber": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "Logical channel number to connect to (the logical channels preferred service will be connected to). If a <> instance with ServiceType = DTT is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance. The value is not saved in device state. The value when read is not specified and need not be the value that was most recently written.", - "datatype": "unsignedInt" - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceConnect.": { - "type": "object", - "protocols": [ - "cwmp" - ], - "description": "Connect to a DVB-T service.", - "access": false, - "array": false, - "DvbId": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "DvbId of the service to connect to. If a <> instance with ServiceType = DTT is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance. The value is not saved in device state. The value when read is not specified and need not be the value that was most recently written.", - "datatype": "string", - "range": [ - { - "max": 12 - } - ] - } - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.IP.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "IP front-end details. This object will normally be present if and only if the front-end is an IP front-end.", - "access": false, - "array": false, - "InboundNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of <> instances.", - "datatype": "unsignedInt" - }, - "OutboundNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of <> instances.", - "datatype": "unsignedInt" - }, - "ActiveInboundIPStreams": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of <> AV streams currently active (i.e. with Status != Disabled, which means audio or AV data are being processed).", - "datatype": "unsignedInt" - }, - "ActiveOutboundIPStreams": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of <> AV streams currently active (i.e. with Status != Disabled, which means audio or AV data are being processed).", - "datatype": "unsignedInt" - }, - "ServiceConnect()": { - "type": "command", - "async": false, - "protocols": [ - "usp" - ], - "input": { - "URI": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "usp" - ], - "description": "RFC 3986 URI that describes the service to connect to in the form: * ://:?StrCtrl=?StrTrspCtrl=?MuxType= where: * is the IP address of the service source (for Unicast) or IGMP group (for Multicast). * is the associated TCP/UDP port. If not specified, the STB is assumed to know and use an appropriate default port. * is the streaming transport protocol and MUST be one of the values in <>, which SHOULD be converted to lower-case. * is the streaming control protocol and MUST be one of the values in <>. If not specified, no streaming control protocol is to be used. * is the streaming transport control protocol and MUST be one of the values in <>. If not specified, no streaming transport control protocol is to be used. * is the multiplex type and MUST be one of the values in <>. This tells the STB which multiplex type to expect. If not specified, the STB is assumed to know, or to be able to determine, the multiplex type. Note that download protocols are not supported by the above syntax. However, the specified syntax is just a baseline, and STBs MAY support an extended syntax. Example of Multicast MPEG2-TS over RTP with no transport control: * rtp://224.112.15.18:3257?StrCtrl=IGMP?MuxType=MPEG2-TS Example of Multicast MPEG2-TS over RTP with AL-FEC transport control: * rtp://224.112.15.18:3257?StrCtrl=IGMP?StrTrspCtrl=AL-FEC?MuxType=MPEG2-TS Example of Unicast MPEG2-TS over UDP with RTSP transport control: * udp://174.146.35.12:3257?StrCtrl=RTSP?MuxType=MPEG2-TS Example of Unicast raw AV over RTP with RTCP control and RTSP transport control: * rtp://174.146.35.12:3257?StrCtrl=RTSP?StrTrspCtrl=RTCP?MuxType=None If a <> instance with ServiceType = IP or IPTV (or VoD if the URI accesses a VoD service) is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - } - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.IP.RTCP.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Parameters related to RTCP receiver report generation as defined in <>.", - "access": false, - "array": false, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables RTCP receiver report generation.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of RTCP receiver report generation. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "TxRepeatInterval": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Transmission repeat interval, in <>.", - "datatype": "unsignedInt", - "range": [ - { - "min": 1 - } - ], - "unit": "milliseconds" - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.IP.RTPAVPF.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Parameters related to RTP AVPF configuration as defined in <> and <>.", - "access": false, - "array": false, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables RTP/AVPF receiver report generation. When set to <>, enables the error correction operation, immediately (<> mode) or automatically when necessary (<> mode). When set to <>, disables the error correction operation.", - "datatype": "boolean" - }, - "OperationMode": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The operation mode of the Error Correction mechanism. Enumeration of: Auto, Forced. In <> mode, when Error Correction is enabled, the STB decides whether or not to run the Error Correction operation (e.g. after an error analysis). In <> mode, when Error Correction is enabled the STB MUST run the Error Correction operation.", - "datatype": "string", - "enumerations": [ - "Auto", - "Forced" - ] - }, - "ECOperationStatus": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of RTP/AVPF operation. Enumeration of: Disabled, Auto mode EC On, Auto mode EC Off without buffering, Auto mode EC Off with buffering, Forced mode EC On, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Auto mode EC On", - "Auto mode EC Off without buffering", - "Auto mode EC Off with buffering", - "Forced mode EC On", - "Error" - ] - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of RTP/AVPF receiver report generation. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "RetransmitTimeout": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Time in <> the receiver shall wait for a retransmitted packet before considering it to be lost.", - "datatype": "unsignedInt", - "unit": "milliseconds" - }, - "MinLossPackets": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Minimum number of lost packets the receiver shall wait for before generating a retransmission request.", - "datatype": "unsignedInt" - }, - "MaxReportTime": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum time in <> the receiver shall wait between a lost packet and the generation of a retransmission request.", - "datatype": "unsignedInt", - "unit": "milliseconds" - }, - "MaxLossBurst": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of consecutive lost packets for which the receiver shall attempt recovery.", - "datatype": "unsignedInt" - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.IP.FEC.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Parameters related to AL-FEC configuration as defined in <>.", - "access": false, - "array": false, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables FEC decoder operation. When set to <>, enables the FEC decoder operation, immediately (<> mode) or automatically when necessary (<> mode). When set to <>, disables the FEC decoder operation.", - "datatype": "boolean" - }, - "OperationMode": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The operation mode of the FEC decoder. Enumeration of: Auto, Forced. In <> mode, when Error Correction is enabled the STB decides whether or not to run the AL_FEC decoding (e.g. after an error analysis). In <> mode, when Error Correction is enabled the STB MUST run the FEC decoding.", - "datatype": "string", - "enumerations": [ - "Auto", - "Forced" - ] - }, - "ECOperationStatus": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of FEC decoder operation. Enumeration of: Disabled, Auto mode EC On, Auto mode EC Off without buffering, Auto mode EC Off with buffering, Forced mode EC On, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Auto mode EC On", - "Auto mode EC Off without buffering", - "Auto mode EC Off with buffering", - "Forced mode EC On", - "Error" - ] - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Parameters that are specific to IGMP clients when changing channels.", - "access": false, - "array": false, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables all IGMP support on the receiver side of the CPE.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Status of IGMP support on the receiver side of the CPE. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "MaximumNumberOfConcurrentGroups": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of group memberships allowed simultaneously. For example, this would need to be at least 2 in order to support a Multicast-delivered main picture and a Multicast-delivered PIP.", - "datatype": "unsignedInt" - }, - "MaximumNumberOfTrackedGroups": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum number of groups for which statistics will be tracked. This relates only to the maintenance of statistics, and does not affect the operation of the STB.", - "datatype": "unsignedInt" - }, - "LoggingEnable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Controls logging of IGMP traffic. The CPE MAY choose to throttle log entries, e.g. if joins and leaves are occurring at an excessive rate.", - "datatype": "boolean" - }, - "DSCPMark": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Diffserv code point to be used for outgoing IGMP packets.", - "datatype": "unsignedInt", - "range": [ - { - "min": 0, - "max": 63 - } - ] - }, - "VLANIDMark": { - "type": "int", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "VLAN ID (as defined in 802.1Q) to be used for outgoing IGMP packets. A value of -1 indicates the default value is to be used. If either the <> or <> is greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ] - }, - "EthernetPriorityMark": { - "type": "int", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Ethernet priority code (as defined in 802.1D) to be used for outgoing IGMP packets. A value of -1 indicates the default value is to be used. If either the <> or <> are greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.", - "datatype": "int", - "range": [ - { - "min": -1 - } - ] - }, - "ClientVersion": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The highest IGMP version supported by the IGMP Client.", - "datatype": "string", - "enumerations": [ - "v1", - "v2", - "v3" - ] - }, - "ClientRobustness": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Robustness is a way of indicating how vulnerable the network is to lost packets. IGMP can recover from robustness minus 1 lost IGMP packets. RFC 3376 specifies a default of 2.", - "datatype": "unsignedInt" - }, - "ClientUnsolicitedReportInterval": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of <> between repetitions of a hosts initial report of membership in a group. RFC 3376 specifies a default of 1s.", - "datatype": "unsignedInt", - "range": [ - { - "min": 1, - "max": 25 - } - ], - "unit": "seconds" - }, - "ClientGroupNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of entries in the <> table.", - "datatype": "unsignedInt" - }, - "ClientGroupStatsNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of entries in the <> table.", - "datatype": "unsignedInt" - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroup.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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.", - "uniqueKeys": [ - "GroupAddress", - "Alias" - ], - "access": false, - "array": true, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "GroupAddress": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The IP multicast group address for which this entry contains information.", - "datatype": "IPAddress", - "range": [ - { - "max": 45 - } - ] - }, - "UpTime": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Time elapsed in <> since the multicast group has been a member on this interface.", - "datatype": "unsignedInt", - "unit": "seconds" - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroupStats.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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.", - "uniqueKeys": [ - "GroupAddress", - "Alias" - ], - "access": false, - "array": true, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "GroupAddress": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The IP multicast group address for which this entry contains information.", - "datatype": "IPAddress", - "range": [ - { - "max": 45 - } - ] - }, - "TotalStart": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of <> since the beginning of the period used for collection of <> statistics. Statistics SHOULD continue to be accumulated across CPE reboots, though this may not always be possible.", - "datatype": "unsignedInt", - "unit": "seconds" - }, - "CurrentDayStart": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of <> since the beginning of the period used for collection of <> statistics. The CPE MAY align the beginning of each <> interval with days in the UTC time zone, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this may not always be possible.", - "datatype": "unsignedInt", - "unit": "seconds" - }, - "QuarterHourStart": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of <> since the beginning of the period used for collection of <> statistics. The CPE MAY align the beginning of each <> interval with real-time quarter-hour intervals, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this may not always be possible.", - "datatype": "unsignedInt", - "unit": "seconds" - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroupStats.{i}.Total.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total statistics for this multicast group.", - "access": false, - "array": false, - "NumberOfJoins": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of IGMP joins during this period.", - "datatype": "unsignedInt" - }, - "NumberOfLeaves": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of IGMP leaves during this period.", - "datatype": "unsignedInt" - }, - "MaxJoinDelay": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum latency delay, in <>, from the sending of a Join message for this group to the arrival of the first IP packet for this group during this period.", - "datatype": "unsignedInt", - "unit": "milliseconds" - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroupStats.{i}.CurrentDay.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Current day statistics for this multicast group.", - "access": false, - "array": false, - "NumberOfJoins": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of IGMP joins during this period.", - "datatype": "unsignedInt" - }, - "NumberOfLeaves": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of IGMP leaves during this period.", - "datatype": "unsignedInt" - }, - "MaxJoinDelay": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum latency delay, in <>, from the sending of a Join message for this group to the arrival of the first IP packet for this group during this period.", - "datatype": "unsignedInt", - "unit": "milliseconds" - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroupStats.{i}.QuarterHour.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Current quarter hour statistics for this multicast group.", - "access": false, - "array": false, - "NumberOfJoins": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of IGMP joins during this period.", - "datatype": "unsignedInt" - }, - "NumberOfLeaves": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of IGMP leaves during this period.", - "datatype": "unsignedInt" - }, - "MaxJoinDelay": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum latency delay, in <>, from the sending of a Join message for this group to the arrival of the first IP packet for this group during this period.", - "datatype": "unsignedInt", - "unit": "milliseconds" - } - } - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.IP.Dejittering.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Parameters related to the de-jittering buffer configuration for all inbound IP streams.", - "access": false, - "array": false, - "BufferSize": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "De-jittering buffer size, measured in <>, on the receiver side of the CPE. The STB is responsible for converting this into the actual buffer size in bytes.", - "datatype": "unsignedInt", - "unit": "milliseconds" - }, - "BufferInitialLevel": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Describes the number of <> worth of data that should be in the receiver side dejittering buffer before play-out can start. Typically this would be half of the buffer size.", - "datatype": "unsignedInt", - "unit": "milliseconds" - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.IP.Inbound.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Inbound IP streams currently entering the STB via this front-end.", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of this Inbound stream. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Unique human-readable name associated with this inbound IP instance.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "StreamingControlProtocol": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Network protocol currently used for controlling streaming of the source content, or <> if the content is not being streamed or is being streamed but is not being controlled.", - "datatype": "string" - }, - "StreamingTransportProtocol": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Network protocol currently used for streaming the source content, or an empty string if the content is not being streamed.", - "datatype": "string" - }, - "StreamingTransportControlProtocol": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Transport control protocol currently used for streaming the source content, or an empty string if the content is not being streamed.", - "datatype": "string" - }, - "MultiplexType": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "AV multiplex type currently used for the source content, or an empty string if the content is not being demultiplexed.", - "datatype": "string" - }, - "DownloadTransportProtocol": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Network protocol currently used for downloading the source content, or an empty string if the content is not being downloaded.", - "datatype": "string" - }, - "SourceAddress": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "IP address of the source of the current stream content.", - "datatype": "IPAddress", - "range": [ - { - "max": 45 - } - ] - }, - "SourcePort": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "TCP or UDP port number of the source of the current stream content, or 0 if the content is not being delivered via IP or if not applicable.", - "datatype": "unsignedInt", - "range": [ - { - "min": 0, - "max": 65535 - } - ] - }, - "DestinationAddress": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "IP address of the destination of the current stream content, or <> if the content is not being delivered via IP.", - "datatype": "IPAddress", - "range": [ - { - "max": 45 - } - ] - }, - "DestinationPort": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "TCP or UDP port number of the destination of the current stream content, or 0 if the content is not being delivered via IP or if not applicable.", - "datatype": "unsignedInt", - "range": [ - { - "min": 0, - "max": 65535 - } - ] - }, - "URI": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "RFC 3986 URI that indicates the current source (possibly including Multicast group and port, if relevant) of the stream content, or <> if the source is not known or cannot be represented as a URI. For example, for a WAN-delivered stream this might be a content providers URL, or for a LAN-delivered stream it might be an UPnP AV URN. If specified, the URI MUST be consistent with the other source-related parameters.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.IP.Outbound.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Parameters related to an outbound IP stream.", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of this Outbound stream. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Unique human-readable name associated with this outbound IP instance.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "MultiplexType": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "AV multiplex type currently used for the destination content, or an empty string if the content is not being demultiplexed.", - "datatype": "string" - }, - "URI": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "RFC 3986 URI that indicates the current destination (possibly including Multicast group and port, if relevant) of the stream content, or an empty string if the destination is not known or cannot be represented as a URI. For example, this might be an UPnP AV URN.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.IP.ServiceConnect.": { - "type": "object", - "protocols": [ - "cwmp" - ], - "description": "Parameters used to force connection to a dedicated IP stream for test purposes.", - "access": false, - "array": false, - "URI": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "RFC 3986 URI that describes the service to connect to in the form: * ://:?StrCtrl=?StrTrspCtrl=?MuxType= where: * is the IP address of the service source (for Unicast) or IGMP group (for Multicast). * is the associated TCP/UDP port. If not specified, the STB is assumed to know and use an appropriate default port. * is the streaming transport protocol and MUST be one of the values in <>, which SHOULD be converted to lower-case. * is the streaming control protocol and MUST be one of the values in <>. If not specified, no streaming control protocol is to be used. * is the streaming transport control protocol and MUST be one of the values in <>. If not specified, no streaming transport control protocol is to be used. * is the multiplex type and MUST be one of the values in <>. This tells the STB which multiplex type to expect. If not specified, the STB is assumed to know, or to be able to determine, the multiplex type. Note that download protocols are not supported by the above syntax. However, the specified syntax is just a baseline, and STBs MAY support an extended syntax. Example of Multicast MPEG2-TS over RTP with no transport control: * rtp://224.112.15.18:3257?StrCtrl=IGMP?MuxType=MPEG2-TS Example of Multicast MPEG2-TS over RTP with AL-FEC transport control: * rtp://224.112.15.18:3257?StrCtrl=IGMP?StrTrspCtrl=AL-FEC?MuxType=MPEG2-TS Example of Unicast MPEG2-TS over UDP with RTSP transport control: * udp://174.146.35.12:3257?StrCtrl=RTSP?MuxType=MPEG2-TS Example of Unicast raw AV over RTP with RTCP control and RTSP transport control: * rtp://174.146.35.12:3257?StrCtrl=RTSP?StrTrspCtrl=RTCP?MuxType=None If a <> instance with ServiceType = IP or IPTV (or VoD if the URI accesses a VoD service) is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance. The value is not saved in device state. The value when read is not specified and need not be the value that was most recently written.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - } - }, - "Device.Services.STBService.{i}.Components.FrontEnd.{i}.IP.ForceMonitor.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> 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.", - "access": false, - "array": false, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "When set to <>, forces the operation mode in ForceMonitor mode When set to <>, forces operation mode in Normal mode.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates the status of the statistic mode of operation. Enumeration of: Normal, Force Monitor.", - "datatype": "string", - "enumerations": [ - "Normal", - "Force Monitor" - ] - }, - "URI": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Describes the service to connect to for force monitoring purposes with the same syntax as <>. If a <> 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.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - } - } - } - }, - "Device.Services.STBService.{i}.Components.PVR.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "PVR details. This is a read-only object that exists only to reference PVR storage objects.", - "access": false, - "array": false, - "StorageNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of <> instances.", - "datatype": "unsignedInt" - }, - "Device.Services.STBService.{i}.Components.PVR.Storage.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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.", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Unique human-readable name associated with this storage instance.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "Reference": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "References the corresponding StorageService <> instance, or an object contained within such an instance, e.g. a PhysicalMedium, LogicalVolume or Folder instance. The value is the full hierarchical name of the corresponding object. Example: Device.Services.StorageService.1", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - } - } - }, - "Device.Services.STBService.{i}.Components.AudioDecoder.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Audio decoder instance table. It contains data representing the current status of the Audio decoder.", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables this audio decoder.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of this audio decoder. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable name associated with this audio decoder.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "AudioStandard": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Audio standard currently being processed by this audio decoder, or an empty string if no audio standard is currently being processed.", - "datatype": "string" - } - }, - "Device.Services.STBService.{i}.Components.VideoDecoder.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Video decoder instance table. It contains data representing the current status of the video decoder.", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables this video decoder.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of this video decoder. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable name associated with this video decoder.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "MPEG2Part2": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "MPEG2 Part 2 profile and level object instance, or <> if MPEG2 Part 2 is not used. For example: .Capabilities.VideoDecoder.MPEG2Part2.ProfileLevel.2", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "MPEG4Part2": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "MPEG4 Part 2 profile and level object instance, or <> if MPEG4 Part 2 is not used). For example: .Capabilities.VideoDecoder.MPEG4Part2.ProfileLevel.2", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "MPEG4Part10": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "MPEG4 Part 10 profile and level object instance, or <> if MPEG4 Part 10 is not used. For example: .Capabilities.VideoDecoder.MPEG4Part10.ProfileLevel.2", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "SMPTEVC1": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "SMPTE-VC-1 profile and level object instance, or <> if SMPTE-VC-1 is not used. For example: .Capabilities.VideoDecoder.SMPTEVC1.ProfileLevel.2", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "ContentAspectRatio": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates the native aspect ratio of the content available at this decoder.", - "datatype": "string", - "enumerations": [ - "4:3", - "16:9" - ] - } - }, - "Device.Services.STBService.{i}.Components.AudioOutput.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Audio output instance table.", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables this audio output.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of this audio output. Enumeration of: Disabled, Enabled, Muted, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Muted", - "Error" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable name associated with this audio output.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "AudioFormat": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Currently active audio output format, or <> if no audio output format is currently active. Note that this parameter refers to output formats and not to physical connectors.", - "datatype": "string" - }, - "AudioLevel": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The audio level on this audio output in <> (0 is quietest and 100 is loudest). This setting is independent of the mute status. For some audio formats, the audio level is not meaningful, in which case this parameter SHOULD have a fixed value of 0.", - "datatype": "unsignedInt", - "range": [ - { - "min": 0, - "max": 100 - } - ], - "unit": "%" - }, - "CancelMute": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "When set to <>, cancels this audio outputs mute status. Setting it to <> has no effect. The value is not saved in device state and is always <> when read.", - "datatype": "boolean" - }, - "SCARTs": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "SCART object instances associated with this audio output, or <> if not associated with any SCART object instances. For example: * .Components.SCART.2 * .Components.SCART.2,.Components.SCART.3", - "list": { - "datatype": "string", - "maxsize": 1024 - } - }, - "CancelMute()": { - "type": "command", - "async": false, - "protocols": [ - "usp" - ] - } - }, - "Device.Services.STBService.{i}.Components.SPDIF.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <>.", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables the S/PDIF output.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of this S/PDIF output. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable name associated with this output.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "ForcePCM": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "When set to <>, forces the audio format over S/PDIF to be in PCM mode. When set to <>, let the compressed audio format be carried over S/PDIF (passthrough).", - "datatype": "boolean" - }, - "Passthrough": { - "type": "boolean", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "When in Passthrough mode, the STB sends the audio stream over S/PDIF without decoding it.", - "datatype": "boolean" - }, - "AudioDelay": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Audio delay value, in <>, currently being applied to the audio stream on the S/PDIF interface. The audio delay is entered by the user via his local UI, when necessary for correcting the lipsync.", - "datatype": "unsignedInt", - "unit": "milliseconds" - } - }, - "Device.Services.STBService.{i}.Components.VideoOutput.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Video output instance table.", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables this video output.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of this video output. Enumeration of: Disabled, Enabled, ColorbarEnabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "ColorbarEnabled", - "Error" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "ColorbarEnable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables the color bar display. When set to <>, the CPE MUST suspend the running service currently using the video output (e.g. IPTV broadcast reception) and MUST display the color bar. When set to <>, the CPE MUST resume the previousely running service. This parameter MUST be always initialized with the value <> on STB boot.", - "datatype": "boolean" - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable name associated with this Video output.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "CompositeVideoStandard": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The type of analog video standard currently in use or <> if no analog video standard is currently in use. Note that this parameter applies only to the CVBS output format.", - "datatype": "string" - }, - "VideoFormat": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Currently active video output format, or <> if no video output format is currently active. Note that this parameter refers to output formats and not to physical connectors.", - "datatype": "string" - }, - "AspectRatioBehaviour": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates the aspect ratio behaviour for display on monitors with an aspect ratio different from that of the content, which is specified in <.ContentAspectRatio>>.", - "datatype": "string", - "enumerations": [ - "None", - "Letterbox", - "16:9 Letterbox", - "14:9 Letterbox", - "CenterCutOut", - "Combined", - "Combined 16:9 Letterbox and CenterCutOut", - "Combined 14:9 Letterbox and CenterCutOut" - ] - }, - "DisplayFormat": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Display format being connected to this VideoOutput. This parameter is used by the STB to determine whether an aspect ratio conversion is required.", - "datatype": "string" - }, - "Macrovision": { - "type": "boolean", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates whether Macrovision analog protection is being used on this video output. The Macrovision version supported is indicated in <>.", - "datatype": "boolean" - }, - "HDCP": { - "type": "boolean", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates whether HDCP is being used on this video output. The HDCP version supported is indicated in <>.", - "datatype": "boolean" - }, - "SCARTs": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "SCART object instances associated with this video output, or <> if not associated with any SCART object instances. For example: * .Components.SCART.2 * .Components.SCART.2,.Components.SCART.3", - "list": { - "datatype": "string", - "maxsize": 1024 - } - } - }, - "Device.Services.STBService.{i}.Components.SCART.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "SCART configuration. This object allows configuration of the STBs AV switching.", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables this SCART connector.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of this SCART connector. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable name associated with this connector.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "Presence": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables the Presence control signal (pin 8 of the SCART connector), an output from the STB to control the display device connected to the SCART. When enabled (set to <>) the STB MUST drive pin 8 to the appropriate level to indicate the output video format (SD or HD) to the connected device. When disabled (set to <>) the STB MUST NOT drive pin 8.", - "datatype": "boolean" - } - }, - "Device.Services.STBService.{i}.Components.HDMI.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "HDMI instance table. This object allows configuration of the STB\u2019s HDMI output.", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables the HDMI output.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of HDMI output. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable name associated with this output.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "ResolutionMode": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The resolution mode of the HDMI output. In <> mode, the resolution is automatically set at the best format via HDMI protocols. In <> mode, the resolution to be applied to the HDMI output is given by the ResolutionValue parameter.", - "datatype": "string", - "enumerations": [ - "Auto", - "Manual" - ] - }, - "ResolutionValue": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "When <> is set to <> mode, a write action configures the resolution to be applied to the HDMI output, When <> is set to <>, a write action as no effect. A read action provides the current resolution of the HDMI output.", - "datatype": "string" - }, - "Device.Services.STBService.{i}.Components.HDMI.{i}.DisplayDevice.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "HDMI connected display device configuration. This object provides parameters from the HDMI connected device if any.", - "access": false, - "array": false, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of the connected HDMI Display device. Enumeration of: Present, None, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Present", - "None", - "Error" - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable name associated with this display device.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "EEDID": { - "type": "hexBinary", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enhanced Extended Display Information Data (E-EDID) retrieved from the connected HDMI device.", - "datatype": "hexBinary", - "range": [ - { - "max": 256 - } - ] - }, - "SupportedResolutions": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is a supported resolution of the connected HDMI device and MUST be one element of <>.", - "list": { - "datatype": "string" - } - }, - "PreferredResolution": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Preferred connected HDMI device resolution format.", - "datatype": "string" - }, - "VideoLatency": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Video latency, in <>, being applied in the connected HDMI device. This parameter is extracted from the E-EDID and can be used to compensate the video latency to preserve lipsync.", - "datatype": "unsignedInt", - "unit": "milliseconds" - }, - "CECSupport": { - "type": "boolean", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "When set to <>, indicates the connected HDMI device is supporting HDMI-CEC features. When set to <>, indicates the connected HDMI device does not support HDMI CEC.", - "datatype": "boolean" - }, - "AutoLipSyncSupport": { - "type": "boolean", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "When set to <>, indicates the connected display device supports auto lip synchronization. This mode consists in communicating over HDMI, the delay to be applied by the STB to the audio in order to preserve the lip sync.", - "datatype": "boolean" - }, - "HDMI3DPresent": { - "type": "boolean", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "When set to <>, indicates the connected display device supports the 3D video formats mandated by <>.", - "datatype": "boolean" - } - } - }, - "Device.Services.STBService.{i}.Components.CA.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "This object describes the characteristics of the Conditional Access, if any.", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables this CA system.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of this CA system. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates a unique identifier (e.g. the commercial name: La 7 piu, Mediaset Premium) for this CA system.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "SmartCardReader": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Path name of the smart card reader object instance containing the smart card (if any) associated with this CA system. The value MUST be <> (if not associated with a smart card) or else be the full path name of the corresponding smart card reader object. For example: Device.SmartCardReader.1", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - } - }, - "Device.Services.STBService.{i}.Components.DRM.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "This object describes the characteristics of the Digital Rights Management, if any.", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables this DRM system.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of this DRM system. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates a unique identifier (e.g. the commercial name: La 7 piu, Mediaset Premium) for this DRM system.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "SmartCardReader": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Path name of the smart card reader object instance containing the smart card (if any) associated with this DRM system. The value MUST be <> (if not associated with a smart card) or else be the full path name of the corresponding smart card reader object. For example: Device.SmartCardReader.1", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - } - } - }, - "Device.Services.STBService.{i}.AVStreams.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "AV Streams object. If more than one AV stream can be active at a time, it may contain several <> instances.", - "access": false, - "array": false, - "ActiveAVStreams": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of AV streams currently active (i.e. with Status != Disabled, which means audio or AV data are being processed).", - "datatype": "unsignedInt" - }, - "AVStreamNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of <> instances.", - "datatype": "unsignedInt" - }, - "Device.Services.STBService.{i}.AVStreams.AVStream.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Details of each AVStream. AV streams are created statically. Each AV stream corresponds to a valid instance combination (although if the PVR is active for this stream, only or will be in use).", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of this AV stream. Enumeration of: Disabled, Enabled, Error_PVRWriteFailure, Error_PVRReadFailure, Error. An AV stream is disabled if any of the referenced objects are disabled. If an AV stream is disabled then the values of other AV stream parameters are not significant. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error_PVRWriteFailure", - "Error_PVRReadFailure", - "Error" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable name associated with this stream, e.g. read from the DVB service information metadata.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "PVRState": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates whether this stream is using the PVR and, if so, the PVR state. Enumeration of: Disabled, Stopped, Play, Paused, FastForward, Rewind. PVR record state can be inferred from whether the stream has an input FrontEnd: if so and <> is not <>, the PVR is recording.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Stopped", - "Play", - "Paused", - "FastForward", - "Rewind" - ] - }, - "FrontEnd": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Input FrontEnd object instance associated with this AV stream, or <> if not associated with a FrontEnd object). For example: .Components.FrontEnd.2", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "Inbound": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Inbound IP stream object instance associated with the FrontEnd for this AV stream, or <> if the inbound stream is not delivered over IP. For example: .Components.FrontEnd.2.IP.Inbound.3", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "Outbound": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Outbound IP stream object instance associated with the output FrontEnd for this AV stream (which is always the IP FrontEnd), or <> if the outbound stream is not delivered over IP. For example: .Components.FrontEnd.2.IP.Outbound.3", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "AudioDecoder": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Audio Decoder object instance associated with this AV stream, or <> if not associated with an Audio Decoder object. For example: .Components.AudioDecoder.2", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "VideoDecoder": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Video Decoder object instance associated with this AV stream, or <> if not associated with a Video Decoder object. For example: .Components.VideoDecoder.2", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "CA": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "CA system object instance associated with this AV stream, or <> if not associated with a CA object. For example: .Components.CA.2", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "DRM": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "DRM system object instance associated with this AV stream, or <> if not associated with a DRM object. For example: .Components.DRM.2", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - } - } - }, - "Device.Services.STBService.{i}.AVPlayers.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "AV Players object. If more than one AV player can be active at a time, it may contain several <> 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.", - "access": false, - "array": false, - "ActiveAVPlayers": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of AV players currently active (i.e. with Status != Disabled, which means the <> is processing an audio or AV stream).", - "datatype": "unsignedInt" - }, - "AVPlayerNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of <> instances.", - "datatype": "unsignedInt" - }, - "PreferredAudioLanguage": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable string, as specified in <>, describing the audio language that SHOULD be used by the STB when receiving a multi-language audio multiplex. <> indicates that there is no preferred audio language.", - "datatype": "string", - "range": [ - { - "max": 64 - } - ] - }, - "PreferredSubtitlingLanguage": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable string, as specified in <>, describing the subtitling language that SHOULD be used by the STB when receiving multi-language subtitling. A value of None indicates that no subtitling is required. <> indicates that there is no preferred subtitling language.", - "datatype": "string", - "range": [ - { - "max": 64 - } - ] - }, - "PreferredBehaviour": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Aspect ratio behaviour preference for display on monitor. If non-empty, the string MUST be one of the .Components.VideoOutput.. AspectRatioBehaviour values.", - "datatype": "string", - "range": [ - { - "max": 64 - } - ] - }, - "ResetPINCode": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "When set to <>, the master PIN code for the STB is set to 0000. Setting it to <> has no effect. The value is not saved in device state and is always <> when read. It is not recommended that this be set to true without the users permission. No data on the device such as PVR recordings are to be cleared as a result of resetting the PIN code.", - "datatype": "boolean" - }, - "ResetPINCode()": { - "type": "command", - "async": false, - "protocols": [ - "usp" - ] - }, - "Device.Services.STBService.{i}.AVPlayers.AVPlayer.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "List of AV Player objects. Each item is one particular AV player being processed by the STB.", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables this AV player.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of this AV player. Enumeration of: Disabled, Enabled, Error. If an AV player is disabled then the values of other AV player parameters are not significant. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable name associated with this AV player.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "AudioLanguage": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable string, as specified in <>, describing the audio language being currently processed by the AV player.", - "datatype": "string", - "range": [ - { - "max": 64 - } - ] - }, - "SubtitlingStatus": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of subtitling for this AV player. Enumeration of: Disabled, Enabled, Error. Subtitles are assumed to be shown only on the main screen. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "SubtitlingLanguage": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Human-readable string, as specified in <>, describing the subtitling language being currently processed by the AV player. Subtitles are assumed to be shown only on the main screen.", - "datatype": "string", - "range": [ - { - "max": 64 - } - ] - }, - "AudioOutputs": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Audio output object instances associated with this AV player, or <> if not associated with any audio output object instances. For example: .Components.AudioOutput.2", - "list": { - "datatype": "string", - "maxsize": 1024 - } - }, - "VideoOutputs": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Video output object instances associated with this AV player, or <> if not associated with any video output object instances. For example: .Components.VideoOutput.2", - "list": { - "datatype": "string", - "maxsize": 1024 - } - }, - "MainStream": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "AV stream object instance associated with this AV player that is being sent to the main screen, or <> if not associated with an AV stream object. For example: .AVStreams.AVStream.2", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "PIPStreams": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "AV stream object instances associated with this AV player that are being displayed as Picture In Picture (PIP), or <> if not associated with any PIP AV stream objects. For example: * .AVStreams.AVStream.2 * .AVStreams.AVStream.2,.AVStreams.AVStream.3", - "list": { - "datatype": "string", - "maxsize": 1024 - } - } - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> 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 <> for non-normative explanation of the operation of the ServiceMonitoring object.", - "access": false, - "array": false, - "SampleEnable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables collection of Sample statistics. When collection of Sample statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.", - "datatype": "boolean" - }, - "SampleState": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates availability of Sample statistics. Enumeration of: Disabled, Enabled, Trigger. The <> value is only used for triggering the ACS to fetch the collected data and can only be used when <> is in the range [1:<>]. The transition from <> -> <> -> <> MUST be instantaneous and so will result in only a single value change for notification purposes.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Trigger" - ] - }, - "SampleInterval": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The sample interval in <>. Each statistic is measured over this sample interval. The STB MAY reject a request to set <> to less than <>. Sample intervals MUST begin every <> seconds, with no delay between samples. If <> is changed while collection of Sample statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. For example, if <> is 24 and <> is 3600 (an hour), the STB can store up to a days worth of samples for each statistic.", - "datatype": "unsignedInt", - "range": [ - { - "min": 1 - } - ], - "unit": "seconds" - }, - "ReportSamples": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of samples that the STB can store and report for each statistic. The STB MUST permit <> to be set to any value in the range from 1 to <>. If <> is changed while collection of Sample statistics is enabled, the STB will truncate or extend its statistics buffers as appropriate, but statistics collection MUST NOT otherwise be affected. For example, if <> is 24 and <> is 3600 (an hour), the STB can store up to a days worth of samples for each statistic.", - "datatype": "unsignedInt", - "range": [ - { - "min": 1 - } - ] - }, - "EventsPerSampleInterval": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of event measurements of each applicable statistic that the STB is able to store for each sample interval. The STB MUST permit <> to be set to any value in the range from 1 to <>. If <> is changed while collection of Sample statistic is enabled, the STB will truncate or extend its event measurement buffers as appropriate, but event measurement collection MUST NOT otherwise be affected. For example, if <> is 24 and <> is 3600 (an hour), and <> is 60, the STB can store up 60 event measurements per hour, or in total 1440 event measurements per day.", - "datatype": "unsignedInt", - "range": [ - { - "min": 1 - } - ] - }, - "FetchSamples": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "If collection of Sample statistics is enabled and <> is in the range [1:<>] then <> MUST transition from <> -> <> -> <> on completion of every <> sample intervals. Otherwise, this transition MUST NOT occur. For example, if <> is 25 and <> is 24, then the STB will store 25 values for each statistic and the above <> transition will occur every 24 sample intervals, which means that the ACS could delay for up to two sample intervals before reading the stored values and would still not miss any samples (see also <>).", - "datatype": "unsignedInt" - }, - "TimeReference": { - "type": "dateTime", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "An absolute time reference in UTC to determine when sample intervals will complete. Each sample interval MUST complete at this reference time plus or minus an integer multiple of <>. This time reference also determines when the <> <> -> <> -> <> transitions that are controlled by <> will occur. If collection of Sample statistics is enabled and <> is in the range [1:<>] then each such <> transition MUST occur at this reference time plus or minus an integer multiple of <> * <> (the fetch interval). <> is used only to set the phase of the sample and fetch intervals. The actual value of <> can be arbitrarily far into the past or future. If <> is changed while collection of Sample statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. The Unknown Time value defined in <> indicates that no particular time reference is specified. That is, the STB MAY locally choose the time reference, and is required only to adhere to the specified sample and fetch intervals. If absolute time is not available to the STB, its sample and fetch interval behavior MUST be the same as if the <> parameter was set to the Unknown Time value. For example, if <> is 3600 (an hour) and if <> is set to UTC midnight on some day (in the past, present, or future) then sample intervals will complete on each UTC hour (00:00, 01:00, 02:00 etc). If, in addition, <> is 24, then the fetch interval is 86400 (a day) and <> <> -> <> -> <> transitions will occur every day at UTC midnight. Note that, if <> is set to a time other than the Unknown Time, the first sample interval (which has to begin immediately) will almost certainly be shorter than <>). This is why <> is defined in terms of when sample intervals complete rather than start.", - "datatype": "dateTime" - }, - "ForceSample": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "When set to <>, forces statistics for the current sample to be calculated and updated in the data model. Setting it to <> has no effect. The value is not saved in device state and is always <> when read. If this is the first time that <> has been set to true 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 <> and all SampleSeconds parameters MUST be updated accordingly. If this is not the first time that <> has been set to <> during the current sample interval, then the new values that were added as described in the previous paragraph, and the <> and all SampleSeconds parameters, MUST be updated accordingly. Note that <> 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 <> was set to <> during the sample interval then the new values that were added as described above, and the <> and all SampleSeconds parameters, will be updated accordingly. In other words, the partial sample data that was created when <> was set to <> will be updated one last time at the end of the sample interval.", - "datatype": "boolean" - }, - "ReportStartTime": { - "type": "dateTime", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The absolute time at which the sample interval for the first stored sample (for each statistic) started.", - "datatype": "dateTime" - }, - "ReportEndTime": { - "type": "dateTime", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The absolute time at which the sample interval for the last stored sample (for each statistic) ended. If <> has been used to force statistics for the current sample to be calculated and updated in the data model, then <> MUST be updated to reflect the actual time over which stored data was collected.", - "datatype": "dateTime" - }, - "MainStreamNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of <> instances.", - "datatype": "unsignedInt" - }, - "EventCollectionEnable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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.", - "datatype": "boolean" - }, - "ForceSample()": { - "type": "command", - "async": false, - "protocols": [ - "usp" - ] - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 instances service type MUST NOT contribute to the instances 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. <.IP.ServiceConnect.URI>>, include requirements that restrict the STBs freedom to determine which AV stream should be regarded as the Main AV stream for a given service.", - "uniqueKeys": [ - "ServiceType", - "Alias" - ], - "access": false, - "array": true, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and the value of the <> to be <>.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total and Sample statistics and event collection status for this object instance. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "SessionId": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Time based UUID <> that is the identifier for the associated <> parameter when available to the device.", - "datatype": "UUID", - "range": [ - { - "min": 36, - "max": 36 - } - ], - "pattern": [ - "[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}" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "ServiceType": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Service type associated with this main stream instance, or <> if this instance is disabled. The STB MUST reject a request that would result in a given AV stream contributing to more than one <> instance, e.g. it would reject a request to enable simultaneous collection of both IPTV and IP statistics, or to collect IPTV statistics on more than one instance.", - "datatype": "string" - }, - "AVStream": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Main AV stream object instance currently associated with this ServiceMonitoring main stream instance. For example: .AVStreams.AVStream.2 Note that, during the period of time over which Sample statistics are stored, this ServiceMonitoring main stream instance might be associated with many different AVStream instances. This parameter just provides information about which AVStream is currently being monitored.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "Gmin": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Minimum number of consecutive received packets after the end of an RTP Loss Event. A Loss Event is defined as as a sequence of lost packets, possibly including islands of received packets. Each island consists of up to (<> - 1) received packets (a sequence of <> received packets terminates the Loss Event, and so is not an island).", - "datatype": "unsignedInt" - }, - "SevereLossMinDistance": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The minimum distance required between error events before an RTP Loss Event is considered severe. Used in the calculation of SevereLossIndexCount and SevereLossIndexCountBeforeEC.", - "datatype": "unsignedInt" - }, - "SevereLossMinLength": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The minimum value for the count of lost packets per RTP Loss Event before the count of lost packets is considered severe. Used in the calculation of SevereLossLengthCount and SevereLossLengthCountBeforeEC.", - "datatype": "unsignedInt" - }, - "ChannelChangeFailureTimeout": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Time period, in <>, between a user channel change request (defined as the instant of transmission of the relevant control protocol message (IGMP JOIN or RTSP SETUP) or a tuner command in case of DTT), and the display of the first I frame for the current AVStream, above which a channel change is considered as failed.", - "datatype": "unsignedInt", - "unit": "seconds" - }, - "PacketsLostByEventHistogramIntervals": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> Definition of the histogram intervals for counting loss events according to their size (in <>). Each value indicates the maximum value of the interval. For example, 1,2,4,8, defines the five intervals: 1 packet lost, 2 packets, 3 or 4 packets, 5 to 8 packets and 9 or more packets. (No value after the last comma means no upper bound.) If this parameter is set to an empty string, no PacketsLostByEvent stats will be collected.", - "list": { - "datatype": "unsignedInt", - "range": [ - { - "min": 1 - } - ], - "unit": "packets" - } - }, - "DelayBetweenLossEventsHistogramIntervals": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> Definition of the histogram intervals for counting loss events according to their delay (in <>) after the preceding loss event. Each value indicates the maximum value of the interval. For example, 10,20,50,100,1000,60000,3600000, defines the intervals up to 10 ms, to 20 ms, to 50 ms, to 100 ms, to 1 s, to 1 mn, to 1 h and more than 1 h. (No value after the last comma means no upper bound.) If this parameter is set to an empty string, no DelayBetweenLossEvents stats will be collected.", - "list": { - "datatype": "unsignedInt", - "range": [ - { - "min": 1 - } - ], - "unit": "milliseconds" - } - }, - "DurationSevereLossEventsHistogramIntervals": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> Definition of the histogram intervals for counting severe loss events according to their duration (in <>). Each value indicates the maximum value of the interval. For example, 50,100,500,1000,2000,5000,10000,120000, defines the intervals up to 50 ms, to 100 ms, to 500 ms, to 1 s, to 2 s etc. (No value after the last comma means no upper bound.) If this parameter is set to an empty string, no DurationSevereLossEvents stats will be collected.", - "list": { - "datatype": "unsignedInt", - "range": [ - { - "min": 1 - } - ], - "unit": "milliseconds" - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total statistics since this ServiceMonitoring main stream instance was last enabled or Total statistics were last reset.", - "access": false, - "array": false, - "TotalSeconds": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own <> parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual <> values can be less than the <>, for several reasons, including the STB was not receiving any data (Standby mode without force monitoring).", - "datatype": "unsignedInt" - }, - "Reset": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "When set to <>, resets Total statistics for this ServiceMonitoring main stream instance. Setting it to <> has no effect. The value is not saved in device state and is always <> when read.", - "datatype": "boolean" - }, - "ResetTime": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of seconds since the Total statistics were last enabled or reset for this ServiceMonitoring main stream instance.", - "datatype": "unsignedInt" - }, - "Reset()": { - "type": "command", - "async": false, - "protocols": [ - "usp" - ] - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.DejitteringStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total de-jittering statistics for this ServiceMonitoring main stream instance.", - "access": false, - "array": false, - "TotalSeconds": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own <> parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual <> values can be less than <.Total.ResetTime>>, for several reasons, including: * Any of the reasons for which the <> values might be less than <.Total.ResetTime>>. * De-jittering data collection is not appropriate or possible for this AV stream.", - "datatype": "unsignedInt" - }, - "EmptyBufferTime": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total time, in <>, for which the playout was stopped due to buffer issues (empty or too low level) for this AV stream.", - "datatype": "unsignedInt", - "unit": "milliseconds" - }, - "Overruns": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of times the receive jitter buffer has overrun for this AV stream.", - "datatype": "unsignedInt" - }, - "Underruns": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of times the receive jitter buffer has underrun for this AV stream.", - "datatype": "unsignedInt" - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.TCPStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total TCP statistics for this ServiceMonitoring main stream instance.", - "access": false, - "array": false, - "TotalSeconds": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own <> parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual <> values can be less than <.Total.ResetTime>>, for several reasons, including: * Any of the reasons for which the <> values might be less than <.Total.ResetTime>>. * TCP data collection is not appropriate or possible for this AV stream.", - "datatype": "unsignedInt" - }, - "PacketsReceived": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of TCP packets correctly received for this AV stream.", - "datatype": "unsignedInt" - }, - "PacketsRetransmitted": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of TCP packets being retransmitted for this AV stream.", - "datatype": "unsignedInt" - }, - "BytesReceived": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of bytes received for this AV stream.", - "datatype": "unsignedInt" - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.RTPStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total RTP statistics for this ServiceMonitoring main stream instance. If no EC is applied the BeforeEC statistics provide the same values as the corresponding statistics, e.g. when there is no EC, <> = <>.", - "access": false, - "array": false, - "TotalSeconds": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own <> parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual <> values can be less than <.Total.ResetTime>>, for several reasons, including: * Any of the reasons for which the <> values might be less than <.Total.ResetTime>>. * RTP data collection is not appropriate or possible for this AV stream.", - "datatype": "unsignedInt" - }, - "PacketsExpected": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of RTP packets expected for this AV stream as described in <>.", - "datatype": "unsignedInt" - }, - "PacketsDiscarded": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of packets discarded at the RTP layer for this AV stream because they were too late for playout, regardless of their being out of sequence or not. These statistics are collected when no EC is applied or after any EC if available.", - "datatype": "unsignedInt" - }, - "PacketsOutOfSequence": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of packets out of sequence at the RTP level for this AV stream, regardless of their being too late for playout or not. These statistics are collected when no EC is applied or after any EC if available.", - "datatype": "unsignedInt" - }, - "PacketsReceived": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of RTP packets received for this AV stream. These statistics are collected when no EC is applied or after any EC if available.", - "datatype": "unsignedInt" - }, - "PacketsReceivedBeforeEC": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of RTP packets received for this AV stream. These statistics are collected before any EC, if available, is applied.", - "datatype": "unsignedInt" - }, - "PacketsLost": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of RTP packets lost for this stream. These statistics are collected when no EC is applied or after any EC if available.", - "datatype": "unsignedInt" - }, - "PacketsLostBeforeEC": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of RTP packets lost for this stream. These statistics are collected before any EC, if available, is applied.", - "datatype": "unsignedInt" - }, - "PacketsLostByEventHistogram": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> Total number of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by <>. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "unsignedInt" - } - }, - "PacketsLostByEventHistogramBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> Total number of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by <>. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "unsignedInt" - } - }, - "LossEvents": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of Loss Events for this stream. These statistics are collected when no EC is applied or after any EC if available.", - "datatype": "unsignedInt" - }, - "LossEventsBeforeEC": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of Loss Events for this stream. These statistics are collected before any EC, if available, is applied.", - "datatype": "unsignedInt" - }, - "DelayBetweenLossEventsHistogram": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> Total number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by <>. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "unsignedInt" - } - }, - "DelayBetweenLossEventsHistogramBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> Total number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by <>. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "unsignedInt" - } - }, - "SevereLossIndexCount": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of Loss Events closer than SevereLossMinDistance. These statistics are collected when no EC is applied or after any EC if available.", - "datatype": "unsignedInt" - }, - "SevereLossIndexCountBeforeEC": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of Loss Events closer than SevereLossMinDistance. These statistics are collected before any EC, if available, is applied.", - "datatype": "unsignedInt" - }, - "SevereLossLengthCount": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of Loss Events longer than SevereLossMinLength. These statistics are collected when no EC is applied or after any EC if available.", - "datatype": "unsignedInt" - }, - "SevereLossLengthCountBeforeEC": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of Loss Events longer than SevereLossMinLength. These statistics are collected before any EC, if available, is applied.", - "datatype": "unsignedInt" - }, - "DurationSevereLossEventsHistogram": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> Total number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by <>. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "unsignedInt" - } - }, - "DurationSevereLossEventsHistogramBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> Total number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by <>. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "unsignedInt" - } - }, - "RetransmitTimeouts": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of RTP/AVPF retransmission timeouts (<>, <>) If RTP/AVPF is not used this parameter does not increment", - "datatype": "unsignedInt" - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.MPEG2TSStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total MPEG2-TS statistics for this ServiceMonitoring main stream instance.", - "access": false, - "array": false, - "TotalSeconds": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own <> parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual <> values can be less than <.Total.ResetTime>>, for several reasons, including: * Any of the reasons for which the <> values might be less than <.Total.ResetTime>>. * MPEG2 TS data collection is not appropriate or possible for this AV stream.", - "datatype": "unsignedInt" - }, - "TSPacketsReceived": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of MPEG2-TS packets received for this AV stream.", - "datatype": "unsignedInt" - }, - "TSSyncByteErrorCount": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of MPEG2-TS packets with an invalid transport sync byte received for this AV stream. Not meaningful when MPEG2-TS is transported over IP.", - "datatype": "unsignedInt" - }, - "TSSyncLossCount": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of MPEG2-TS Loss of Synchronization Events for this AV stream. Not meaningful when MPEG2-TS is transported over IP.", - "datatype": "unsignedInt" - }, - "PacketDiscontinuityCounter": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of MPEG2-TS Discontinuity errors that have been captured for this AV stream. This parameter accumulates all of the discontinuities observed for all currently monitored PIDs. These statistics are collected when no CA decryption scheme is in use or after any CA decryption if in use.", - "datatype": "unsignedInt" - }, - "PacketDiscontinuityCounterBeforeCA": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of MPEG2-TS Discontinuity errors that have been captured for this AV stream. This parameter accumulates all of the discontinuities observed for all currently monitored PIDs. These statistics are collected before any CA decryption scheme, if used, is applied.", - "datatype": "unsignedInt" - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.VideoDecoderStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total video decoder application layer statistics for this ServiceMonitoring main stream instance.", - "access": false, - "array": false, - "TotalSeconds": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own <> parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual <> values can be less than <.Total.ResetTime>>, for several reasons, including: * Any of the reasons for which the <> values might be less than <.Total.ResetTime>>. * Video Decoder data collection is not appropriate or possible for this AV stream.", - "datatype": "unsignedInt" - }, - "FrameRate": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The latest frame rate at which the STB played out the video content for this AV stream. Also the reported rate will be rounded off to the nearest integer.", - "datatype": "unsignedInt" - }, - "DecodedFrames": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of video frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream.", - "datatype": "unsignedInt" - }, - "LostFrames": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of video frames that could not be reproduced by the STB for this AV stream.", - "datatype": "unsignedInt" - }, - "ConcealedFrames": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of video frames that were reproduced by the STB for which some information was missing and loss concealment was applied for this AV stream.", - "datatype": "unsignedInt" - }, - "IDecodedFrames": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of I frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream.", - "datatype": "unsignedInt" - }, - "ILostFrames": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of I frames that could not be reproduced by the STB for this AV stream.", - "datatype": "unsignedInt" - }, - "IConcealedFrames": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of I frames that were reproduced by the STB for which some information was missing and loss concealment applied for this AV stream.", - "datatype": "unsignedInt" - }, - "PDecodedFrames": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of P frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream.", - "datatype": "unsignedInt" - }, - "PLostFrames": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of P frames that could not be reproduced by the STB for this AV stream.", - "datatype": "unsignedInt" - }, - "PConcealedFrames": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of P frames that were reproduced by the STB for which some information was missing and loss concealment applied for this AV stream.", - "datatype": "unsignedInt" - }, - "BDecodedFrames": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of B frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream.", - "datatype": "unsignedInt" - }, - "BLostFrames": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of B frames that could not be reproduced by the STB for this AV stream.", - "datatype": "unsignedInt" - }, - "BConcealedFrames": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of B frames that were reproduced by the STB for which some information was missing and loss concealment applied for this AV stream.", - "datatype": "unsignedInt" - }, - "AVResynchCounter": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of AV resynchronizations that were performed by the STB for this AV stream.", - "datatype": "unsignedInt" - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.AudioDecoderStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total audio decoder application layer statistics for this ServiceMonitoring main stream instance.", - "access": false, - "array": false, - "TotalSeconds": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own <> parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual <> values can be less than <.Total.ResetTime>>, for several reasons, including: * Any of the reasons for which the <> values might be less than <.Total.ResetTime>>. * Audio Decoder data collection is not appropriate or possible for this AV stream.", - "datatype": "unsignedInt" - }, - "DecodedFrames": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of audio frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream.", - "datatype": "unsignedInt" - }, - "DecodingErrors": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of audio decoding errors detected for this AV stream.", - "datatype": "unsignedInt" - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.VideoResponseStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total video response statistics for this ServiceMonitoring main stream instance.", - "access": false, - "array": false, - "TotalSeconds": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own <> parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual <> values can be less than <.Total.ResetTime>>, for several reasons, including: * Any of the reasons for which the <> values might be less than <.Total.ResetTime>>. * Video response data collection is not appropriate or possible for this AV stream.", - "datatype": "unsignedInt" - }, - "ChannelChangeFailures": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of channel change failures. A channel change is considered as failed when the time period between a user channel change request and the display of the first I frame for this AVStream is above <.ChannelChangeFailureTimeout>>.", - "datatype": "unsignedInt" - }, - "ChannelFailures": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry represents a channel for which a channel change failed. Channels MAY be described as IP address, URL or Service names as appropriate. Only last 10 failures are required to be reported.", - "list": { - "datatype": "string", - "item": { - "max": 10 - } - } - }, - "MinimumVoDControlResponse": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Minimum time period, in <>, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused.", - "datatype": "unsignedInt", - "unit": "milliseconds" - }, - "MaximumVoDControlResponse": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum time period, in <>, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused.", - "datatype": "unsignedInt", - "unit": "milliseconds" - }, - "RequestedTransactions": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of RTSP protocol requests to start a VoD program display. Only meaningful for VoD.", - "datatype": "unsignedInt" - }, - "AccessSuccesses": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of successful VoD attempts. An attempt is considered successful when the first I-frame is displayed by the client. Only meaningful for VoD.", - "datatype": "unsignedInt" - }, - "CompletionCount": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Total number of completed VoD requests. An attempt is defined successful if it continues until a RTSP protocol request to end the session is sent by the STB. Only meaningful for VoD.", - "datatype": "unsignedInt" - }, - "MinimumVideoSystemResponse": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Minimum time period (in <>) between the instant of transmitting an IGMP JOIN command or an RTSP SETUP command, and the display of the first I frame for this AV stream.", - "datatype": "unsignedInt", - "unit": "milliseconds" - }, - "MaximumVideoSystemResponse": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum time period (in <>) between the instant of transmitting an IGMP JOIN command or an RTSP SETUP command, and the display of the first I frame for this AV stream.", - "datatype": "unsignedInt", - "unit": "milliseconds" - } - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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. Each comma-separated list can contain up to <> statistics values. When the list is full, each new value causes the oldest one to be discarded. Some comma-separated lists contain terms that are comma-separated lists themselves and are used to store measurements on an event basis. These sub-lists can contain up to <> 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.", - "access": false, - "array": false, - "SampleSeconds": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of seconds during which data was collected for this AV stream during the sample interval. Each statistics category (Dejittering, RTP etc) has its own SampleSeconds parameter, which indicates the number of seconds during which data was collected for that statistics category during the sample interval. Individual SampleSeconds values can be less than the SampleInterval, for several reasons, including: * The STB was not receiving any data for the corresponding ServiceType for all or part of the sample interval. * TimeReference has been set to a time other than the Unknown Time and the current sample interval started part of the way through a scheduled sample interval. * ForceSample has been used to force statistics for the current sample to be calculated and updated in the data model.", - "list": { - "datatype": "unsignedInt", - "unit": "seconds" - } - }, - "SignificantChanges": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of times that a channel change (or other potentially disruptive event) occurred for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "PVRTimeShift": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is a Boolean that indicates whether the PVR, with a non-zero time-shift, was used at any time for this AV stream during the sample interval.", - "list": { - "datatype": "boolean" - } - }, - "HighLevelMetricStatsNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of <> instances.", - "datatype": "unsignedInt" - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.DejitteringStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "De-jittering Sample statistics for this ServiceMonitoring main stream instance.", - "access": false, - "array": false, - "SampleSeconds": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of seconds during which de-jittering data was collected for this AV stream during the sample interval. Individual <> values can be less than the sample interval, for several reasons, including: * Any of the reasons for which the <.Sample.SampleSeconds>> values might be less than the sample interval. * De-jittering data collection is not appropriate or possible for this AV stream.", - "list": { - "datatype": "unsignedInt", - "unit": "seconds" - } - }, - "Overruns": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of times the receive jitter buffer has overrun for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "Underruns": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of times the receive jitter buffer has underrun for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "EmptyBufferTime": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the time period, in <>, for which the playout was stopped due to buffer issues (empty or too low level) for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt", - "unit": "milliseconds" - } - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.TCPStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "TCP sample statistics for this ServiceMonitoring main stream instance.", - "access": false, - "array": false, - "SampleSeconds": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of seconds during which de-jittering data was collected for this AV stream during the sample interval. Individual <> values can be less than the sample interval, for several reasons, including: * Any of the reasons for which the <.Sample.SampleSeconds>> values might be less than the sample interval. * TCP data collection is not appropriate or possible for this AV stream.", - "list": { - "datatype": "unsignedInt", - "unit": "seconds" - } - }, - "PacketsReceived": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of TCP packets received for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "PacketsRetransmitted": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of TCP packets being retransmitted this AV stream.during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "BytesReceived": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of bytes received for this AV stream.during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.RTPStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "RTP Sample statistics for this ServiceMonitoring main stream instance. If no EC is applied the BeforeEC statistics provide the same values as the corresponding statistics, e.g. when there is no EC, <> = <>.", - "access": false, - "array": false, - "SampleSeconds": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of seconds during which RTP data was collected for this AV stream during the sample interval. Individual <> values can be less than the sample interval, for several reasons, including: * Any of the reasons for which the <.Sample.SampleSeconds>> values might be less than the sample interval. * RTP data collection is not appropriate or possible for this AV stream.", - "list": { - "datatype": "unsignedInt", - "unit": "seconds" - } - }, - "PacketsExpected": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of RTP packets expected for this AV stream during the sample interval as described in <>.", - "list": { - "datatype": "unsignedInt" - } - }, - "PacketsDiscarded": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of packets that were discarded at the RTP layer for this AV stream during the sample interval because they were too late for playout, regardless of their being out of sequence or not. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "unsignedInt" - } - }, - "PacketsOutOfSequence": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of packets out of sequence at the RTP level for this AV stream during the sample interval, regardless of their being too late for playout or not. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "unsignedInt" - } - }, - "PacketsReceived": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of RTP packets received for this AV stream during the sample interval. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "unsignedInt" - } - }, - "PacketsReceivedBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of RTP packets received for this AV stream during the sample interval. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "unsignedInt" - } - }, - "RetransmitTimeouts": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of RTP/AVPF retransmission timeouts (<>, <>) for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "PacketsLost": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of RTP packets lost for this AV stream during the sample interval. Calculated by looking for missing RTP sequence headers. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "unsignedInt" - } - }, - "PacketsLostBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of RTP packets lost for this AV stream during the sample interval. Calculated by looking for missing RTP sequence headers. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "unsignedInt" - } - }, - "PacketsLostByEventHistogram": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by <>. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "string" - } - }, - "PacketsLostByEventHistogramBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by <>. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "string" - } - }, - "LossEvents": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of Loss Events for this AV stream during the sample interval. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "unsignedInt" - } - }, - "LossEventsBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of Loss Events for this AV stream during the sample interval. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "unsignedInt" - } - }, - "DelayBetweenLossEventsHistogram": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by <>. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "string" - } - }, - "DelayBetweenLossEventsHistogramBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by <>. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "string" - } - }, - "SevereLossIndexCount": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of Loss Events that occurred at a distance shorter than SevereLossMinDistance from the previous Loss Event for this AV stream during the sample interval. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "unsignedInt" - } - }, - "SevereLossIndexCountBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of Loss Events that occurred at a distance shorter than SevereLossMinDistance from the previous Loss Event for this AV stream during the sample interval. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "unsignedInt" - } - }, - "AverageLossDistance": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the average distance in <> between consecutive Loss Events for this AV stream during the sample interval. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "unsignedInt", - "unit": "RTP packets" - } - }, - "AverageLossDistanceBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the average distance in <> between consecutive loss events for this AV stream during the sample interval. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "unsignedInt", - "unit": "RTP packets" - } - }, - "MinimumLossDistance": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the length in <> of the shortest distance between consecutive Loss Events for this AV stream during the sample interval. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "unsignedInt", - "unit": "RTP packets" - } - }, - "MinimumLossDistanceBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the length in <> of the shortest distance between consecutive Loss Events for this AV stream during the sample interval. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "unsignedInt", - "unit": "RTP packets" - } - }, - "SevereLossLengthCount": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of Loss Events with length in RTP packets greater than SevereLossMinLength for this AV stream during the sample interval. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "unsignedInt" - } - }, - "SevereLossLengthCountBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of Loss Events with length in RTP packets greater than SevereLossMinLength for this AV stream during the sample interval. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "unsignedInt" - } - }, - "DurationSevereLossEventsHistogram": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by <>. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "string" - } - }, - "DurationSevereLossEventsHistogramBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by <>. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "string" - } - }, - "MaximumLossPeriod": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the length in <> of the longest Loss Event for this AV stream during the sample interval. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "unsignedInt", - "unit": "RTP packets" - } - }, - "MaximumLossPeriodBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the length in <> of the longest Loss Event for this AV stream during the sample interval. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "unsignedInt", - "unit": "RTP packets" - } - }, - "AverageLossPeriod": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the average length in <> of Loss Events for this AV stream during the sample interval. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "unsignedInt", - "unit": "RTP packets" - } - }, - "AverageLossPeriodBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the average length in <> of Loss Events for this AV stream during the sample interval. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "unsignedInt", - "unit": "RTP packets" - } - }, - "MinimumLossPeriod": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the length in <> of the shortest RTP Loss Event for this AV stream during the sample interval. These statistics are collected when no EC is applied or after any EC if available.", - "list": { - "datatype": "unsignedInt", - "unit": "RTP packets" - } - }, - "MinimumLossPeriodBeforeEC": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the length in <> of the shortest RTP Loss Event for this AV stream during the sample interval. These statistics are collected before any EC, if available, is applied.", - "list": { - "datatype": "unsignedInt", - "unit": "RTP packets" - } - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.MPEG2TSStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "MPEG2-TS Sample statistics for this ServiceMonitoring main stream instance.", - "access": false, - "array": false, - "SampleSeconds": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of seconds during which MPEG2-TS data was collected for this AV stream during the sample interval. Individual <> values can be less than the sample interval, for several reasons, including: * Any of the reasons for which the <.Sample.SampleSeconds>> values might be less than the sample interval. * MPEG2-TS data collection is not appropriate or possible for this AV stream.", - "list": { - "datatype": "unsignedInt", - "unit": "seconds" - } - }, - "TSPacketsReceived": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of MPEG2-TS packets received for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "TSPacketsDrained": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of good MPEG2-TS packets removed from the buffer for this AV stream during the sample interval. Packets received minus packets drained provides an indication how close the buffer came to over or under running during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "TSSyncByteErrorCount": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of MPEG2-TS packets with an invalid transport sync byte for this AV stream during the sample interval. Not meaningful when MPEG2-TS is transported over IP.", - "list": { - "datatype": "unsignedInt" - } - }, - "TSSyncLossCount": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of MPEG2-TS Loss of Synchronization Events for this AV stream during the sample interval. Not meaningful when MPEG2-TS is transported over IP.", - "list": { - "datatype": "unsignedInt" - } - }, - "PacketDiscontinuityCounter": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of MPEG2-TS Discontinuity errors that were captured for this AV stream during the sample interval. These statistics are collected when no CA decryption scheme is in use or after any CA decryption if in use.", - "list": { - "datatype": "unsignedInt" - } - }, - "PacketDiscontinuityCounterBeforeCA": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the total number of MPEG2-TS Discontinuity errors that were captured for this AV stream during the sample interval. These statistics are collected before any CA decryption scheme, if used, is applied.", - "list": { - "datatype": "unsignedInt" - } - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.VideoDecoderStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Video decoder Sample statistics for this ServiceMonitoring main stream instance.", - "access": false, - "array": false, - "SampleSeconds": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of seconds during which video decoder data was collected for this AV stream during the sample interval. Individual <> values can be less than the sample interval, for several reasons, including: * Any of the reasons for which the <.Sample.SampleSeconds>> values might be less than the sample interval. * Video Decoder data collection is not appropriate or possible for this AV stream.", - "list": { - "datatype": "unsignedInt", - "unit": "seconds" - } - }, - "FrameRate": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the last frame rate at which the STB played out the video content for this AV stream during the sample interval. . Also the reported rate will be rounded off to the nearest integer.", - "list": { - "datatype": "unsignedInt" - } - }, - "DecodedFrames": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of video frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "LostFrames": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of video frames that could not be reproduced by the STB for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "ConcealedFrames": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of video frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment was applied.", - "list": { - "datatype": "unsignedInt" - } - }, - "IDecodedFrames": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of I frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "ILostFrames": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of I frames that could not be reproduced by the STB for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "IConcealedFrames": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of I frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment applied.", - "list": { - "datatype": "unsignedInt" - } - }, - "PDecodedFrames": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of P frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "PLostFrames": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of P frames that could not be reproduced by the STB for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "PConcealedFrames": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of P frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment applied.", - "list": { - "datatype": "unsignedInt" - } - }, - "BDecodedFrames": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of B frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "BLostFrames": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of B frames that could not be reproduced by the STB for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "BConcealedFrames": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of B frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment applied.", - "list": { - "datatype": "unsignedInt" - } - }, - "AVResynchCounter": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of AV resynchronizations that were performed by the STB for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.AudioDecoderStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Audio decoder Sample statistics for this ServiceMonitoring main stream instance.", - "access": false, - "array": false, - "SampleSeconds": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of seconds during which audio decoder data was collected for this AV stream during the sample interval. Individual <> values can be less than the sample interval, for several reasons, including: * Any of the reasons for which the <.Sample.SampleSeconds>> values might be less than the sample interval. * Audio decoder data collection is not appropriate or possible for this AV stream.", - "list": { - "datatype": "unsignedInt", - "unit": "seconds" - } - }, - "DecodedFrames": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of audio frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - }, - "DecodingErrors": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of audio decoding errors detected by the STB for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt" - } - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.VideoResponseStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Video response Sample statistics for this ServiceMonitoring main stream instance.", - "access": false, - "array": false, - "SampleSeconds": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of seconds during which video response data was collected for this AV stream during the sample interval. Individual <> values can be less than the sample interval, for several reasons, including: * Any of the reasons for which the <.Sample.SampleSeconds>> values might be less than the sample interval. * Video response data collection is not appropriate or possible for this AV stream.", - "list": { - "datatype": "unsignedInt", - "unit": "seconds" - } - }, - "AverageVideoSystemResponse": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the time period (in <>) between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame, computed as the average of the VideoSystemResponse events that occured for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt", - "unit": "milliseconds" - } - }, - "MinimumVideoSystemResponse": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the minimum time period (in <>) between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt", - "unit": "milliseconds" - } - }, - "MaximumVideoSystemResponse": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the maximum time period (in <>) between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame for this AV stream during the sample interval.", - "list": { - "datatype": "unsignedInt", - "unit": "milliseconds" - } - }, - "AverageVoDControlResponse": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the time period, in <>, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream, computed as the average of the VoDControlResponse events that occured for this AV stream during the sample interval. Only measured when started from a non-play state, i.e. either idle or paused.", - "list": { - "datatype": "unsignedInt", - "unit": "milliseconds" - } - }, - "MinimumVoDControlResponse": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the minimum time period, in <>, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused.", - "list": { - "datatype": "unsignedInt", - "unit": "milliseconds" - } - }, - "MaximumVoDControlResponse": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the maximum time period, in <>, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused.", - "list": { - "datatype": "unsignedInt", - "unit": "milliseconds" - } - }, - "VoDControlResponse": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is a colon separated list of time periods in milliseconds between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. A comma separates measurements made in different sample intervals, while a colon separates individual measurements within a specific sample interval. If no VoDControlResponse measurements were made during a specific sample interval then this MUST be represented by an empty string. Example: ,837:453:1234,759,,,923:698,,,1284 Here there were no measurements during first sample interval, three during the second, one during the third, etc. The statistics values in this list MUST be in time order, with the oldest one first and the most recent one last. This applies both to sample intervals and to individual measurements during a specific sample interval. <>", - "list": { - "datatype": "string", - "pattern": [ - "(\\d+(:\\d+)*)?" - ] - } - }, - "VideoSystemResponse": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is a colon separated list of time periods in milliseconds between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame that occurred for this AV stream during the sample interval. A comma separates measurements made in different sample intervals, while a colon separates individual measurements within a specific sample interval. If no VideoSystemResponse measurements were made during a specific sample interval then this MUST be represented by an empty string. Example: ,837:453:1234,759,,,923:698,,,1284 Here there were no measurements during first sample interval, three during the second, one during the third, etc. The statistics values in this list MUST be in time order, with the oldest one first and the most recent one last. This applies both to sample intervals and to individual measurements during a specific sample interval. <>", - "list": { - "datatype": "string", - "pattern": [ - "(\\d+(:\\d+)*)?" - ] - } - }, - "RequestedTransactions": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of RTSP protocol requests to start a VoD program display during the sample interval. Only meaningful for VoD.", - "list": { - "datatype": "unsignedInt" - } - }, - "AccessSuccesses": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of successful VoD attempts during the sample interval. An attempt is considered successful when the first I-frame is displayed by the client. Only meaningful for VoD.", - "list": { - "datatype": "unsignedInt" - } - }, - "CompletionCount": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of completed VoD requests during the sample interval. An attempt is defined successful if it continues until a RTSP protocol request to end the session is sent by the STB. Only meaningful for VoD.", - "list": { - "datatype": "unsignedInt" - } - }, - "ChannelChangeFailures": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of channel change failures. A channel change is considered as failed when the time period between a user channel change request and the display of the first I frame for this AVStream is above <.ChannelChangeFailureTimeout>>.", - "list": { - "datatype": "unsignedInt" - } - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <.Sample.HighLevelMetricStatsNumberOfEntries>>.", - "uniqueKeys": [ - "MetricName", - "Alias" - ], - "access": false, - "array": true, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables this Metric instance.", - "datatype": "boolean" - }, - "Status": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The status of this Metric instance. Enumeration of: Disabled, Enabled, Error. The <> value MAY be used by the CPE to indicate a locally defined error condition.", - "datatype": "string", - "enumerations": [ - "Disabled", - "Enabled", - "Error" - ] - }, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "MetricName": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Indicates a unique identifier for this high-level metric.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "Metric1Threshold": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "This parameter is DEPRECATED and replaced by the <> parameter and, if needed, several instances of <.Sample.HighLevelMetricStats.>>.", - "datatype": "unsignedInt", - "range": [ - { - "min": 0, - "max": 65535 - } - ] - }, - "Metric2Threshold": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "This parameter is DEPRECATED and replaced by the <> parameter and, if needed, several instances of <.Sample.HighLevelMetricStats.>>.", - "datatype": "unsignedInt", - "range": [ - { - "min": 0, - "max": 65535 - } - ] - }, - "SampleSeconds": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the number of seconds during which this high-level metrics data was collected for this AV stream during the sample interval. Individual <> values can be less than the sample interval, for several reasons, including: * Any of the reasons for which the <.Sample.SampleSeconds>> values might be less than the sample interval. * This high-level metrics data collection is not appropriate or possible for this AV stream.", - "list": { - "datatype": "unsignedInt", - "unit": "seconds" - } - }, - "Metric1": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "This parameter is DEPRECATED and replaced by the <> parameter and, if needed, several instances of <.Sample.HighLevelMetricStats.>>.", - "list": { - "datatype": "unsignedInt", - "range": [ - { - "min": 0, - "max": 65535 - } - ] - } - }, - "Metric2": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "This parameter is DEPRECATED and replaced by the <> parameter and, if needed, several instances of <.Sample.HighLevelMetricStats.>>.", - "list": { - "datatype": "unsignedInt", - "range": [ - { - "min": 0, - "max": 65535 - } - ] - } - }, - "Metric1Failures": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "This parameter is DEPRECATED and replaced by the <> parameter and, if needed, several instances of <.Sample.HighLevelMetricStats.>>.", - "datatype": "unsignedInt" - }, - "Metric2Failures": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "This parameter is DEPRECATED and replaced by the <> parameter and, if needed, several instances of <.Sample.HighLevelMetricStats.>>.", - "datatype": "unsignedInt" - }, - "MetricSampleInterval": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "A time period measured in <>. A new value for the high level metric is calculated every <> seconds. The value for <> MUST be less than, or equal to, <>. <> SHOULD be chosen such that <> is an integer multiple of <>. If not, the last metric sample interval in each sample interval MUST be shortened so that the last metric sample interval ends when the sample interval ends. The value for <> is algorithm-specific.", - "datatype": "unsignedInt", - "unit": "seconds" - }, - "MetricThreshold": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The threshold value that controls the calculation of the <> parameter.", - "datatype": "unsignedInt", - "range": [ - { - "min": 0, - "max": 65535 - } - ] - }, - "Metric": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is a high-level metric calculated for this AV stream during the sample interval as the average of the high level metric values calculated on a metric sample interval basis. The length of the metric sample interval is given by <>. The interpretation of the metric values is algorithm-specific; the only constraints are that values have to be numeric, in the range [0:65535] and that lower values indicate worse QoE than do higher values.", - "list": { - "datatype": "unsignedInt", - "range": [ - { - "min": 0, - "max": 65535 - } - ] - } - }, - "MetricFailures": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Counts the number of times (since the last time this MainStream and Sample statistics collection were both enabled) that a newly-calculated value of high-level metric <> was less than or equal to <>. This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval.", - "datatype": "unsignedInt" - } - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.EventLog.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> 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.", - "access": false, - "array": false, - "Reset": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "When set to true, clears the events from the event log and the value of <.SequenceNumber>> parameter is reset to the parameters minimum value.", - "datatype": "boolean" - }, - "EntryNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<>", - "datatype": "unsignedInt" - }, - "Reset()": { - "type": "command", - "async": false, - "protocols": [ - "usp" - ] - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.EventLog.Entry.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "This object represents an entry (e.g., start session, channel change) in the event log.", - "uniqueKeys": [ - "SequenceNumber" - ], - "access": false, - "array": true, - "SequenceNumber": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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.", - "datatype": "unsignedInt", - "range": [ - { - "min": 1 - } - ] - }, - "Type": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Type of the event. The values for this parameter are vendor specific.", - "datatype": "string" - }, - "Time": { - "type": "dateTime", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Timestamp of the event.", - "datatype": "dateTime" - }, - "ParameterNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<>", - "datatype": "unsignedInt" - }, - "Device.Services.STBService.{i}.ServiceMonitoring.MainStream.{i}.EventLog.Entry.{i}.Parameter.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "This object represents an instance of a parameter that is associated with the Entry object Instance.", - "access": false, - "array": true, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Name of the parameter (vendor-specific).", - "datatype": "string" - }, - "Value": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Value of the parameter.", - "datatype": "string" - } - } - } - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.GlobalOperation.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Global operations statistics.", - "access": false, - "array": false, - "Device.Services.STBService.{i}.ServiceMonitoring.GlobalOperation.Total.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Global operations total statistics.", - "access": false, - "array": false, - "ServiceAccessTime": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The time period in, <>, between the first message (e.g. DHCP Discover) sent by the STB during boot-up and the first multicast I-frame for the default channel displayed by the STB.", - "datatype": "unsignedInt", - "unit": "milliseconds" - }, - "MinimumPortalResponse": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Minimum portal latency defined as the minimum time period, in <>, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information.", - "datatype": "unsignedInt", - "unit": "milliseconds" - }, - "MaximumPortalResponse": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Maximum portal latency defined as the maximum time period, in <>, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information.", - "datatype": "unsignedInt", - "unit": "milliseconds" - } - }, - "Device.Services.STBService.{i}.ServiceMonitoring.GlobalOperation.Sample.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Global operations sample statistics.", - "access": false, - "array": false, - "MinimumPortalResponse": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the minimum portal latency defined as the minimum time period, in <>, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information during the sample interval.", - "list": { - "datatype": "unsignedInt", - "unit": "milliseconds" - } - }, - "MaximumPortalResponse": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is the maximum portal latency defined as the maximum time period, in <>, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information during the sample interval.", - "list": { - "datatype": "unsignedInt", - "unit": "milliseconds" - } - }, - "PortalResponse": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Each entry is a colon separated list of time periods (in milliseconds) between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information. A comma separates measurements made in different sample intervals, while a colon separates individual measurements within a specific sample interval. If no PortalResponse measurements were made during a specific sample interval then this MUST be represented by an empty string. Example: ,837:453:1234,759,,,923:698,,,1284 Here there were no measurements during first sample interval, three during the second, one during the third, etc. The statistics values in this list MUST be in time order, with the oldest one first and the most recent one last. This applies both to sample intervals and to individual measurements during a specific sample interval. <>", - "list": { - "datatype": "string", - "pattern": [ - "(\\d+(:\\d+)*)?" - ] - } - } - } - } - }, - "Device.Services.STBService.{i}.Applications.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Applications.", - "access": false, - "array": false, - "ServiceProviderNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of Service Provider instances.", - "datatype": "unsignedInt" - }, - "Device.Services.STBService.{i}.Applications.AudienceStats.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Audience viewing statistics.", - "access": false, - "array": false, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Enables or disables collection of viewing statistics. Enabling collection of viewing statistics also resets the viewing statistics table.", - "datatype": "boolean" - }, - "Reset": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "When set to <> resets the viewing statistics table. Setting it to <> has no effect. The value is not saved in device state and is always <> when read. Resetting statistics MUST reset all <.Duration>> parameters.", - "datatype": "boolean" - }, - "ResetTime": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of <> since the Audience statistics were last enabled or reset.", - "datatype": "unsignedInt", - "unit": "seconds" - }, - "ChannelNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Number of instances of <>.", - "datatype": "unsignedInt" - }, - "Reset()": { - "type": "command", - "async": false, - "protocols": [ - "usp" - ] - }, - "Device.Services.STBService.{i}.Applications.AudienceStats.Channel.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Table to record what the STB has been receiving. Time durations are recorded only for an AVPlayers 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).", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "String describing the TV channel being displayed in the main screen. MUST be the value of the corresponding <.Name>> parameter.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "Duration": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The cumulative duration of this channel in <>.", - "datatype": "unsignedInt", - "unit": "seconds" - } - } - }, - "Device.Services.STBService.{i}.Applications.CDSPush.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Details of STB CDS Push logical internal parameters.", - "access": false, - "array": false, - "Reference": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "It references the object instance dedicated to the CDS Push service. Example: \u201cDevice.Services.StorageService.1.LogicalVolume.1.Folder.1\u201d.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "ContentItemNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<>", - "datatype": "unsignedInt" - }, - "Device.Services.STBService.{i}.Applications.CDSPush.ContentItem.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Content Item instance table.", - "uniqueKeys": [ - "ContentReferenceId", - "Alias" - ], - "access": false, - "array": true, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "ContentReferenceId": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Unique Content Item reference as defined in <>, or <>.", - "datatype": "string" - }, - "VersionNumber": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Version number of the stored content item (a content item could be updated with a new version e.g. in case of errors in the video preventing the play out).", - "datatype": "unsignedInt", - "range": [ - { - "min": 0, - "max": 255 - } - ], - "unit": "%" - }, - "DeleteItem": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "When set to <>, deletes this Content Item instance. The value is not saved in device state and is always <> when read.", - "datatype": "boolean" - }, - "DeleteItem()": { - "type": "command", - "async": false, - "protocols": [ - "usp" - ] - } - } - }, - "Device.Services.STBService.{i}.Applications.CDSPull.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "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.", - "access": false, - "array": false, - "Reference": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "It references the object instance dedicated to the CDS Pull service. Example: \u201cDevice.Services.StorageService.1.LogicalVolume.1.Folder.1\u201d.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "ContentItemNumberOfEntries": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<>", - "datatype": "unsignedInt" - }, - "Device.Services.STBService.{i}.Applications.CDSPull.ContentItem.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Content Item instance table.", - "uniqueKeys": [ - "ContentReferenceId", - "Alias" - ], - "access": false, - "array": true, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "ContentReferenceId": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Unique Content Item reference as defined in <>, or <>.", - "datatype": "string" - }, - "VersionNumber": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Version number of the stored content item (a content item could be updated with a new version e.g. in case of errors in the video preventing the play out).", - "datatype": "unsignedInt", - "range": [ - { - "min": 0, - "max": 255 - } - ], - "unit": "%" - }, - "DeleteItem": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "When set to <>, deletes this Content Item instance. The value is not saved in device state and is always <> when read.", - "datatype": "boolean" - }, - "DeleteItem()": { - "type": "command", - "async": false, - "protocols": [ - "usp" - ] - } - } - }, - "Device.Services.STBService.{i}.Applications.ServiceProvider.{i}.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "Service Provider instance table.", - "uniqueKeys": [ - "Name", - "Alias" - ], - "access": false, - "array": true, - "Alias": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "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 <> and described in <>, 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. | 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 <> and described in <>, 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.", - "datatype": "Alias", - "range": [ - { - "max": 64 - } - ] - }, - "Name": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Service Provider name.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "Domain": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Service Provider domain URI.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "ServiceDiscoveryServer": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Service Provider\u2019s Service Discovery Server. It MAY be configured in the format of IMS Public Service Identifier, or IP address or URL.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "ActiveBCGServers": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Comma separated list of the BCG (Broadband Content Guide) server URLs the STB is currently retrieving IPTV service information from.", - "datatype": "string", - "range": [ - { - "max": 1024 - } - ] - } - } - } } }, "Device.DeviceInfo.": { @@ -88627,6 +80165,158 @@ } } }, + "Device.IP.Diagnostics.UDPEchoConfig.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object allows the CPE to be configured to perform the UDP Echo Service defined in <> and UDP Echo Plus Service defined in <>.", + "access": false, + "array": false, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "MUST be enabled to receive UDP echo. When enabled from a disabled state all related timestamps, statistics and UDP Echo Plus counters are cleared.", + "datatype": "boolean" + }, + "Interface": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> The value of this parameter MUST be either a valid interface or <>. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value. If <> is specified, the CPE MUST listen and receive UDP echo requests on all interfaces. Note: Interfaces behind a NAT MAY require port forwarding rules configured in the Gateway to enable receiving the UDP packets.", + "datatype": "string", + "range": [ + { + "max": 256 + } + ] + }, + "SourceIPAddress": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The Source IP address of the UDP echo packet. The CPE MUST only respond to a UDP echo from this source IP address.", + "datatype": "IPAddress", + "range": [ + { + "max": 45 + } + ] + }, + "UDPPort": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The UDP port on which the UDP server MUST listen and respond to UDP echo requests.", + "datatype": "unsignedInt" + }, + "EchoPlusEnabled": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "If <> the CPE will perform necessary packet processing for UDP Echo Plus packets.", + "datatype": "boolean" + }, + "EchoPlusSupported": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> if UDP Echo Plus is supported.", + "datatype": "boolean" + }, + "PacketsReceived": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Incremented upon each valid UDP echo packet received.", + "datatype": "unsignedInt" + }, + "PacketsResponded": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Incremented for each UDP echo response sent.", + "datatype": "unsignedInt" + }, + "BytesReceived": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The number of UDP received bytes including payload and UDP header after the UDPEchoConfig is enabled.", + "datatype": "unsignedInt" + }, + "BytesResponded": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The number of UDP responded bytes, including payload and UDP header sent after the UDPEchoConfig is enabled.", + "datatype": "unsignedInt" + }, + "TimeFirstPacketReceived": { + "type": "dateTime", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456, The time that the server receives the first UDP echo packet after the UDPEchoConfig is enabled.", + "datatype": "dateTime" + }, + "TimeLastPacketReceived": { + "type": "dateTime", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456 The time that the server receives the most recent UDP echo packet.", + "datatype": "dateTime" + } + }, "Device.IP.Diagnostics.UploadDiagnostics.": { "type": "object", "protocols": [ @@ -89162,158 +80852,6 @@ } } }, - "Device.IP.Diagnostics.UDPEchoConfig.": { - "type": "object", - "protocols": [ - "cwmp", - "usp" - ], - "description": "This object allows the CPE to be configured to perform the UDP Echo Service defined in <> and UDP Echo Plus Service defined in <>.", - "access": false, - "array": false, - "Enable": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "MUST be enabled to receive UDP echo. When enabled from a disabled state all related timestamps, statistics and UDP Echo Plus counters are cleared.", - "datatype": "boolean" - }, - "Interface": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> The value of this parameter MUST be either a valid interface or <>. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value. If <> is specified, the CPE MUST listen and receive UDP echo requests on all interfaces. Note: Interfaces behind a NAT MAY require port forwarding rules configured in the Gateway to enable receiving the UDP packets.", - "datatype": "string", - "range": [ - { - "max": 256 - } - ] - }, - "SourceIPAddress": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The Source IP address of the UDP echo packet. The CPE MUST only respond to a UDP echo from this source IP address.", - "datatype": "IPAddress", - "range": [ - { - "max": 45 - } - ] - }, - "UDPPort": { - "type": "unsignedInt", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The UDP port on which the UDP server MUST listen and respond to UDP echo requests.", - "datatype": "unsignedInt" - }, - "EchoPlusEnabled": { - "type": "boolean", - "read": true, - "write": true, - "protocols": [ - "cwmp", - "usp" - ], - "description": "If <> the CPE will perform necessary packet processing for UDP Echo Plus packets.", - "datatype": "boolean" - }, - "EchoPlusSupported": { - "type": "boolean", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "<> if UDP Echo Plus is supported.", - "datatype": "boolean" - }, - "PacketsReceived": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Incremented upon each valid UDP echo packet received.", - "datatype": "unsignedInt" - }, - "PacketsResponded": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Incremented for each UDP echo response sent.", - "datatype": "unsignedInt" - }, - "BytesReceived": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of UDP received bytes including payload and UDP header after the UDPEchoConfig is enabled.", - "datatype": "unsignedInt" - }, - "BytesResponded": { - "type": "unsignedInt", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "The number of UDP responded bytes, including payload and UDP header sent after the UDPEchoConfig is enabled.", - "datatype": "unsignedInt" - }, - "TimeFirstPacketReceived": { - "type": "dateTime", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456, The time that the server receives the first UDP echo packet after the UDPEchoConfig is enabled.", - "datatype": "dateTime" - }, - "TimeLastPacketReceived": { - "type": "dateTime", - "read": true, - "write": false, - "protocols": [ - "cwmp", - "usp" - ], - "description": "Time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456 The time that the server receives the most recent UDP echo packet.", - "datatype": "dateTime" - } - }, "Device.IP.Diagnostics.UDPEchoDiagnostics.": { "type": "object", "protocols": [ @@ -114080,47 +105618,6 @@ } } }, - "Device.SelfTestDiagnostics.": { - "type": "object", - "protocols": [ - "cwmp" - ], - "description": "This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware.", - "access": false, - "array": false, - "DiagnosticsState": { - "type": "string", - "read": true, - "write": true, - "protocols": [ - "cwmp" - ], - "description": "Indicates the availability of diagnostics data. Enumeration of: Enumeration of: None, Requested, Canceled, Complete, Error. If the ACS sets the value of this parameter to <>, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are <> and <>. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to <>. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. When the test is completed, the value of this parameter MUST be either <> (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than <>, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to <>. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to <>. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to <>. While the test is in progress, setting this parameter to <> (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. While the test is in progress, setting this parameter to <> MUST result in the test being canceled and the value of this parameter being set to <>. If the CPE does not support the <> value, it MUST return a SPV error with Invalid Parameter value (9007) to the ACS instead. | Indicates the availability of diagnostics data. Enumeration of: Enumeration of: None, Requested, Canceled, Complete, Error. If the ACS sets the value of this parameter to <>, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are <> and <>. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to <>. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. When the test is completed, the value of this parameter MUST be either <> (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than <>, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to <>. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to <>. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to <>. While the test is in progress, setting this parameter to <> (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. While the test is in progress, setting this parameter to <> MUST result in the test being canceled and the value of this parameter being set to <>. If the CPE does not support the <> value, it MUST return a SPV error with Invalid Parameter value (9007) to the ACS instead.", - "datatype": "DiagnosticsState", - "enumerations": [ - "None", - "Requested", - "Canceled", - "Complete", - "Error" - ] - }, - "Results": { - "type": "string", - "read": true, - "write": false, - "protocols": [ - "cwmp" - ], - "description": "Results of self-test (vendor specific).", - "datatype": "string", - "range": [ - { - "max": 1024 - } - ] - } - }, "Device.Firewall.": { "type": "object", "protocols": [ @@ -139573,6 +131070,47 @@ } } }, + "Device.SelfTestDiagnostics.": { + "type": "object", + "protocols": [ + "cwmp" + ], + "description": "This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware.", + "access": false, + "array": false, + "DiagnosticsState": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp" + ], + "description": "Indicates the availability of diagnostics data. Enumeration of: Enumeration of: None, Requested, Canceled, Complete, Error. If the ACS sets the value of this parameter to <>, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are <> and <>. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to <>. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. When the test is completed, the value of this parameter MUST be either <> (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than <>, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to <>. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to <>. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to <>. While the test is in progress, setting this parameter to <> (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. While the test is in progress, setting this parameter to <> MUST result in the test being canceled and the value of this parameter being set to <>. If the CPE does not support the <> value, it MUST return a SPV error with Invalid Parameter value (9007) to the ACS instead. | Indicates the availability of diagnostics data. Enumeration of: Enumeration of: None, Requested, Canceled, Complete, Error. If the ACS sets the value of this parameter to <>, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are <> and <>. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to <>. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. When the test is completed, the value of this parameter MUST be either <> (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than <>, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to <>. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to <>. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to <>. While the test is in progress, setting this parameter to <> (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. While the test is in progress, setting this parameter to <> MUST result in the test being canceled and the value of this parameter being set to <>. If the CPE does not support the <> value, it MUST return a SPV error with Invalid Parameter value (9007) to the ACS instead.", + "datatype": "DiagnosticsState", + "enumerations": [ + "None", + "Requested", + "Canceled", + "Complete", + "Error" + ] + }, + "Results": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp" + ], + "description": "Results of self-test (vendor specific).", + "datatype": "string", + "range": [ + { + "max": 1024 + } + ] + } + }, "Device.USPAgent.": { "type": "object", "protocols": [ @@ -140972,7 +132510,7 @@ "protocols": [ "cwmp" ], - "description": "The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission (`r` for Read, `w` for Write, `x` for Execute, and `n` for Notify). The string is always in the same order (`rwxn`) and the lack of a permission is signified by a `-` character (e.g., `r--n`). The following describes the meaning of the permissions for Object type of Targets: # Read: Grants the capability to read the meta-information of the Object via GetSupportedDM. # Write: Grants no capabilities for Static Objects. Grants the capability to create a new instance of a Multi-Instanced Object via Add (e.g. Device.LocalAgent.Controller.). # Execute: Grants no capabilities; Objects are not executable and Commands are controlled by the CommandEventPermissions. # Notify: Grants the capability to receive Notify Messages of type ObjectCreation for this Object (multi-instance objects only).", + "description": "The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission (`r` for Read, `w` for Write, `x` for Execute, and `n` for Notify). The string is always in the same order (`rwxn`) and the lack of a permission is signified by a `-` character (e.g., `r--n`). The following describes the meaning of the permissions for Object type of Targets: # Read: Grants the capability for Get to resolve Object paths. Grants the capability to read the meta-information of the Object via GetSupportedDM. # Write: Grants no capabilities for Static Objects. Grants the capability to create a new instance of a Multi-Instanced Object via Add (e.g. Device.LocalAgent.Controller.). # Execute: Grants no capabilities; Objects are not executable and Commands are controlled by the CommandEventPermissions. # Notify: Grants the capability to receive Notify Messages of type ObjectCreation for this Object (multi-instance objects only).", "default": "----", "datatype": "string", "range": [ @@ -145215,7 +136753,7 @@ "protocols": [ "usp" ], - "description": "The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission (`r` for Read, `w` for Write, `x` for Execute, and `n` for Notify). The string is always in the same order (`rwxn`) and the lack of a permission is signified by a `-` character (e.g., `r--n`). The following describes the meaning of the permissions for Object type of Targets: # Read: Grants the capability to read the meta-information of the Object via GetSupportedDM. # Write: Grants no capabilities for Static Objects. Grants the capability to create a new instance of a Multi-Instanced Object via Add (e.g. Device.LocalAgent.Controller.). # Execute: Grants no capabilities; Objects are not executable and Commands are controlled by the CommandEventPermissions. # Notify: Grants the capability to receive Notify Messages of type ObjectCreation for this Object (multi-instance objects only).", + "description": "The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission (`r` for Read, `w` for Write, `x` for Execute, and `n` for Notify). The string is always in the same order (`rwxn`) and the lack of a permission is signified by a `-` character (e.g., `r--n`). The following describes the meaning of the permissions for Object type of Targets: # Read: Grants the capability for Get to resolve Object paths. Grants the capability to read the meta-information of the Object via GetSupportedDM. # Write: Grants no capabilities for Static Objects. Grants the capability to create a new instance of a Multi-Instanced Object via Add (e.g. Device.LocalAgent.Controller.). # Execute: Grants no capabilities; Objects are not executable and Commands are controlled by the CommandEventPermissions. # Notify: Grants the capability to receive Notify Messages of type ObjectCreation for this Object (multi-instance objects only).", "default": "----", "datatype": "string", "range": [ diff --git a/tools/docker/fixuid.yml b/tools/docker/fixuid.yml new file mode 100644 index 00000000..5ab3c36e --- /dev/null +++ b/tools/docker/fixuid.yml @@ -0,0 +1,4 @@ +user: dev +group: dev +paths: + - /home/dev diff --git a/tools/docker/gitconfig b/tools/docker/gitconfig new file mode 100644 index 00000000..0fb5d99b --- /dev/null +++ b/tools/docker/gitconfig @@ -0,0 +1,4 @@ +[advice] + detachedHead = false +[credential] + helper = store diff --git a/tools/generate_dm.sh b/tools/generate_dm.sh index 29ac4bd0..100f6bf2 100755 --- a/tools/generate_dm.sh +++ b/tools/generate_dm.sh @@ -2,7 +2,7 @@ # Set variables CONTAINER_NAME="generate_dm_tools" -IMAGE_NAME="dev.iopsys.eu:5050/bbf/bbfdm/tools:latest" +IMAGE_NAME="dev.iopsys.eu:5050/bbf/bbfdm/tools:2.0" INPUT="" root="${PWD/tools}" @@ -23,9 +23,9 @@ usages() runner() { # Create and start the Docker container - docker run --rm -it -v"${root}:/bbfdm" -w "/bbfdm" \ + docker run --rm -it -v ~/.ssh:/home/dev/.ssh -v"${root}:/builds/bbf/bbfdm" \ --entrypoint=/bin/bash --name "$CONTAINER_NAME" "$IMAGE_NAME" \ - -c "./gitlab-ci/generate_supported_dm.sh /bbfdm/${1}" + -c "./gitlab-ci/generate_supported_dm.sh ${1}" } while getopts n:I:i:h opts diff --git a/tools/tools_input.json b/tools/tools_input.json index a169e3a5..0d22dce8 100644 --- a/tools/tools_input.json +++ b/tools/tools_input.json @@ -443,6 +443,18 @@ "-I libdm/common" ] }, + { + "repo": "https://dev.iopsys.eu/voice/tr104.git", + "proto": "git", + "version": "devel", + "dm_files": [ + "libdm/extensions/iowrt/*.c" + ], + "extra_dependencies": [ + "-I /builds/bbf/bbfdm/libbbfdm-api/legacy", + "-I libdm/common" + ] + }, { "repo": "https://dev.iopsys.eu/system/logmngr.git", "proto": "git", @@ -470,18 +482,6 @@ "bbf_plugin/common.c" ] }, - { - "repo": "https://dev.iopsys.eu/voice/tr104.git", - "proto": "git", - "version": "devel", - "dm_files": [ - "libdm/extensions/iowrt/*.c" - ], - "extra_dependencies": [ - "-I /builds/bbf/bbfdm/libbbfdm-api/legacy", - "-I libdm/common" - ] - }, { "repo": "https://dev.iopsys.eu/feed/gnx.git", "proto": "git",