Skip to main content
Common Tools

Implementation Detail

Category: Shared Tools

What This Project Implements​

Common Tools are shared helper repositories (scripts, example configurations and build utilities) that support several Reference Tools rather than implementing a specification of their own. You normally arrive here from a specific tool's own setup steps, not by starting here — each entry below names the project it supports; refer to that project's own Implementation Detail page for more context.

All of the tools below live in a single repository, rt-common-shared, grouped by subdirectory.

5G Media Streaming (5GMS): rt-common-shared/5gms​

Includes example configurations and common scripts for the 5GMS (rt-5gms-*) Reference Tools.

In particular, the 5G_APIs-overrides directory contains files that can be used with the open5gs-tools/scripts/generate_openapi script to override or supplement the OpenAPI YAML files from the 5G_APIs repository. OpenAPI is a standard, machine-readable format for describing REST APIs, from which client and server code can be generated.

Multimedia Broadcast Multicast Service (MBMS) and LTE-based 5G Broadcast: rt-common-shared/mbms​

Includes example configurations for the LTE-based 5G Broadcast (rt-mbms-*) Reference Tools.

In particular, it includes information about the ServiceAnnouncement(SA) file, also referred to as bootstrap.multipart in the context of Reference Tools. The Service Announcement file is the entry document a receiver reads first to discover which broadcast services are available and how to acquire them.

Simple Express Server: rt-common-shared/simple-express-server​

Includes a simple HTTP server based on express.js that can be used to statically host files for streaming.

Open5GS Tools: rt-common-shared/open5gs-tools​

Includes scripts related to the OpenAPI generator.

Data Reporting 5G_APIs overrides: rt-common-shared/data-reporting/5G_APIs-overrides​

Includes modified versions of the OpenAPI YAML files from the 5G_APIs repository specific to Data Reporting for use with a Data Collection Application Function.

Avcodec build: rt-common-shared/avcodec-build​

Includes a helper script to build ffmpeg libraries for Android.

note

Refer to the Common Tools repositories on GitHub to use or contribute to these Reference Tools. See How to Contribute for the process.