Update README
Change-Id: I33b263d61f6ee7104e616a59682af988e3c519d5
diff --git a/README.md b/README.md
index d125259..ccc178d 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,15 @@
-# 1. Overview
+# 1. Overview & Features
-The BBSim (Broadband Simulator) is for emulating the control message response sent from OLT and ONUs which are connected to VOLTHA Adapter.
+The BBSim (Broadband Simulator) is for emulating the control message response (e.g. OLTInd, DHCP, EAPOL, OpenOMCI messages etc..) sent from OLT and ONUs which are connected to VOLTHA Adapter (OpenOLT Adapter).
It is implemetend as a software process which runs outside VOLTHA, and acts as if it was a OLT connected to multiple ONUs.
-This enables the scalability test of VOLTHA without actual hardware OLT / ONUs.
+This enables the scalability test of VOLTHA / ONOS without actual hardware OLT / ONUs.
+The BBSim container contains wpa_supplicants and dhcp clients inside, so that you can try to test AAA/DHCPL2Relay Apps on ONOS using BBSim.
The difference from the existing PONsim is to focus on emulating control messages, not data-path traffic which PONsim targets.
-The BBSim container contains wpa_supplicants and dhcp clients for supporting AAA client (wpa_supplicant) emulation & DHCP client emulation.
-
```
==============
VOLTHA
-BBSim Adapter
+OpenOLT Adapter
==============
|
| gRPC connections
@@ -22,6 +21,7 @@
```
# 2. Build, Run BBSim and VOLTHA-CLI commands
+※ You need to configure SADIS before you start to run BBSim, if you want to test AAA/DHCP (Refer to section 3).
```
# Build and Run Docker container
git clone https://github.com/opencord/voltha-bbsim
@@ -34,7 +34,7 @@
{
"state": "HEALTHY"
}
-(voltha) preprovision_olt -t bbsimolt -H <BBSim Docker container IP>
+(voltha) preprovision_olt -t openolt -H <BBSim Docker container IP>
success (device id = <deviceid>)
(voltha) enable
enabling <deviceid>
@@ -44,17 +44,46 @@
## You can see the list of devices (OLT/ONUs) ##
```
-# 3. How to use BBSim
-
+# 3. Configuration of ONOS App side
+You need to configure a few parameters for AAA/DHCPL2Relay app before running BBSim.
+You only need to set 1. device id assigned to BBSim (i.e. of:*********), 2. IP Address of BBSim container and 3. c/sTag with BBSim ONU instance device id, in .netconf file.
+(Please refer to https://wiki.onosproject.org/display/ONOS/NETCONF about netconf support in ONOS)
```
-# Note: 2018/10/8 The current version only supports AAA emulations.
+ "org.opencord.dhcpl2relay" : {
+ "dhcpl2relay" : {
+ "dhcpServerConnectPoints" : [ "<device id assigned to BBSim>/65536" ],
+ "useOltUplinkForServerPktInOut" : true
+ }
+ },
+
+ ....
+
+ "org.opencord.sadis" : {
+ "sadis" : {
+ "entries":[
+ {
+ "id" : "<IP Address of BBSim Container>:50060",
+ "hardwareIdentifier" : "de:ad:be:ef:ba:11",
+ "uplinkPort" : 65536
+ },
+ //BBSim generates both device id and c/stag assigned to each ONU while incrementing them by 1 from BBSM00000100, 900.
+ //The following lines are an example when we use for configuring 2 ONUs.
+ {"id" : "BBSM00000100", "cTag" : 900, "sTag" : 900, "nasPortId" : "BBSM00000100"},
+ {"id" : "BBSM00000101", "cTag" : 901, "sTag" : 901, "nasPortId" : "BBSM00000101"},
+
+ ......
+```
+
+
+# 4. CLI options
+```
Usage of ./bbsim:
-H string
IP address:port (default ":50060")
-aw int
- Wait time (sec) for activation WPA supplicants (default 30)
+ Wait time (sec) for activation WPA supplicants (default 10)
-dw int
- Wait time (sec) for activation DHCP clients (default 10)
+ Wait time (sec) for activation DHCP clients (default 20)
-i int
Number of PON-IF ports (default 1)
-id int