dapps 0.0.4__tar.gz → 0.0.6__tar.gz

dapps-0.0.6/CONTRIBUTING.md

@@ -0,0 +1,95 @@
+# Contributing
+
+Thank you for considering contributing to this project! Please follow these guidelines to help us maintain a welcoming and productive environment.
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the original authors of this work. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment 
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). 
+   This repository is part of a framework with a counterpart in OpenAirInterface written in C/C++.
+   We do not accept major patches that break or reduce compatibility with the twin repository.
+4. Submitted code must have been tested and should work with all the compatible configurations of the framework.
+5. Merging should always be performed via squash commits. Pull Requests must be updated through rebasing, without duplicating commits or altering the original branch history. Merges without prior approval are not allowed, and any accidental violations will result in the deletion of the merge commit.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

{dapps-0.0.4 → dapps-0.0.6}/PKG-INFO

@@ -1,27 +1,28 @@
 Metadata-Version: 2.4
 Name: dapps
-Version: 0.0.4
+Version: 0.0.6
 Summary: A library for creating and connecting dApps to Open RAN units.
 Project-URL: Homepage, https://openrangym.com/o-ran-frameworks/dapps
 Project-URL: Package, https://pypi.org/project/dapps/
 Project-URL: Source, https://github.com/wineslab/dApp-library
 Project-URL: Bug Tracker, https://github.com/wineslab/dApp-library/issues
 Author-email: Andrea Lacava <thecave003@gmail.com>
+License-Expression: Apache-2.0
 License-File: LICENSE
 Keywords: 5G,O-RAN,cellular,dApps,networks
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Requires-Dist: asn1tools
+Requires-Dist: jsonschema>=4.18.0
 Requires-Dist: numpy
 Requires-Dist: pyzmq
+Requires-Dist: sigmf
 Requires-Dist: typing-extensions
 Provides-Extra: all
 Requires-Dist: flask; extra == 'all'
@@ -62,7 +63,7 @@ Clone the repository and install it manually with:
 
 ```
 hatch build
-pip3 install dist/*.tar.gz
+pip3 install "dist/*.tar.gz[all]"
 ```
 
 ### Launch the Spectrum Sharing dApp example
@@ -74,27 +75,43 @@ python3 examples/spectrum_dapp.py
 ```
 
 This dApp implements a spectrum sharing use case discussed in [our paper](https://doi.org/10.1016/j.comnet.2025.111342) ([here for the archive version](https://arxiv.org/pdf/2501.16502)).
-The dApp parameters can be controlled through the following command-line arguments:
-
-- `--link` (str, default: 'zmq', choices: [layer.value for layer in E3LinkLayer]): Specify the link layer to be used  
-- `--transport` (str, default: 'ipc', choices: [layer.value for layer in E3TransportLayer]): Specify the transport layer to be used  
-- `--save-iqs` (store_true, default: False): Specify if this is data collection run or not. In the first case I/Q samples will be saved  
-- `--control` (store_true, default: False): Set whether to perform control of PRB  
-- `--noise-floor-threshold` (int, default: None): Set the noise floor threshold for determining the presence of incumbents and for detecting the PRBs affected.
-- `--ota` (store_true, default: False): Specify if the setup used is OTA or on Colosseum for determining the noise floor threshold. If the `noise_floor_threshold` parameter is specified, this parameter is ignored
-- `--energy-gui` (store_true, default: False): Set whether to enable the energy GUI  
-- `--iq-plotter-gui` (store_true, default: False): Set whether to enable the IQ Plotter GUI  
-- `--demo-gui` (store_true, default: False): Set whether to enable the Demo GUI  
-- `--num-prbs` (int, default: 106): Number of PRBs  
-- `--num-subcarrier-spacing` (int, default: 30): Subcarrier spacing in kHz (FR1 is 30)  
-- `--e` (store_true, default: False): Set if 3/4 sampling for FFT size is set on the gNB (-E option on OAI)  
-- `--center-freq` (float, default: 3.6192e9): Center frequency in Hz  
-- `--timed` (store_true, default: False): Run with a 5-minute time limit  
-- `--model` (str, default: ''): Path to the CNN model file to be used  
-- `--time-window` (int, default: 5): Number of input vectors to pass to the CNN model  
-- `--moving-avg-window` (int, default: 30): Window size (in samples) for the moving average used to detect energy peaks in the spectrum  
-- `--extraction-window` (int, default: 600): Number of samples to retain after detecting an energy peak
 
+**Command-line arguments:**
+
+**Connection Configuration:**
+- `--link` - Specify the link layer to be used. Options: `zmq`, `posix` (default: `zmq`)
+- `--transport` - Specify the transport layer to be used. Options: `ipc`, `tcp` (default: `ipc`)
+
+**Data Collection and Control:**
+- `--save-iqs` - Enable data collection mode. When set, I/Q samples will be saved to disk for later analysis using SigMF
+- `--control` - Enable PRB control. When set, the dApp will actively control spectrum allocation based on detected interference. If not set, the dApp can still receive and implement control action from an external xApp
+
+**Spectrum Sensing Configuration:**
+- `--noise-floor-threshold` - Set the noise floor threshold (in dB) for determining the presence of incumbents and for detecting the PRBs affected. If not specified, will be auto-detected based on environment
+- `--ota` - Specify if the setup is Over-The-Air (OTA) or on Colosseum testbed for using a precalculated noise floor threshold. If `--noise-floor-threshold` is specified, this parameter is ignored
+
+**Visualization Options:**
+- `--energy-gui` - Enable the energy spectrum visualization GUI
+- `--iq-plotter-gui` - Enable the I/Q constellation plotter GUI
+- `--demo-gui` - Enable the demonstration GUI showing real-time spectrum occupancy
+
+**Radio Configuration:**
+- `--num-prbs` - Number of Physical Resource Blocks in the channel (default: 106)
+- `--num-subcarrier-spacing` - Subcarrier spacing in kHz. Use 30 for FR1 (sub-6 GHz) (default: 30)
+- `--e` - Enable 3/4 FFT sampling mode. Set this flag if the gNB was started with the `-E` option
+- `--center-freq` - Center frequency in Hz (default: 3.6192e9, which is 3.6192 GHz)
+
+**Execution Control:**
+- `--timed SECONDS` - Run the dApp with a time limit (in seconds). Set to 0 for no limit (default: 0)
+
+**AI/ML Model Configuration:**
+- `--model` - Path to a pre-trained CNN model file for spectrum classification. If not provided, uses rule-based detection
+- `--time-window` - Number of consecutive spectrum vectors to use as input for the CNN model (default: 5)
+
+**Signal Processing Parameters:**
+- `--moving-avg-window` - Window size (in samples) for the moving average filter used to smooth energy measurements and detect peaks in the spectrum (default: 30)
+- `--extraction-window` - Number of samples to retain after detecting an energy peak for further analysis (default: 600)
+- `--sampling-threshold` - Down-sampling ratio applied to IQ sensing. An IQ vector will be delivered every Nth sensing (default: 5)
 
 If you use the dApp concept and/or the framework to develop your own dApps, please cite the following paper:
 
@@ -112,3 +129,73 @@ keywords = {Open RAN, dApps, Real-time control loops, Radio Resource Management
 abstract = {Open Radio Access Networks (RANs) leverage disaggregated and programmable RAN functions and open interfaces to enable closed-loop, data-driven radio resource management. This is performed through custom intelligent applications on the RAN Intelligent Controllers (RICs), optimizing RAN policy scheduling, network slicing, user session management, and medium access control, among others. In this context, we have proposed dApps as a key extension of the O-RAN architecture into the real-time and user-plane domains. Deployed directly on RAN nodes, dApps access data otherwise unavailable to RICs due to privacy or timing constraints, enabling the execution of control actions within shorter time intervals. In this paper, we propose for the first time a reference architecture for dApps, defining their life cycle from deployment by the Service Management and Orchestration (SMO) to real-time control loop interactions with the RAN nodes where they are hosted. We introduce a new dApp interface, E3, along with an Application Protocol (AP) that supports structured message exchanges and extensible communication for various service models. By bridging E3 with the existing O-RAN E2 interface, we enable dApps, xApps, and rApps to coexist and coordinate. These applications can then collaborate on complex use cases and employ hierarchical control to resolve shared resource conflicts. Finally, we present and open-source a dApp framework based on OpenAirInterface (OAI). We benchmark its performance in two real-time control use cases, i.e., spectrum sharing and positioning in a 5th generation (5G) Next Generation Node Base (gNB) scenario. Our experimental results show that standardized real-time control loops via dApps are feasible, achieving average control latency below 450microseconds and allowing optimal use of shared spectral resources.}
 }
 ```
+
+## E3 Service Model Generator
+
+The `tools/generate_sm.sh` script helps you create skeleton code for new E3 Service Models. This automates the creation of boilerplate code for both the agent (OAI) and dApp sides.
+
+### Usage
+
+**Interactive mode (recommended for first-time users):**
+```bash
+cd tools
+./generate_sm.sh --interactive
+```
+
+**Command-line mode:**
+```bash
+./generate_sm.sh -n <sm_name> -a <asn_file> [OPTIONS]
+```
+
+**Options:**
+- `-n, --name NAME` - Service Model name (required)
+- `-a, --asn-file FILE` - ASN.1 definition file path (required)
+- `-t, --target TARGET` - Target: `agent`, `dapp`, or `both` (default: both)
+- `-r, --ran-functions IDS` - Comma-separated RAN function IDs (e.g., 2,3,4)
+- `-f, --format FORMAT` - Encoding format: `asn1` or `json` (default: asn1)
+- `--agent-root PATH` - Path to OAI repository (or set `AGENT_ROOT` env var)
+- `-i, --interactive` - Interactive mode with prompts
+- `-h, --help` - Show help message
+
+**Examples:**
+```bash
+# Generate both agent and dApp code for positioning SM
+cd tools
+./generate_sm.sh -n positioning -a positioning.asn -r 2 --agent-root /path/to/spear-openairinterface5g
+
+# Generate only dApp code for KPM SM
+./generate_sm.sh -n kpm -a kpm.asn -r 3,4 -t dapp
+
+# Interactive mode
+./generate_sm.sh --interactive
+```
+
+**Generated Structure:**
+
+For agent-side (when `--target agent` or `both`):
+```
+spear-openairinterface5g/openair2/E3AP/service_models/<sm_name>_sm/
+├── <sm_name>_sm.h          # Main SM header
+├── <sm_name>_sm.c          # Main SM implementation
+├── <sm_name>_enc.h/.c      # Encoding functions
+├── <sm_name>_dec.h/.c      # Decoding functions
+├── CMakeLists.txt          # Build configuration
+└── MESSAGES/
+    ├── CMakeLists.txt
+    └── ASN1/V1/
+        ├── e3sm_<sm_name>.asn
+        └── e3sm_<sm_name>.cmake
+```
+
+For dApp-side (when `--target dapp` or `both`):
+```
+spear-dApp/src/<sm_name>/
+├── __init__.py
+├── <sm_name>_dapp.py       # Main dApp implementation
+└── defs/
+    └── e3sm_<sm_name>.asn  # ASN.1 schema
+```
+
+### Contributing
+
+Contributions are welcome, but they must follow the guidelines in [CONTRIBUTING.md](./CONTRIBUTING.md)

dapps-0.0.6/README.md

@@ -0,0 +1,156 @@
+# dApp Library
+
+A complete tutorial on how to deploy a dApp can be found on the [OpenRAN Gym website](https://openrangym.com/tutorials/dapps-oai). Please refer to that guide to instrument your system.
+
+## Installation
+
+### Python package installation (recommended)
+
+```
+pip3 install dapps[all]
+```
+
+The dApp can be found in the `examples` directory or it can be downloaded from this repository.
+
+### Manual installation (use only for library development)
+
+Clone the repository and install it manually with:
+
+```
+hatch build
+pip3 install "dist/*.tar.gz[all]"
+```
+
+### Launch the Spectrum Sharing dApp example
+
+OAI should start _before_ running the dApp
+
+```python 
+python3 examples/spectrum_dapp.py
+```
+
+This dApp implements a spectrum sharing use case discussed in [our paper](https://doi.org/10.1016/j.comnet.2025.111342) ([here for the archive version](https://arxiv.org/pdf/2501.16502)).
+
+**Command-line arguments:**
+
+**Connection Configuration:**
+- `--link` - Specify the link layer to be used. Options: `zmq`, `posix` (default: `zmq`)
+- `--transport` - Specify the transport layer to be used. Options: `ipc`, `tcp` (default: `ipc`)
+
+**Data Collection and Control:**
+- `--save-iqs` - Enable data collection mode. When set, I/Q samples will be saved to disk for later analysis using SigMF
+- `--control` - Enable PRB control. When set, the dApp will actively control spectrum allocation based on detected interference. If not set, the dApp can still receive and implement control action from an external xApp
+
+**Spectrum Sensing Configuration:**
+- `--noise-floor-threshold` - Set the noise floor threshold (in dB) for determining the presence of incumbents and for detecting the PRBs affected. If not specified, will be auto-detected based on environment
+- `--ota` - Specify if the setup is Over-The-Air (OTA) or on Colosseum testbed for using a precalculated noise floor threshold. If `--noise-floor-threshold` is specified, this parameter is ignored
+
+**Visualization Options:**
+- `--energy-gui` - Enable the energy spectrum visualization GUI
+- `--iq-plotter-gui` - Enable the I/Q constellation plotter GUI
+- `--demo-gui` - Enable the demonstration GUI showing real-time spectrum occupancy
+
+**Radio Configuration:**
+- `--num-prbs` - Number of Physical Resource Blocks in the channel (default: 106)
+- `--num-subcarrier-spacing` - Subcarrier spacing in kHz. Use 30 for FR1 (sub-6 GHz) (default: 30)
+- `--e` - Enable 3/4 FFT sampling mode. Set this flag if the gNB was started with the `-E` option
+- `--center-freq` - Center frequency in Hz (default: 3.6192e9, which is 3.6192 GHz)
+
+**Execution Control:**
+- `--timed SECONDS` - Run the dApp with a time limit (in seconds). Set to 0 for no limit (default: 0)
+
+**AI/ML Model Configuration:**
+- `--model` - Path to a pre-trained CNN model file for spectrum classification. If not provided, uses rule-based detection
+- `--time-window` - Number of consecutive spectrum vectors to use as input for the CNN model (default: 5)
+
+**Signal Processing Parameters:**
+- `--moving-avg-window` - Window size (in samples) for the moving average filter used to smooth energy measurements and detect peaks in the spectrum (default: 30)
+- `--extraction-window` - Number of samples to retain after detecting an energy peak for further analysis (default: 600)
+- `--sampling-threshold` - Down-sampling ratio applied to IQ sensing. An IQ vector will be delivered every Nth sensing (default: 5)
+
+If you use the dApp concept and/or the framework to develop your own dApps, please cite the following paper:
+
+```text
+@article{LACAVA2025111342,
+title = {{dApps: Enabling Real-Time AI-based Open RAN Control}},
+journal = {Computer Networks},
+pages = {111342},
+year = {2025},
+issn = {1389-1286},
+doi = {https://doi.org/10.1016/j.comnet.2025.111342},
+url = {https://www.sciencedirect.com/science/article/pii/S1389128625003093},
+author = {Andrea Lacava and Leonardo Bonati and Niloofar Mohamadi and Rajeev Gangula and Florian Kaltenberger and Pedram Johari and Salvatore D’Oro and Francesca Cuomo and Michele Polese and Tommaso Melodia},
+keywords = {Open RAN, dApps, Real-time control loops, Radio Resource Management (RRM), Spectrum sharing, Positioning, Integrated Sensing and Communication (ISAC)},
+abstract = {Open Radio Access Networks (RANs) leverage disaggregated and programmable RAN functions and open interfaces to enable closed-loop, data-driven radio resource management. This is performed through custom intelligent applications on the RAN Intelligent Controllers (RICs), optimizing RAN policy scheduling, network slicing, user session management, and medium access control, among others. In this context, we have proposed dApps as a key extension of the O-RAN architecture into the real-time and user-plane domains. Deployed directly on RAN nodes, dApps access data otherwise unavailable to RICs due to privacy or timing constraints, enabling the execution of control actions within shorter time intervals. In this paper, we propose for the first time a reference architecture for dApps, defining their life cycle from deployment by the Service Management and Orchestration (SMO) to real-time control loop interactions with the RAN nodes where they are hosted. We introduce a new dApp interface, E3, along with an Application Protocol (AP) that supports structured message exchanges and extensible communication for various service models. By bridging E3 with the existing O-RAN E2 interface, we enable dApps, xApps, and rApps to coexist and coordinate. These applications can then collaborate on complex use cases and employ hierarchical control to resolve shared resource conflicts. Finally, we present and open-source a dApp framework based on OpenAirInterface (OAI). We benchmark its performance in two real-time control use cases, i.e., spectrum sharing and positioning in a 5th generation (5G) Next Generation Node Base (gNB) scenario. Our experimental results show that standardized real-time control loops via dApps are feasible, achieving average control latency below 450microseconds and allowing optimal use of shared spectral resources.}
+}
+```
+
+## E3 Service Model Generator
+
+The `tools/generate_sm.sh` script helps you create skeleton code for new E3 Service Models. This automates the creation of boilerplate code for both the agent (OAI) and dApp sides.
+
+### Usage
+
+**Interactive mode (recommended for first-time users):**
+```bash
+cd tools
+./generate_sm.sh --interactive
+```
+
+**Command-line mode:**
+```bash
+./generate_sm.sh -n <sm_name> -a <asn_file> [OPTIONS]
+```
+
+**Options:**
+- `-n, --name NAME` - Service Model name (required)
+- `-a, --asn-file FILE` - ASN.1 definition file path (required)
+- `-t, --target TARGET` - Target: `agent`, `dapp`, or `both` (default: both)
+- `-r, --ran-functions IDS` - Comma-separated RAN function IDs (e.g., 2,3,4)
+- `-f, --format FORMAT` - Encoding format: `asn1` or `json` (default: asn1)
+- `--agent-root PATH` - Path to OAI repository (or set `AGENT_ROOT` env var)
+- `-i, --interactive` - Interactive mode with prompts
+- `-h, --help` - Show help message
+
+**Examples:**
+```bash
+# Generate both agent and dApp code for positioning SM
+cd tools
+./generate_sm.sh -n positioning -a positioning.asn -r 2 --agent-root /path/to/spear-openairinterface5g
+
+# Generate only dApp code for KPM SM
+./generate_sm.sh -n kpm -a kpm.asn -r 3,4 -t dapp
+
+# Interactive mode
+./generate_sm.sh --interactive
+```
+
+**Generated Structure:**
+
+For agent-side (when `--target agent` or `both`):
+```
+spear-openairinterface5g/openair2/E3AP/service_models/<sm_name>_sm/
+├── <sm_name>_sm.h          # Main SM header
+├── <sm_name>_sm.c          # Main SM implementation
+├── <sm_name>_enc.h/.c      # Encoding functions
+├── <sm_name>_dec.h/.c      # Decoding functions
+├── CMakeLists.txt          # Build configuration
+└── MESSAGES/
+    ├── CMakeLists.txt
+    └── ASN1/V1/
+        ├── e3sm_<sm_name>.asn
+        └── e3sm_<sm_name>.cmake
+```
+
+For dApp-side (when `--target dapp` or `both`):
+```
+spear-dApp/src/<sm_name>/
+├── __init__.py
+├── <sm_name>_dapp.py       # Main dApp implementation
+└── defs/
+    └── e3sm_<sm_name>.asn  # ASN.1 schema
+```
+
+### Contributing
+
+Contributions are welcome, but they must follow the guidelines in [CONTRIBUTING.md](./CONTRIBUTING.md)

dapps-0.0.6/VERSION

@@ -0,0 +1 @@
+0.0.6

dapps-0.0.6/docs/dapp_uml.txt

@@ -0,0 +1,210 @@
+@startuml
+!theme mars
+skinparam defaultFontSize 20
+skinparam classFontSize 22
+skinparam backgroundColor transparent
+left to right direction
+skinparam linetype ortho
+!define AbstractClass class
+hide empty members
+hide circles
+
+class E3Interface {
+    -- Attributes --
+    - _instance : E3Interface
+    - _lock : threading.Lock
+    - callbacks : dict[int, list]
+    - stop_event : multiprocessing.Event
+    - initialized : bool
+    - _message_id_counter : int
+    - _message_id_lock : threading.Lock
+    - e3_connector : E3Connector
+    - encoder : E3Encoder
+    - outbound_queue : multiprocessing.Queue
+    - inbound_process : multiprocessing.Process
+    - outbound_process : multiprocessing.Process
+    -- Methods --
+    __new__()
+    __init__(encoder: E3Encoder, **kwargs)
+    Note: kwargs can include: link (str), transport (str)
+    + send_setup_request(dappId: int) : bool | list
+    + send_subscription_request(ranFunctionId: int, dappId: int, actionType: str) : bool
+    + send_message_ack(requestId: int, responseCode: str)
+    + setup_connections()
+    + add_callback(dapp_id: int, callback)
+    + remove_callback(dapp_id: int, callback=None)
+    + schedule_control(dappId: int, actionData: bytes)
+    + schedule_report(reportData: bytes)
+    + terminate_connections()
+    - _inbound_connection()
+    - _outbound_connection()
+    - _handle_incoming_data(dapp_identifier: int, data)
+    - _get_next_message_id() : int
+}
+
+AbstractClass SpectrumSharingDApp {
+    -- Attributes --
+    - spectrum_encoder : asn1tools.Compiler
+    - _sampling_threshold_control_callback : callable
+    - num_consecutive_subcarriers_for_prb : int
+    - num_prbs : int
+    - num_subcarrier_spacing : int
+    - ofdm_symbol_size : int
+    - bw : float
+    - center_freq : float
+    - fft_size : int
+    - first_carrier_offset : int
+    - prb_thrs : int
+    - average_over_frames : int
+    - noise_floor_threshold : int
+    - save_iqs : bool
+    - sampling_threshold : int
+    - iq_save_file : file
+    - save_counter : int
+    - limit_per_file : int
+    - control : bool
+    - energyGui : bool
+    - iqPlotterGui : bool
+    - dashboard : bool
+    - control_count : int
+    - abs_iq_av : np.ndarray
+    - sig_queue : multiprocessing.Queue (optional, if energyGui=True)
+    - energyPlotter : EnergyPlotter (optional, if energyGui=True)
+    - iq_queue : multiprocessing.Queue (optional, if iqPlotterGui=True)
+    - iqPlotter : IQPlotter (optional, if iqPlotterGui=True)
+    - demo_queue : multiprocessing.Queue (optional, if dashboard=True)
+    - demo : Dashboard (optional, if dashboard=True)
+    -- Methods --
+    __init__(id: int, link: str, transport: str, noise_floor_threshold: int, save_iqs: bool, control: bool, center_freq: float, num_prbs: int, num_subcarrier_spacing: int, e_sampling: bool, encoding_method: str, sampling_threshold: int, **kwargs)
+    Note: kwargs can include: energyGui, iqPlotterGui, dashboard, classifier
+    - _init_spectrum_encoder()
+    + set_sampling_threshold_control_logic(callback)
+    + create_prb_blacklist_control(blacklisted_prbs: bytes, prb_count: int, sampling_period_ms: int, action_definition: str) : bytes
+    + decode_iq_data_indication(data: bytes) : dict
+    + decode_config_control(data: bytes) : dict
+    + get_iqs_from_ran(dapp_identifier: int, data: bytes)
+    # _control_loop()
+    # _stop()
+    - _encode_spectrum_message(message_type: str, data: dict) : bytes
+    - _decode_spectrum_message(message_type: str, data: bytes) : dict
+}
+
+
+AbstractClass DApp {
+    -- Attributes --
+    - dapp_id : int
+    - encoding_method : str
+    - e3_interface : E3Interface
+    - stop_event : multiprocessing.Event
+    -- Methods --
+    __init__(id: int, link: str, transport: str, callbacks: list, encoding_method: str, **kwargs)
+    + setup_connection() : bool, list
+    + send_subscription_request(ranFunctionIds: list)
+    + control_loop()
+    + stop()
+    # _control_loop() : abstract
+    # _stop() : abstract
+}
+
+class E3LinkLayer {
+    -- Enumeration --
+    + ZMQ = "zmq"
+    + POSIX = "posix"
+    -- Methods --
+    + from_string(link_layer_str: str)
+}
+
+class E3TransportLayer {
+    -- Enumeration --
+    + SCTP = "sctp"
+    + TCP = "tcp"
+    + IPC = "ipc"
+    -- Methods --
+    + from_string(transport_layer_str: str)
+}
+
+AbstractClass E3Connector {
+    -- Attributes --
+    - VALID_CONFIGURATIONS : list
+    - E3_IPC_SETUP_PATH : str
+    - E3_IPC_SOCKET_PATH : str
+    - DAPP_IPC_SOCKET_PATH : str
+    -- Methods --
+    + setup_connector(link_layer: str, transport_layer: str)
+    + send_setup_request(payload: bytes)
+    + setup_inbound_connection()
+    + setup_outbound_connection()
+    + send(payload: bytes)
+    + receive() : bytes
+    + dispose()
+}
+
+class ZMQConnector {
+    -- Attributes --
+    - setup_context : zmq.Context
+    - inbound_context : zmq.Context
+    - outbound_context : zmq.Context
+    - transport_layer : E3TransportLayer
+    -- Methods --
+    + __init__(transport_layer: E3TransportLayer)
+    + send_setup_request(payload: bytes)
+    + setup_inbound_connection()
+    + setup_outbound_connection()
+    + send(payload: bytes)
+    + receive() : bytes
+    + dispose()
+}
+
+class POSIXConnector {
+    -- Attributes --
+    - transport_layer : E3TransportLayer
+    - CHUNK_SIZE : int
+    -- Methods --
+    + __init__(transport_layer: E3TransportLayer)
+    + send_setup_request(payload: bytes)
+    + setup_inbound_connection()
+    + setup_outbound_connection()
+    + send(payload: bytes)
+    + receive() : bytes
+    + dispose()
+}
+
+AbstractClass E3Encoder {
+    -- Attributes --
+    - encoding_type : str
+    -- Methods --
+    + encode_pdu(pdu_type: str, pdu_data: dict) : bytes
+    + decode_pdu(data: bytes) : tuple
+    + create_setup_request(dappId: int, ranFunctions: list, msgId: int, actionType: str) : bytes
+    + create_subscription_request(msgId: int, dappId: int, actionType: str, ranFunctionId: int) : bytes
+    + create_message_ack(msgId: int, requestId: int, responseCode: str) : bytes
+    + create_control_action(msgId: int, dappId: int, actionData: bytes) : bytes
+    + create_dapp_report(msgId: int, reportData: bytes) : bytes
+    + create_indication_message(msgId: int, protocolData: bytes) : bytes
+}
+
+class AsnE3Encoder {
+    -- Attributes --
+    - defs : asn1tools.Compiler
+    -- Methods --
+    + __init__(asn_file_path: str)
+    + encode_pdu(pdu_type: str, pdu_data: dict) : bytes
+    + decode_pdu(data: bytes) : tuple
+    + create_setup_request(dappId: int, ranFunctions: list, msgId: int, actionType: str) : bytes
+    + create_subscription_request(msgId: int, dappId: int, actionType: str, ranFunctionId: int) : bytes
+    + create_message_ack(msgId: int, requestId: int, responseCode: str) : bytes
+    + create_control_action(msgId: int, dappId: int, actionData: bytes) : bytes
+    + create_dapp_report(msgId: int, reportData: bytes) : bytes
+    + create_indication_message(msgId: int, protocolData: bytes) : bytes
+}
+
+DApp --> E3Interface
+DApp <|-- SpectrumSharingDApp
+E3Connector <|-- ZMQConnector
+E3Connector <|-- POSIXConnector
+E3Encoder <|-- AsnE3Encoder
+E3Interface --* E3Connector
+E3Interface --* E3Encoder
+E3Connector --> E3LinkLayer 
+E3Connector --> E3TransportLayer
+@enduml