From 7878f8af6ed0bf2baa6ebdf3c61013cbe793dd87 Mon Sep 17 00:00:00 2001
From: Remi Hardy <remi.hardy@openairinterface.org>
Date: Mon, 5 Apr 2021 20:14:38 +0200
Subject: [PATCH] adding some inline doc/comments to ci_ctl_qtel.py

---
 ci-scripts/ci_ctl_qtel.py | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/ci-scripts/ci_ctl_qtel.py b/ci-scripts/ci_ctl_qtel.py
index b9e61c1687..1030b54616 100644
--- a/ci-scripts/ci_ctl_qtel.py
+++ b/ci-scripts/ci_ctl_qtel.py
@@ -32,10 +32,13 @@ import serial
 
 
 class qtel_ctl:
+	#---------------
+	#private methods
+	#---------------
     def __init__(self, usb_port_at):
-        self.QUECTEL_USB_PORT_AT = usb_port_at #'/dev/ttyUSB2'
+        self.QUECTEL_USB_PORT_AT = usb_port_at #ex : '/dev/ttyUSB2'
         self.modem = serial.Serial(self.QUECTEL_USB_PORT_AT, timeout=1)
-        self.cmd_dict= {"wup": self.wup,"detach":self.detach}
+        self.cmd_dict= {"wup": self.wup,"detach":self.detach}#dictionary of function pointers
 
     def __set_modem_state(self,ser,state):
 	    self.__send_command(ser,"AT+CFUN={}\r".format(state))
@@ -45,19 +48,24 @@ class qtel_ctl:
             ser.flushInput()
         ser.write(com.encode())
 
-
-    def wup(self):
+	#--------------
+	#public methods
+	#--------------
+    def wup(self):#sending AT+CFUN=0, then AT+CFUN=1
         self.__set_modem_state(self.modem,0)
         time.sleep(3)
         self.__set_modem_state(self.modem,1)
 
-    def detach(self):
+    def detach(self):#sending AT+CFUN=0
         self.__set_modem_state(self.modem,0)
 
 
 
 
 if __name__ == "__main__":
+	#argv[1] : usb port
+	#argv[2] : qtel command (see function pointers dict "wup", "detach" etc ...)
     command = sys.argv[2]
     Module=qtel_ctl(sys.argv[1])
+	#calling the function to be applied
     Module.cmd_dict[command]()