Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 46 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The team upgraded the simulator to achieve full compliance with E2AP v1.01, KPM
This project is a collaborative effort between Orange Innovation Egypt (OIE) and Orange Innovation Poland (OIP), with OIP providing technical contributions and support to the development and enhancement of the platform.


![alt text](fig/ns-o-ran-flexric.png)
![alt text](fig/release2.png)

## 2. RIC-TaaP promo video
![alt text](fig/RIC_TaaP.png)
Expand Down Expand Up @@ -105,12 +105,14 @@ The Figure below describes the contribution of OIE over ns-O-RAN project.

- Implemented from scratch

### 4.2 The implementation of KPM and RC
### 4.2 The implementation of KPM, RC and CCC SM

1. Update the KPM ASN and model to KPM v3.00

2. Update the RC ASN and model to RC v1.03

3. Add CCC service model v06.00

### 4.3 Energy Saving under Cell Utilization (ES) xApp operation


Expand All @@ -134,8 +136,11 @@ The Figure below describes the contribution of OIE over ns-O-RAN project.

3. Cell deep-sleep implementation

4. RF Reconfiguration Scenario to Support the Energy-Saving Use Case.

5. Add CCC servic model and its handler functions.

4. **New run flags:**
6. **New run flags:**

```
--KPM_E2functionID=(double)
Expand All @@ -154,6 +159,7 @@ The Figure below describes the contribution of OIE over ns-O-RAN project.
3. Run/Stop simulation from GUI with selection of simulation parameters
5. Observe cell allocation and UEs positions
6. Energy Saving Dashboard (Observe QoS KPIs,Energy State and Energy Consumpetion before and after ES xApp execuation)
7. RF channel Reconfiguration Dashboard ( Observe UE Dl throughput , network avgPower, indication message conntent, Control message conntent and Power and Energy Consuption)
7. A1 Policy Managment Dashboard (Set and Get for A1 Policies)
9. Grafana platform deployed to observe simulation results

Expand All @@ -165,6 +171,31 @@ This setup leverages a hybrid of open-source tools and Orange’s internal platf



## 5. LENA Module Reporting Parameters

To support custom xApp development on top of this platform, a dedicated reference document is available that maps every reportable KPI to its exact source in the 5G-LENA NR module:

📄 [`docs/LENA_MODEL_REPORTING_PARAMETERS.md`](docs/LENA_MODEL_REPORTING_PARAMETERS.md)

### What this document provides

- A **complete layer-by-layer catalogue** (PHY, MAC, RLC, PDCP, RRC, E2/O-RAN) of all parameters that can be extracted from the 5G-LENA module (`src/nr/`).
- A clear **status for each parameter** — whether it is directly **IMPLEMENTABLE** via a trace source or public API, **DERIVABLE** through post-processing, or **NOT_SUPPORTED** in the current codebase.
- The exact **file, class, function, and TraceSource** needed to access each metric, so you know precisely where to connect your reporting logic.
- Documented **known corrections** between the simulator implementation and the 3GPP KPM naming conventions (e.g. RLC byte counts reported under PDCP KPM names).

### How it helps you build a custom xApp

When developing a custom xApp that requires specific KPIs from the LENA simulation — such as per-UE throughput, SINR, PRB utilization, PDCP delay, or RRC events — this document tells you:

1. **Whether the parameter is available** in the current 5G-LENA codebase.
2. **How to enable reporting** of that parameter (trace connection call, helper method, or derivation formula).
3. **Where the data flows** from the simulator layer through the E2 indication message to your xApp.

This makes the document the starting point for any custom reporting extension, enabling you to identify the required parameters, wire the correct trace sources, and include them in the KPM indication messages sent to FlexRIC.

---

## 6. Installation Instructions

### System Requirements
Expand Down Expand Up @@ -437,7 +468,18 @@ To run kpm-rc xApp with 5G-LENA module
5. Navigate to '/path/to/flexric/build/examples/xApp/c/kpm_rc ' and then run './xapp_kpm_rc'.
6. To enable running xApp triggering from GUI, please copy two scripts from '/path/to/mmwave-LENA-oran/GUI/FlexRIC xApp GUI trigger' to '/path/to/flexric" and then type "python3 xApp_trigger.py"

#### 6.4.6 Observe KPIs with Grafana
#### 6.4.6 RF Channel Reconfiguration xApp operation.
To run RF channel REcnfiguration xApp with 5G-Lena module

1. Switch to flexric [OIE-add-CCC](https://gitlab.eurecom.fr/mosaic5g/flexric.git) branch .
2. run './nearRT-RIC' following step 2 in 6.4.5 .
3. Use The RIC-TaaP Studio, following Section 6.4.3, Points 1,2,3 and 4.
4. Run the ***RF_Reconfiguration.cc*** scenario from RIC-TaaP Studio.
5. Navigate to '/path/to/flexric/build/examples/xApp/c/orange' and then run './rf_reconfiguration_xapp' .
6. you can monitor the RF channel reconfiguration KPIs from observe channel reconfiguration tab .
![ns-O-RAN](fig/10.png)

#### 6.4.7 Observe KPIs with Grafana
1. Grafana is being deployed together with GUI through Docker Compose.<br />
2. It can be accessed by typing 127.0.0.1:3000 or 'NS3_HOST':3000 in the browser. <br />
3. Default user/password: admin/admin
Expand Down
Loading