e2sim: add support for Resource Status Request, Response, Update

[it/test.git] / simulators / e2sim / README.md

diff --git a/simulators/e2sim/README.md b/simulators/e2sim/README.md
index db93deb..ed260c3 100644 (file)
--- a/simulators/e2sim/README.md
+++ b/simulators/e2sim/README.md
@@ -46,22 +46,26 @@
   $  $E2SIM_DIR/build/e2sim [SERVER IP] [PORT]
 
   By default, SERVER IP = 127.0.0.1, PORT = 36421
+  The RIC (i.e., E2 Manager) will need to setup X2 or E2 connection to e2sim on
+  this SERVER IP and PORT
 
 # DOCKER
-  Note: The commands in this section must be run from $E2SIM_DIR
-
-  * Build docker image
+  * Build docker image: run this command from $E2SIM_DIR
   $ sudo docker build -f docker/Dockerfile -t [DOCKER_IMAGE]:[TAG] .
 
   * Example how to run docker container
   $ sudo docker run --rm --net host -it [DOCKER_IMAGE]:[TAG] sh -c "./build/e2sim [SERVER IP] [PORT]"
+  ex: sudo docker run --rm --net host -it e2sim:1.0.0 sh -c "./build/e2sim 127.0.0.1 36422"
 
 # SUPPORTED MESSAGE FLOWS
+- RESOURCE STATUS REQUEST   (RIC -> RAN)    version 1.4.0   November 16, 2019
+- RESOURCE STATUS RESPONSE  (RAN -> RIC)
+- RESOURCE STATUS UPDATE    (RAN -> RIC)      
 
-- RIC INDICATION            (RAN -> RIC)      version 1.3.0   September 13, 2019
+- RIC INDICATION            (RAN -> RIC)    version 1.3.0   September 13, 2019
     SgNBAdditionRequest
 
-- RIC SUBSCRIPTION REQUEST  (RIC -> RAN)      version 1.2.0   May 24, 2019
+- RIC SUBSCRIPTION REQUEST  (RIC -> RAN)    version 1.2.0   May 24, 2019
 - RIC SUBSCRIPTION RESPONSE (RAN -> RIC)
 - RIC SUBSCRIPTION FAILURE  (RAN -> RIC)
 
@@ -76,14 +80,16 @@
  ./tools/install_asn1c
 
  2. Generate asn1c codes using e2ap, e2sm and x2ap specs
- Download the following files into tools/asn_defs
+ This requires the following files in tools/asn_defs
   - e2ap-v031.asn
   - e2sm-gNB-X2-release-1-v041.asn
   - x2ap-no-desc-15-04.asn
 
 # Change logs:
-  03/12/2019: currently supports sending and receiving X2 SETUP messages
+  11/16/2019: - Switch back to using asn1c compiler
+              - add support to Resource Status Request, Response, and Update (over X2)
+  05/24/2019: add support for RIC SUBSCRIPTION REQUEST, RESPONSE, and FAILURE
   05/21/2019: add support for ENDC X2 SETUP   
               no longer use asn1c
               all X2AP and E2AP messages are encapsulated into E2AP-PDU
-  05/24/2019: add support for RIC SUBSCRIPTION REQUEST, RESPONSE, and FAILURE
+  03/12/2019: currently supports sending and receiving X2 SETUP messages