docs/overview.rst

   1 # ==================================================================================
   2 #  Copyright (c) 2020 HCL Technologies Limited.
   3 #
   4 #  Licensed under the Apache License, Version 2.0 (the "License");
   5 #  you may not use this file except in compliance with the License.
   6 #  You may obtain a copy of the License at
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #  Unless required by applicable law or agreed to in writing, software
  11 #  distributed under the License is distributed on an "AS IS" BASIS,
  12 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #  See the License for the specific language governing permissions and
  14 #  limitations under the License.
  15 # ==================================================================================
  16
  17
  18 Anomaly Detection Overview
  19 ======================
  20
  21 Anomaly Detection (AD) is an Xapp in the Traffic Steering O-RAN use case,
  22 which uses the following Xapps:
  23
  24 #. AD, which iterates per second, fetches UE data from .csv files and send prediction to Traffic Steering
  25 #. Traffic Steering send acknowldgement back to AD.
  26
  27 Expected Input
  28 --------------
  29
  30 The AD Xapp expects a prediction-input in following structure::
  31
  32 UEPDCPBytesDL   UEPDCPBytesUL   UEPRBUsageDL    UEPRBUsageUL    S_RSRP  S_RSRQ    S_SINR        N1_RSRP   N1_RSRQ       N1_SINR   N2_RSRP       N2_RSRQ   N2_SINR       UEID    ServingCellID           N1            N2         MeasTimestampRF
  33
  34         300000                  123000                  25                              10                      -43             -3.4            25              -53                     -6.4      20            -68             -9.4            17              12345           555011            555010         555012     30:17.8
  35
  36
  37 Expected Output
  38 ---------------
  39
  40 The AD Xapp should send a prediction for Anomulous UEID along with timestamp
  41 as a JSON message via RMR with the following structure:
  42
  43   {
  44   "UEID" : 12371,
  45   "MeasTimestampRF" : "2020-11-17 16:14:25.140140"
  46   }
  47
  48