Merge pull request #13 from sixfab/hotfix/restructuring-issues-2

refactor: Refactor example codes

Author: electricalgorithm

examples/http_custom_header_example.py

@@ -40,7 +40,7 @@
 result = modem.network.check_network_registration()
 if result["status"] != Status.SUCCESS:
     debug.error("Could not connected to the cellular network.")
-    
+
 
 # Set the first HTTP context.
 modem.http.set_context_id()

examples/http_requests_example.py

@@ -6,19 +6,20 @@
 import time
 
 from core.modem import Modem
-from core.status import Status
+from core.utils.status import Status
 
 def handle_cellular_network_connection():
     """This function handles the connection to cellular network connection.
     """
     # Ask for return from the modem.
-    modem.check_modem_communication()
+    modem.base.check_communication()
     # Send APN details.
-    modem.set_modem_apn(cid=1, apn="super")
+    modem.network.set_apn(cid=1, apn="super")
+
     # Try to get a operator response for 10 times.
-    for _index in range(0, 10):
+    for _ in range(0, 10):
         # Check if there is a connection to any operator.
-        response = modem.get_operator_information()
+        response = modem.network.get_operator_information()
         if response["status"] == Status.SUCCESS:
             return
         # Wait for 1 second.
@@ -28,9 +29,9 @@ def prepare_http_connection():
     """This function prepares HTTP connection for modem.
     """
     # Set the first HTTP context.
-    modem.set_modem_http_context_id()
+    modem.http.set_context_id()
     # Activate PDP.
-    modem.activate_pdp_context()
+    modem.network.activate_pdp_context()
 
 def prepare_http_with_query(host_url, query_string=""):
     """Sets the modem's HTTP server address.
@@ -42,7 +43,7 @@ def prepare_http_with_query(host_url, query_string=""):
     # Add query to the server URL.
     url_to_post = host_url + "/?" + query_string
     # Set the HTTP url.
-    modem.set_modem_http_server_url(url=url_to_post)
+    modem.http.set_server_url(url=url_to_post)
 
 def send_post_request(server_url, data_dict, query_string=""):
     """POST request to the HTTP server with a payload and optional query.
@@ -57,7 +58,7 @@ def send_post_request(server_url, data_dict, query_string=""):
     # Convert to data to JSON.
     data_to_post = json.dumps(data_dict)
     # Send a post request to the URL.
-    print("POST Request: ", modem.http_post_request(data=data_to_post))
+    print("POST Request: ", modem.http.post(data=data_to_post))
     # Wait for six seconds before the next operation.
     time.sleep(6)
 
@@ -71,7 +72,7 @@ def send_get_request(server_url, query_string=""):
     # Configure the HTTP address.
     prepare_http_with_query(server_url, query_string)
     # Send a GET request.
-    print("GET Request: ", modem.http_get_request())
+    print("GET Request: ", modem.http.get())
     # Wait for six seconds before the next operation.
     time.sleep(6)
 
@@ -88,20 +89,20 @@ def send_put_request(server_url, data_dict, query_string=""):
     # Convert to data to JSON.
     data_to_post = json.dumps(data_dict)
     # Send a PUT request.
-    print("PUT Request: ", modem.http_put_request(data_to_post))
+    print("PUT Request: ", modem.http.put(data_to_post))
     # Wait for six seconds before the next operation.
     time.sleep(6)
 
 
 if __name__ == "__main__":
     # Initilizate the modem.
-    modem = Modem({})
+    modem = Modem()
     # Connect to a cellular network.
     handle_cellular_network_connection()
     # Prepare for the HTTP context.
     prepare_http_connection()
     # Select a HOST for testing purposes.
-    HOST = "https://webhook.site/6112efa6-4f8c-4bdb-8fa3-5787cc02f80a"
+    HOST = "https://webhook.site/e2519ab2-9f74-48c3-9346-0e2e93fa6ff3"
     # Send a POST request to the server.
     send_post_request(HOST, {"ProjectTopic": "PicocellHTTPExample"}, "device=Pico&try=0")
     # Send a GET request to the server.

examples/http_requests_example_with_manager.py

@@ -6,8 +6,8 @@
 import time
 
 from core.modem import Modem
-from core.status import Status
-from core.manager import StateManager, Step
+from core.utils.status import Status
+from core.utils.manager import StateManager, Step
 
 def step_for_setting_server_url(modem_object, next_function, url=None, query=""):
     """This function returns a step for setting server's URL with a query.
@@ -25,7 +25,7 @@ def step_for_setting_server_url(modem_object, next_function, url=None, query="")
     url_with_query = url + "/?" + query
     # Set-up the steps for state manager.
     step_set_server_url = Step(
-        function=modem_object.set_modem_http_server_url,
+        function=modem_object.http.set_server_url,
         name="set_server_url",
         success=next_function,
         fail="failure",
@@ -49,21 +49,21 @@ def prepare_communication_for_http(modem_object):
 
     # Set-up the steps for state manager.
     step_network_reg = Step(
-        function=modem_object.register_network,
+        function=modem_object.network.register_network,
         name="register_network",
         success="pdp_deactivate",
         fail="failure"
     )
 
     step_pdp_deactivate = Step(
-        function=modem_object.deactivate_pdp_context,
+        function=modem_object.network.deactivate_pdp_context,
         name="pdp_deactivate",
         success="pdp_activate",
         fail="failure"
     )
 
     step_pdp_activate = Step(
-        function=modem_object.activate_pdp_context,
+        function=modem_object.network.activate_pdp_context,
         name="pdp_activate",
         success="success",
         fail="failure",
@@ -76,7 +76,6 @@ def prepare_communication_for_http(modem_object):
 
     # Create the state manager.
     state_manager = StateManager(first_step=step_network_reg,
-                                cache=modem_object.cache,
                                 function_name=function_name)
 
     # Add each step.
@@ -112,7 +111,7 @@ def post_message_to_http_server(modem_object, payload, url=None, query=""):
         modem_object, "post_request", url, query)
 
     step_post_request = Step(
-        function=modem_object.http_post_request,
+        function=modem_object.http.post,
         name="post_request",
         success="success",
         fail="failure",
@@ -126,7 +125,6 @@ def post_message_to_http_server(modem_object, payload, url=None, query=""):
 
     # Create the state manager.
     state_manager = StateManager(first_step=step_set_server_url,
-                                cache=modem_object.cache,
                                 function_name=function_name)
 
     # Add each step.
@@ -160,7 +158,7 @@ def get_message_to_http_server(modem_object, url=None, query=""):
         modem_object, "get_request", url, query)
 
     step_get_request = Step(
-        function=modem_object.http_get_request,
+        function=modem_object.http.get,
         name="get_request",
         success="success",
         fail="failure",
@@ -173,7 +171,6 @@ def get_message_to_http_server(modem_object, url=None, query=""):
 
     # Create the state manager.
     state_manager = StateManager(first_step=step_set_server_url,
-                                cache=modem_object.cache,
                                 function_name=function_name)
 
     # Add each step.
@@ -208,7 +205,7 @@ def put_message_to_http_server(modem_object, payload, url=None, query=""):
         modem_object, "put_request", url, query)
 
     step_put_request = Step(
-        function=modem_object.http_put_request,
+        function=modem_object.http.put,
         name="put_request",
         success="success",
         fail="failure",
@@ -222,7 +219,6 @@ def put_message_to_http_server(modem_object, payload, url=None, query=""):
 
     # Create the state manager.
     state_manager = StateManager(first_step=step_set_server_url,
-                                cache=modem_object.cache,
                                 function_name=function_name)
 
     # Add each step.
@@ -241,24 +237,30 @@ def put_message_to_http_server(modem_object, payload, url=None, query=""):
 
 if __name__ == "__main__":
     # Initilize the modem object.
-    modem = Modem({})
+    modem = Modem()
+
     # Prepare communication for HTTP.
     prepare_communication_for_http(modem)
+
     # Server address to send requests.
-    HOST = "https://webhook.site/6112efa6-4f8c-4bdb-8fa3-5787cc02f80a"
+    HOST = "https://webhook.site/e2519ab2-9f74-48c3-9346-0e2e93fa6ff3"
     # Prepare a payload to post into the server.
     payload_to_post = {"ProjectTopic": "PicocellHTTPExampleWithManager"}
     payload_to_post_as_json = json.dumps(payload_to_post)
+
     # Post it to the server with given query.
     post_message_to_http_server(
         modem, payload_to_post_as_json, HOST, "device=Pico&try=0")
     time.sleep(4)
+
     # Get a request from the server.
     get_message_to_http_server(modem, HOST, "company=Sixfab&course=Picocell")
     time.sleep(6)
+
     # Prepare a payload to put into the server.
     payload_to_put = {"Temperature(*C)": 28}
     payload_to_put_as_json = json.dumps(payload_to_put)
+
     # Send the request into the server.
     put_message_to_http_server(
         modem, payload_to_put_as_json, HOST, "sensor=Garden2")

examples/telegram_example.py

@@ -6,23 +6,23 @@
 import time
 
 from core.modem import Modem
-from core.atcom import ATCom
+from core.utils.atcom import ATCom
 
 config = {}
 
 ############################
 ### Telegram API example ###
 ############################
 
-modem = Modem(config)
+modem = Modem()
 atcom = ATCom()
 
 # Write your text message here!
 user_text = 'Your text message here!'
 
 # Telegram Bot configurations 
-bot_token = 'YOUT_BOT_TOKEN'
-bot_chatID = 'YOUR_BOT_CHAT_ID'
+bot_token = '5469433192:AAH3L7t2RPrqHsY1r9rvXO_DU67Z5NdtMMw'
+bot_chatID = '-645292239'
 
 HOST = "api.telegram.org/bot"
 PAYLOAD_JSON = {""}
@@ -31,22 +31,21 @@
 publish_url = 'https://' + HOST + bot_token + '/sendMessage?chat_id=' + bot_chatID + '&text=' + user_text
 
 # Check communication with modem
-print("COM: ", modem.check_modem_communication())
+print("COM: ", modem.base.check_communication())
 print("Set APN: ", atcom.send_at_comm('AT+CGDCONT=1,"IP","super"',"OK"))
 print("COPS: ", atcom.retry_at_comm("AT+COPS?","+COPS: 0,0", timeout=1, retry_count=10))
 print(atcom.send_at_comm('AT+QICSGP=1,1,"super","","",1',"OK"))
 
 # TCP/IP
-print("TCPIP Context Configuration: ", modem.set_modem_http_context_id())
-print("PDP Deactivation: ", modem.deactivate_pdp_context())
-print("PDP Activatation: ", modem.activate_pdp_context())
+print("TCPIP Context Configuration: ", modem.http.set_context_id())
+print("PDP Deactivation: ", modem.network.deactivate_pdp_context())
+print("PDP Activatation: ", modem.network.activate_pdp_context())
 print("PDP Test: ", atcom.send_at_comm("AT+CGACT?","OK"))
 
 # HTTP
-print("Set HTTP SSL Context", modem.set_modem_http_ssl_context_id(2))
-print("HTTP URL: ", modem.set_modem_http_server_url(url=publish_url))
+print("Set HTTP SSL Context", modem.http.set_ssl_context_id(2))
+print("HTTP URL: ", modem.http.set_server_url(url=publish_url))
 time.sleep(6)
-print("HTTP GET: ", modem.http_get_request())
+print("HTTP GET: ", modem.http.get())
 time.sleep(6)
-print("HTTP READ: ", modem.http_read_response())
-
+print("HTTP READ: ", modem.http.read_response())