Broadband Forum User Services Platform (USP) Data Models
2024-09-04: TR-181 Issue 2 Amendment 18 Corrigendum 1
Introduction
The Broadband Forum defines several data models for use with the User Services Platform (USP). These data models contain objects, parameters, commands, and events that describe the many different service elements that can be exposed via USP Agents.
USP data models are divided into two types: Root and Service. The root data model, Device, is used to describe the major functions of network aware devices, including interfaces, software/firmware, diagnostics, components common to USP and other services, and the basic Agent information necessary to the operation of USP.
Service data models describe modular functionality that allow the extension of the root data model on a device (under Device.Services.) to provide particular services, such as a voice service, set top box service, network attached storage, smart home objects, etc.
Each data model is defined by a Name:Version syntax. The objects, parameters, commands, and events that a particular Agent supports from its implementation of the data model define what is reported to Controllers via the GetSupportedDM message.
How do I use these?
Use the USP data model files to define and implement what exists in your solution’s Supported Data Model. This will help Controllers learn what your solution is capable of. The data models will also describe how your solution’s Instantiated Data Model will behave during operation.
View the HTML files on this page for a human-readable look at the data model documentation.
Use the XML files in this repository when generating code and performing data validation.
These data models are based on the Broadband Forum’s data models for the CPE WAN Management Protocol, also known as “TR-069”, with a robust development history.
The source files used to build the complete USP data model can be found on GitHub.
A ZIP file containing all the latest data models can be downloaded from here.
Current Data Models
Data Model | Version | XML | HTML | Description | Date | Specification |
---|---|---|---|---|---|---|
Device:2 |
2.18 |
|
September 2024 |
|||
Diff | ||||||
tr-181-2-18-0-usp-full.xml | Full |
|
July 2024 | |||
Diff | ||||||
FAPService:2 |
2.1 |
|
July 2022 |
|||
Diff | ||||||
tr-196-2-1-1-usp-full.xml | Full |
|
September 2019 | |||
Diff | ||||||
StorageService:1 |
1.3 |
|
September 2019 |
|||
Diff | ||||||
STBService:1 |
1.4 |
|
September 2019 |
|||
Diff | ||||||
VoiceService:2 |
2.0 |
|
January 2020 |
|||
tr-104-2-0-1-usp-full.xml | Full |
|
September 2019 |
Root Data Models
Data Model | Version | XML | HTML | Description | Date | Specification |
---|---|---|---|---|---|---|
Device:2 |
2.18 |
|
September 2024 |
|||
Diff | ||||||
tr-181-2-18-0-usp-full.xml | Full |
|
July 2024 | TR-181 Issue 2 Amendment 18 | ||
Diff | ||||||
2.17 | tr-181-2-17-0-usp-full.xml | Full |
|
January 2024 | TR-181 Issue 2 Amendment 17 | |
Diff | ||||||
2.16 | tr-181-2-16-0-usp-full.xml | Full |
|
June 2023 | TR-181 Issue 2 Amendment 16 | |
Diff | ||||||
2.15 | tr-181-2-15-1-usp-full.xml | Full |
|
April 2022 | TR-181 Issue 2 Amendment 15 | |
Diff | ||||||
tr-181-2-15-0-usp-full.xml | Full |
|
January 2022 | |||
Diff | ||||||
2.14 | tr-181-2-14-1-usp-full.xml | Full |
|
November 2020 | TR-181 Issue 2 Amendment 14 | |
Diff | ||||||
tr-181-2-14-0-usp-full.xml | Full |
|
||||
Diff | ||||||
2.13 | tr-181-2-13-0-usp-full.xml | Full |
|
September 2019 | TR-181 Issue 2 Amendment 13 | |
Diff | ||||||
2.12 | tr-181-2-12-0-usp-full.xml | Full |
|
March 2018 | TR-181 Issue 2 Amendment 12 | |
Diff |
Service Data Models
Data Model | Version | XML | HTML | Description | Date | Specification |
---|---|---|---|---|---|---|
FAPService:2 |
2.1 |
|
July 2022 |
|||
Diff | ||||||
tr-196-2-1-1-usp-full.xml | Full |
|
September 2019 | |||
Diff | ||||||
StorageService:1 |
1.3 |
|
September 2019 |
|||
Diff | ||||||
STBService:1 |
1.4 |
|
September 2019 |
|||
Diff | ||||||
VoiceService:2 |
2.0 |
|
January 2020 |
|||
tr-104-2-0-1-usp-full.xml | Full |
|
September 2019 |
Schema Files
Document | Filename | Description | Date | Specification |
---|---|---|---|---|
USP Protocol Buffers Schemas |
USP v1.4 Record Schema |
July 2024 |
||
usp-msg-1-4.proto | USP v1.4 Message Schema
|
|||
usp-record-1-3.proto | USP v1.3 Record Schema
|
June 2023 | Release 1.3 | |
usp-msg-1-3.proto | USP v1.3 Message Schema
|
|||
usp-record-1-2.proto | USP v1.2 Record Schema
|
January 2022 | Release 1.2 | |
usp-msg-1-2.proto | USP v1.2 Message Schema
|
|||
usp-record-1-1.proto | USP v1.1 Record Schema (no changes from v1.0) | October 2019 | Release 1.1 | |
usp-msg-1-1.proto | USP v1.1 Message Schema (no changes from v1.0) | |||
usp-record-1-0.proto | USP v1.0 Record Schema | April 2018 | Release 1.0 | |
usp-msg-1-0.proto | USP v1.0 Message Schema | |||
Device Type Schema (DT Schema) |
|
July 2024 |
||
cwmp-devicetype-1-10.xsd |
|
June 2023 | TR-106 Amendment 12 | |
cwmp-devicetype-1-6.xsd |
|
January 2022 | TR-106 Amendment 11 | |
cwmp-devicetype-1-5.xsd |
|
November 2020 | TR-106 Amendment 10 | |
cwmp-devicetype-1-4.xsd |
|
September 2019 | TR-106 Amendment 9 | |
Data Model Report Schema (DMR Schema) |
|
July 2024 |
||
|
June 2023 | TR-106 Amendment 12 | ||
|
January 2022 | TR-106 Amendment 11 | ||
DM Data Model Definition Schema (DM Schema) |
|
July 2024 |
||
cwmp-datamodel-1-10.xsd |
|
June 2023 | TR-106 Amendment 12 | |
cwmp-datamodel-1-9.xsd |
|
January 2022 | TR-106 Amendment 11 | |
cwmp-datamodel-1-8.xsd |
|
November 2020 | TR-106 Amendment 10 | |
cwmp-datamodel-1-7.xsd |
|
September 2019 | TR-106 Amendment 9 | |
cwmp-datamodel-1-6.xsd |
|
May 2018 | TR-106 Amendment 8 | |
XML Catalog |
catalog.xml |
|
May 2018 | TR-106 Amendment 8 |
Support Files
Document | XML | HTML | Description | Date |
---|---|---|---|---|
Data Model Data Types |
|
July 2024 |
||
|
January 2024 | |||
|
September 2019 | |||
Data Model Bibliographic References |
|
July 2024 |
||
|
January 2024 | |||
|
September 2019 |
Outdated Corrigenda
TBD