Python library that enables data transmission from xApps to the ORANOS Ix server and potentially to remote RIC xApps.

1. Ix server URL
2. Ix credentials are generated for each xApp when it registers to its local Ix server. In order to register, the developer can do so through POST /internal/register.

This is a private library, thus not published on PyPi. You can still use pip to install it, but you have to provide the repo's url.

pip install git+ssh://[email protected]/hpn-bristol/oranos-ix-client.git

This class implements an ORANOS Ix client that enables xApp communication to their respective Ix server. It uses socket.io websockets and long-polling requests to achieve minimal transmit latency.

Returns the current connection status of the Ix client.

Initiate the Ix client's connection to the Ix server.

If a relation_id is provided, the Ix server will create a pipeline to the remote Ix and xApp found in the relation details.

Terminate the Ix client's connection to the Ix server.

Transmit data to the Ix server.

If the connection was made with a relation_id, the data will also be forwarded to the remote Ix server and xApp found in the relation details.

from oranos_ix_client import IxClient

# Create an Ix client instance
client = IxClient(url='http://localhost:80', username="some_xapp_name", password="SuperSecurePassword")

# Initiate the Ix client connection
client.connect()

# Use IxClient.is_connected property to transmit data while the connection remains active
while client.is_connected:
    data_example: {"attenuation": 13.2, "health": 0.74}
    client.send(data=data_example)

Firstly, in order to use an xApp relation you first need to create one. To do so, the xApp developer should request it from the Ix through POST /internal/relations.

Then, the xApp can make use of the relation and forward data to a remote Ix server. The only code change required is to define the optional relation_id parameter during the connection step.

client.connect(relation_id="rel521ff72fda23360e")