From 002304c32d5c538f58bacccbafa64570e3f2a736 Mon Sep 17 00:00:00 2001
From: Ben Greear <greearb@candelatech.com>
Date: Sat, 8 May 2021 08:47:31 -0700
Subject: [PATCH] cv-automation:  Update help in cap-to-grafana shell script.

Add comments, remove an un-used variable from the dut creation logic.

Signed-off-by: Ben Greear <greearb@candelatech.com>
---
 py-scripts/wifi_cap_to_grafana.sh | 26 ++++++++++++++++----------
 1 file changed, 16 insertions(+), 10 deletions(-)

diff --git a/py-scripts/wifi_cap_to_grafana.sh b/py-scripts/wifi_cap_to_grafana.sh
index 79c280b3..d7dcadf1 100755
--- a/py-scripts/wifi_cap_to_grafana.sh
+++ b/py-scripts/wifi_cap_to_grafana.sh
@@ -1,33 +1,39 @@
 #!/bin/bash
-##########################
-# Help
-##########################
-Help()
-{
-  echo "This bash script creates a DUT, loads a scenario, runs a WiFi Capacity test, and saves it to Influx"
-}
+
+# This bash script creates/updates a DUT, creates/updates a chamberview scenario,
+# loads and builds that scenario, runs wifi capacity test, and saves the kpi.csv info
+# into influxdb.  As final step, it builds a grafana dashboard for the KPI information.
+
+# Define some common variables.  This will need to be changed to match your own testbed.
 MGR=192.168.1.7
 INFLUXTOKEN=Tdxwq5KRbj1oNbZ_ErPL5tw_HUH2wJ1VR4dwZNugJ-APz__mEFIwnqHZdoobmQpt2fa1VdWMlHQClR8XNotwbg==
 TESTBED=Stidmatt-01
 GRAFANATOKEN=eyJrIjoiZTJwZkZlemhLQVNpY3hiemRjUkNBZ3k2RWc3bWpQWEkiLCJuIjoibWFzdGVyIiwiaWQiOjF9
 GROUPS=/tmp/lf_cv_rpt_filelocation.txt
 
+# Create/update new DUT.
 #Replace my arguments with your setup.  Separate your ssid arguments with spaces and ensure the names are lowercase
 echo "Make new DUT"
 ./create_chamberview_dut.py --lfmgr ${MGR} --dut_name DUT_TO_GRAFANA_DUT \
---ssid "ssid_idx=0 ssid=lanforge security=WPA2 password=password bssid=04:f0:21:2c:41:84 traffic=wiphy1"
+--ssid "ssid_idx=0 ssid=lanforge security=WPA2 password=password bssid=04:f0:21:2c:41:84"
 
-echo "Build Chamber View Scenario" #change the lfmgr to your system, set the radio to a working radio on your LANforge system, same with the ethernet port.
+# Create/update chamber view scenario and apply and build it.
+echo "Build Chamber View Scenario"
+#change the lfmgr to your system, set the radio to a working radio on your LANforge system, same with the ethernet port.
 ./create_chamberview.py --lfmgr ${MGR} --create_scenario DUT_TO_GRAFANA_SCENARIO \
 --line "Resource=1.1 Profile=default Amount=32 Uses-1=wiphy1 DUT=DUT_TO_GRAFANA_DUT Traffic=wiphy1 Freq=-1" \
 --line "Resource=1.1 Profile=upstream Amount=1 Uses-1=eth1 DUT=DUT_TO_GRAFANA_DUT Traffic=eth1 Freq=-1"
 
+# Run capacity test on the stations created by the chamber view scenario.
+# Submit the KPI data into the influxdb.
 #config_name doesn't matter, change the influx_host to your LANforge device,
 echo "run wifi capacity test"
 ./lf_wifi_capacity_test.py --config_name Custom --create_stations --radio wiphy1 --pull_report --influx_host ${MGR} \
 --influx_port 8086 --influx_org Candela --influx_token  ${INFLUXTOKEN} --influx_bucket lanforge --mgr ${MGR} \
 --instance_name testing --upstream eth1 --test_rig ${TESTBED} --graphgroups ${GROUPS}
 
+# Build grafana dashboard and graphs view for the KPI in the capacity test.
 ./grafana_profile.py --create_custom --title ${TESTBED} --influx_bucket lanforge --mgr 192.168.1.7 --grafana_token ${GRAFANATOKEN} \
 --grafana_host 192.168.1.7 --testbed ${TESTBED} --graph-groups  ${GROUPS} --scripts Dataplane --scripts 'WiFi Capacity'
-rm filelocation.txt
+
+rm ${GROUPS}