Skip to content

Commit

Permalink
Big documentation update (#63)
Browse files Browse the repository at this point in the history
* Create MBMS-Service-Announcement-Files.md

* Update quick-start-guide.md

* Rename pages/lte-based-5g-broadcast/MBMS-Service-Announcement-Files.md to pages/lte-based-5g-broadcast/rt-common-share/MBMS-service-announcement-files.md

* Update quick-start-guide.md

* Rename MBMS-service-announcement-files.md to MBMS-service-announcement-files.md

* Update quick-start-guide.md

* Create GPS-time-synchronization.md

* Update GPS-time-synchronization.md

* Update GPS-time-synchronization.md

* Create development-and-testing.md

* Create installation-system-service.md

* Create testing-local-user.md

* Create configuration.md

* Create compatibility.md

* Create features.md

* Create testing-postman.md

* Create testing-m1-v120

* Create testing-m1-v130.md

* Rename testing-m1-v120 to testing-m1-v120.md

* Create testing-m1-v141.md

* Create testing-m3-v110.md

* Create testing-m3-v120-md

* Create testing-m5-v100.md

* Create testing-m5-v120.md

* Create testing-m5-v130.md

* Update repositories.md

* Update features.md

* Create development.md

* Delete pages/5g-media-streaming/features.md

* Update testing-m1-v120.md

* Update testing-m1-v130.md

* Update testing-m1-v141.md

* Update testing-m1-v141.md

* Update testing-m3-v110.md

* Update and rename testing-m3-v120-md to testing-m3-v120.md

* Update testing-m5-v100.md

* Update testing-m5-v120.md

* Update testing-m5-v130.md

* Update repositories.md

* Create testing.md

* Update testing-postman.md

* Update testing-local-user.md

* Update testing-m1-v120.md

* Update testing-m1-v130.md

* Update testing-m1-v141.md

* Update testing-m3-v110.md

* Update testing-m3-v120.md

* Update testing-m5-v100.md

* Update testing-m5-v120.md

* Update testing-m5-v130.md

* Rename compatibility.md to compatibility.md

* Update compatibility.md

* Update compatibility.md

* Update and rename configuration.md to configuration5GMSAF.md

* Update repositories.md

* Update and rename features.md to features.md

* Rename features.md to features5GMSAF.md

* Rename testing-local-user.md to testing-local-user.md

* Update and rename configuration5GMSAF.md to configuration-5GMSAF.md

* Update and rename installation-system-service.md to installation-system-service-5GMSAF.md

* Update and rename testing-local-user.md to installation-local-user-5GMSAF.md

* Update installation-system-service-5GMSAF.md

* Update installation-local-user-5GMSAF.md

* Update installation-system-service-5GMSAF.md

* Update testing.md

* Update and rename testing-postman.md to testing-postman.md

* Update and rename testing-m1-v120.md to testing-m1-v120.md

* Update testing-m1-v120.md

* Update _config.yml

* Create custom.scss

* Update custom.scss

* Update custom.scss

* Update _config.yml

* Update _config.yml

* Update and rename testing-m1-v130.md to testing-m1-v130.md

* Update and rename testing-m1-v141.md to testing-m1-v141.md

* Update and rename testing-m3-v110.md to testing-m3-v110.md

* Update and rename testing-m3-v120.md to testing-m3-v120.md

* Update and rename testing-m5-v100.md to testing-m5-v100.md

* Update and rename testing-m5-v120.md to testing-m5-v120.md

* Update testing-m5-v100.md

* Update and rename testing-m5-v130.md to testing-m5-v130.md

* Update and rename development-and-testing.md to testing-AS.md

* Update testing-postman.md

* Update testing-m1-v120.md

* Update testing-m1-v130.md

* Update testing-m1-v141.md

* Update testing-m3-v110.md

* Update testing-m3-v120.md

* Update testing-m5-v100.md

* Update testing-m5-v120.md

* Update testing-m5-v130.md

* Update custom.scss

* Update _config.yml

* Update custom.scss

* Add files via upload

* Add files via upload

* Update index.md

* Add files via upload

* Update index.md

* Add files via upload

* Update index.md

* Update index.md

* Update specifications.md

* Update specifications.md

* Update specifications.md

* Update specifications.md

* Update specifications.md

* Update specifications.md

* Update specifications.md

* Rename development.md to development-AS.md

* Update development-AS.md

* Update testing-postman.md

* Update testing-m1-v120.md

* Update testing-m1-v130.md

* Update testing-m1-v141.md

* Update testing-m3-v110.md

* Update testing-m3-v120.md

* Update testing-m5-v100.md

* Update testing-m5-v120.md

* Update testing-m5-v130.md

* Update end-to-end.md

* Update and rename pages/xr-media-integration-in-5g/features.md to pages/xr-media-integration-in-5g/repositories/featuresXRplayer.md

* Update xr-player-overview.md

* Update xr-player-overview.md

* Update and rename pages/xr-media-integration-in-5g/xr-player-overview.md to pages/xr-media-integration-in-5g/tutorials/xr-player-overview.md

* Update repositories.md

* Update xr-player-win11-openXR.md

* Update xr-player-overview.md

* Update featuresXRplayer.md

* Update xr-player-win11-openXR.md

* Create README.md

* Update repositories.md

* Update repositories.md

* Update repositories.md

* Update repositories.md
  • Loading branch information
jordijoangimenez authored Apr 30, 2024
1 parent 51d0b0b commit 642b68d
Show file tree
Hide file tree
Showing 38 changed files with 6,179 additions and 115 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Welcome to the 5G-MAG Reference Tools Repositories

This repository is meant as an entry point to all the repositories related to the 5G-MAG Reference Tools. It serves as an umbrella for documentation, practical guidelines and examples of applications that can be built with the software packages and also in combination with other platforms.

All the relevant information is available in: https://5g-mag.github.io/Getting-Started/
3 changes: 1 addition & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,14 @@ callouts:
title: Warning
color: red


# Footer content
# appears at the bottom of every page's main content

# Back to top link
back_to_top: true
back_to_top_text: "Back to top"

footer_content: "Copyright © 5G-MAG"
footer_content: "Copyright © 5G-MAG MEDIA ACTION GROUP"

# Footer last edited timestamp
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
Expand Down
3 changes: 3 additions & 0 deletions _sass/custom/custom.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.side-bar {
width: 30%;
}
Binary file modified assets/images/5g-mag-logo-with-text.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/5g-mag-reference-tools.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ nav_order: 0
has_children: true
---

<img src="{{site.baseurl}}/assets/images/5g-mag-reference-tools.png" alt="5g-mag" style="width:300px">
<img src="{{site.baseurl}}/assets/images/5g-mag-reference-tools.png" alt="5g-mag" style="height:50px">

# Overview

Expand Down
9 changes: 7 additions & 2 deletions pages/5g-media-streaming/repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,17 @@
layout: default
title: Repositories
parent: 5G Downlink Media Streaming
has_children: false
has_children: true
nav_order: 3
---

# ⭐ Related repositories
Please note that 5G Media Streaming makes use of other generic [5G Core Network components](https://jordijoangimenez.github.io/Getting-Started/pages/5g-core-network-components/)
Please note that 5G Media Streaming makes use of other generic [5G Core Network components](https://5g-mag.github.io/Getting-Started/pages/5g-core-network-components/)

## 5GMS Application Provider: [rt-5gms-application-provider](https://github.com/5G-MAG/rt-5gms-application-provider)
* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gms-application-provider#readme)
* [Releases](https://github.com/5G-MAG/rt-5gms-application-provider/releases)
* [Projects](https://github.com/5G-MAG/rt-5gms-application-provider/projects?query=is%3Aopen)

## 5GMSd Application Function: [rt-5gms-application-function](https://github.com/5G-MAG/rt-5gms-application-function)
* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gms-application-function#readme)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,83 +1,144 @@
---
layout: default
title: Features
parent: 5G Downlink Media Streaming
title: Features 5GMS AF
parent: Repositories
grand_parent: 5G Downlink Media Streaming
has_children: false
nav_order: 1
nav_order: 0
---

# List of features under implementation
# 5GMSd Application Function Supported Features

The following describes the features of the Application Function that have been implemented, due to be implemented or not planned
yet.

## Implemented in latest release (v1.2.0)

- Reference point M1 (AP <=> AF)
- Provisioning Sessions (TS 26.512 v17.3.0)
- Content Protocols Discovery (TS 26.512 v17.3.0)
- Server Certificates Provisioning (TS 26.512 v17.3.0)
- Content Hosting Provisioning (TS 26.512 v17.3.0)
- Reference point M3 (AS <=> AF)
- Server Certificates Provisioning
- Content Hosting Provisioning
- Reference point M5 (UE <=> AF)
- Service Access Information (TS 26.512 v17.3.0)

## Being worked on for pending releases

This is a list of features being worked on for upcoming releases (and who is primarily working on that feature):

- Reference point M1 (AP <=> AF)
- Uplift to TS 26.512 V17.4.0 (BBC)
- Policy Templates Provisioning (BBC)
- Uplift to TS 26.512 V17.5.0 (BBC)
- QoE Metrics Reporting Provisioning (Fraunhofer Fokus)
- Reference point M5 (UE <=> AF)
- Network Assistance (BBC)
- Dynamic Policies (BBC)
- QoE Metrics Reporting (Fraunhofer Fokus)
- Consumption Reporting (Qualcomm)
- 5GMBS seamless switching ()

## Unimplemented

The following is a list of possible areas of the project to work on, noting which reference point(s) each is for or where a component
resides:

- Data Collection AF
- Direct Data Collection Client (UE)
- Reference point M1 (AP <=> AF)
- Edge Computing integration
- Content Preparation Template Provisioning
- Consumption Reporting Provisioning
- Event Data Processing Provisioning
- Reference point M3 (AS <=> AF)
- Life-cycle management (heartbeat/registration/deregistration)
- Reference point M5 (UE <=> AF)
- Reference point R4 (AS <=> AF)
- Media Streaming Access Reporting
- Reference point R6 (AP <=> AF)
- Exposure of Dynamic Policy invocation events
- Exposure of Network Assistance invocation events
- Exposure of QoE Metrics Reporting events
- Exposure of Consumption Reporting events
- Exposure of Media Streaming Access Report events

# Supported Features in the Software Releases

## 5GMSd Application Function

The release versions of the 5GMSd Application Function support differing sets of reference points, as described by the different
The release versions of the 5GMSd Application Function support differing sets of interfaces, as described by the different
versions of the 3GPP specifications, and differing levels of feature support for those interfaces. The page attempts to capture
the feature sets and specification versions for each release, starting with the most recent release or upcoming releases.

### Key
## Key

Where a feature of the specifications is supported the entry will be marked with &#x2611; and where it is unimplemented in that
Where a feature of the specifications is supported the entry will be marked with &#x2611;, where it is being worked on and slated for the next release the feature will be marked with &#x270E; and where it is unimplemented in that
version the feature will be marked with &#x2610;.

### Upcoming Release v1.3.0
## Upcoming Release v1.4.0 (development branch)

<table><thead>
<tr><th>Interface reference point</th><th>Specifications & Versions</th><th>Protocols</th><th>Features</th></tr>
</thead>
</tbody>
<tr valign="top"><td>M1 (server)</td><td><ul>
<li>TS 26.501 v17.6.0</li>
<li>TS 26.512 v17.6.0</li>
</ul></td><td><ul>
<li>&#x2611; HTTP/1.1</li>
<li>&#x2610; HTTP/2.0</li>
<li>&#x2611; HTTP/1.1 over SSL/TLS</li>
<li>&#x2610; HTTP/2.0 over SSL/TLS</li>
</ul></td><td><ul>
<li>&#x2611; Content Hosting Provisioning</li>
<li>&#x2611; Content Protocols Discovery</li>
<li>&#x2611; Provisioning Sessions</li>
<li>&#x2611; Server Certificates Provisioning</li>
<li>&#x2611; Consumption Reporting Provisioning</li>
<li>&#x2610; Content Preparation Templates Provisioning</li>
<li>&#x2610; Edge Resources Provisioning</li>
<li>&#x2610; Event Data Processing Provisioning</li>
<li>&#x270E; Metrics Reporting Provisioning</li>
<li>&#x2611; Policy Templates Provisioning</li>
</ul></td></tr>
<tr valign="top"><td>M3 (client)</td><td><ul>
<li>5G-MAG prototype</li>
</ul></td><td><ul>
<li>&#x2611; HTTP/1.1</li>
<li>&#x2611; HTTP/2.0</li>
<li>&#x2611; HTTP/1.1 over SSL/TLS</li>
<li>&#x2611; HTTP/2.0 over SSL/TLS</li>
</ul></td><td><ul>
<li>&#x2611; Content Hosting Provisioning</li>
<li>&#x2611; Server Certificates Provisioning</li>
</ul></td></tr>
<tr valign="top"><td>M5 (server)</td><td><ul>
<li>TS 26.501 v17.6.0</li>
<li>TS 26.512 v17.6.0</li>
</ul></td><td><ul>
<li>&#x2611; HTTP/1.1</li>
<li>&#x2610; HTTP/2.0</li>
<li>&#x2611; HTTP/1.1 over SSL/TLS</li>
<li>&#x2610; HTTP/2.0 over SSL/TLS</li>
</ul></td><td><ul>
<li>&#x2611; Service Access Information</li>
<li>&#x2611; Consumption Reporting</li>
<li>&#x2611; Dynamic Policies<br />
&nbsp; <b>Service Data Flow Description Methods:</b><ul>
<li>&#x2610; 2 Tuple</li>
<li>&#x2611; 5 Tuple</li>
<li>&#x2610; ToS</li>
<li>&#x2610; Flow Label</li>
<li>&#x2610; Domain Name</li>
</ul></li>
<li>&#x270E; Metrics Reporting</li>
<li>&#x2611; Network Assistance<ul>
<li>&#x2610; Throughput Estimation</li>
<li>&#x2611; Delivery Boost</li>
</ul></li>
</ul></td></tr>
<tr valign="top"><td>N5 (Npcf client/server)</td><td><ul>
<li>TS 29.514 v17.8.0</li>
</ul></td><td><ul>
<li>&#x2611; HTTP/2.0</li>
<li>&#x2611; HTTP/2.0 over SSL/TLS</li>
</ul></td><td><ul>
<li>&#x2611; Policy Authorization</li>
<li>&#x2611; Policy Authorization Notifications</li>
</ul></td></tr>
<tr valign="top"><td>N33 (client)</td><td><ul>
<li>TS 29.591 v17.9.0</li>
</ul></td><td><ul>
<li>&#x2610; HTTP/2.0</li>
<li>&#x2610; HTTP/2.0 over SSL/TLS</li>
</ul></td><td><ul>
<li>&#x2610; Event Exposure</li>
</ul></td></tr>
<tr valign="top"><td>R4 (server)</td><td><ul>
<li>TS 26.512 v17.6.0</li>
</ul></td><td><ul>
<li>&#x2610; HTTP/1.1</li>
<li>&#x2610; HTTP/2.0</li>
<li>&#x2610; HTTP/1.1 over SSL/TLS</li>
<li>&#x2610; HTTP/2.0 over SSL/TLS</li>
</ul></td><td><ul>
<li>&#x2610; Media Streaming Access</li>
</ul></td></tr>
<tr valign="top"><td>R5/R6 (client/server)</td><td><ul>
<li>TS 26.512 v17.6.0</li>
<li>TS 29.517 v17.9.0</li>
</ul></td><td><ul>
<li>&#x2610; HTTP/1.1</li>
<li>&#x2610; HTTP/2.0</li>
<li>&#x2610; HTTP/1.1 over SSL/TLS</li>
<li>&#x2610; HTTP/2.0 over SSL/TLS</li>
</ul></td><td><ul>
<li>&#x2610; Media Streaming QoE Event</li>
<li>&#x2610; Media Streaming Consumption Event</li>
<li>&#x2610; Media Streaming Network Assistance Invocation Event</li>
<li>&#x2610; Media Streaming Dynamic Policy Invocation Event</li>
<li>&#x2610; Media Streaming Access Event</li>
<li>&#x2610; Event Subscription</li>
</ul></td></tr>
<tr valign="top"><td>Nbsf (client)</td><td><ul>
<li>TS 29.513 v17.10.0</li>
<li>TS 29.521 v17.8.0</li>
</ul></td><td><ul>
<li>&#x2611; HTTP/2.0</li>
<li>&#x2611; HTTP/2.0 over SSL/TLS</li>
</ul></td><td><ul>
<li>&#x2611; Binding Information Retrieval</li>
</ul></td></tr>
</tbody>
<tfoot>
<!--<tr><td colspan="4"><b>Notes:</b><br />1: Only the Delivery Boost feature of Network Assistance is implemented, the Throughput Estimation feature is still in development.</td></tr> -->
</tfoot>
</table>

## Release v1.3.0

<table><thead>
<tr><th>Interface reference point</th><th>Specifications & Versions</th><th>Protocols</th><th>Features</th></tr>
Expand Down Expand Up @@ -158,7 +219,7 @@ version the feature will be marked with &#x2610;.
</tbody>
</table>

### Release v1.2.0
# Release v1.2.0

<table><thead>
<tr><th>Interface reference point</th><th>Specifications & Versions</th><th>Protocols</th><th>Features</th></tr>
Expand Down Expand Up @@ -239,7 +300,7 @@ version the feature will be marked with &#x2610;.
</tbody>
</table>

### Release v1.1.0
# Release v1.1.0

<table><thead>
<tr><th>Interface reference point</th><th>Specifications & Versions</th><th>Protocols</th><th>Features</th></tr>
Expand Down Expand Up @@ -320,3 +381,69 @@ version the feature will be marked with &#x2610;.
</tbody>
</table>

# Features

The following describes the features of the Application Function that have been implemented, due to be implemented or not planned
yet.

## Implemented in the upcoming release (v1.4.1)

- Everything from v1.4.0 plus...
- Interface at M1 (AP <=> AF)
- Metrics Reporting Provisioning (TS 26.512 v17.7.0 + fixes)
- Python command line tools moved to [rt-5gms-application-provider](https://github.com/5G-MAG/rt-5gms-application-provider) repository
- Interface at M5 (UE <=> AF)
- Metrics Reporting (TS 26.512 v17.7.0 + fixes)

## Implemented in the latest release (v1.4.0)

- Interface at M1 (AP <=> AF)
- Provisioning Sessions (TS 26.512 v17.4.0)
- Content Protocols Discovery (TS 26.512 v17.4.0)
- Server Certificates Provisioning (TS 26.512 v17.4.0)
- Content Hosting Provisioning (TS 26.512 v17.4.0)
- Consumption Reporting Provisioning (TS 26.512 v17.7.0)
- Dynamic Policy Templates Provisioning (TS 26.512 v17.7.0)
- Interface at M3 (AS <=> AF)
- Server Certificates Provisioning
- Content Hosting Provisioning
- Interface at M5 (UE <=> AF)
- Service Access Information (TS 26.512 v17.7.0)
- Consumption Reporting (TS 26.512 v17.7.0)
- Network Assistance (TS 26.512 v17.7.0)
- Delivery Boost only
- Dynamic Policies (TS 26.512 v17.7.0)
- 5 Tuple Service Flow Description method only.
- Uplift of other interfaces to TS 26.512 v17.7.0

## Being worked on for pending releases

This is a list of features being worked on for upcoming releases of the 5GMS Application Function (and who is primarily working on that feature):

- Data Collection AF (BBC)
- Internal AF interface (originating at M5 (UE <=> AF))
- Collection of Metrics Reports
- Collection of Consumption Reports
- Interface at R4 (AS <=> AF)
- Media Streaming Access Reporting
- Interface at R5/R6 (AP <=> NWDAF/AF)
- Metrics Report Events
- Consumption Report Events
- Network Assistance Invocation Events
- Dynamic Policy Invocation Events
- Media Streaming Access Report Events
- 5GMBS seamless switching ()

## Unimplemented

The following is a list of possible areas of the project to work on noting which interfaces each is for or where a component
resides:

- Direct Data Collection Client (UE)
- Interface at M1 (AP <=> AF)
- Edge Computing integration
- Content Preparation Template Provisioning
- Event Data Processing Provisioning
- Interface at M3 (AS <=> AF)
- Lifecycle management (heartbeat/registration/deregistration)
- Hosting activation/deactivation
9 changes: 6 additions & 3 deletions pages/5g-media-streaming/specifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ has_children: false
nav_order: 0
---

# 📑 Specifications and relevant references
* Information about relevant specifications can be found at the [Standards Wiki](https://github.com/5G-MAG/Standards/wiki/5G-Downlink-Media-Streaming-Architecture-(5GMSd):-Relevant-Specifications)
* A list of relevant 3GPP Work Items can be found at [Standards Wiki](https://github.com/5G-MAG/Standards/wiki/5G-Downlink-Media-Streaming-Architecture-(5GMSd):-Relevant-Work-Items)
# 5G Media Streaming
## 📑 Specifications and relevant references
* Information about relevant specifications can be found in this [page](https://5g-mag.github.io/Standards/pages/5g-media-streaming/5g-media-streaming-specifications.html)

## 📑 Relevant Work Items
* A list of relevant 3GPP Work Items can be found in this [page](https://5g-mag.github.io/Standards/pages/5g-media-streaming/5g-media-streaming-workitems.html)
Loading

0 comments on commit 642b68d

Please sign in to comment.