Update doc plantuml (#35)

* Update cellular library to MIT license

* Update doc plantuml

* Remove unused images in doc

Author: chinglee-iot

…/cellular_URC_handler_implementation.txt …l/cellular_URC_handler_implementation.pndoc/plantuml/cellular_URC_handler_implementation.txt renamed to doc/plantuml/cellular_URC_handler_implementation.pn doc/plantuml/cellular_URC_handler_implementation.txt renamed to doc/plantuml/cellular_URC_handler_implementation.pn

@@ -1,3 +1,5 @@
+@startuml
+
 Title FreeRTOS Cellular Library URC handler implementation
 
 participant Application
@@ -16,3 +18,5 @@ Cellular_modules_porting ->Application : Call the callback function registered i
 Cellular_modem ->Cellular_common : "+CREG: 2,0"
 Cellular_common -> Cellular_common : Call the callback function\nCellular_CommonUrcProcessCreg(  pContext, "+CREG: 2,0" )
 Cellular_common->Application : callback function registered in\nCellular_RegisterUrcNetworkRegistrationEventCallback()
+
+@enduml

…plantuml/cellular_api_implementation.txt …/plantuml/cellular_api_implementation.pudoc/plantuml/cellular_api_implementation.txt renamed to doc/plantuml/cellular_api_implementation.pu doc/plantuml/cellular_api_implementation.txt renamed to doc/plantuml/cellular_api_implementation.pu

@@ -1,14 +1,16 @@
+@startuml
+
 Title FreeRTOS Cellular Library API implementation
 
 participant Application
-participant FreeRTOS Cellular Library
+participant "FreeRTOS Cellular Library"
 participant Cellular_modules_porting
 participant Cellular_common
 participant Cellular_modem
 
-Application ->FreeRTOS Cellular Library : Cellular_GetSimCardStatus()
+Application ->"FreeRTOS Cellular Library" : Cellular_GetSimCardStatus()
 
-FreeRTOS Cellular Library->Cellular_modules_porting :Cellular_GetSimCardStatus()
+"FreeRTOS Cellular Library"->Cellular_modules_porting :Cellular_GetSimCardStatus()
 
 Cellular_modules_porting->Cellular_common:Get module context passed in Cellular_ModuleInt() :\n_Cellular_GetModuleContext()
 
@@ -26,4 +28,4 @@ Cellular_common ->Cellular_modules_porting : Call the callback function with cor
 
 Cellular_modules_porting ->Application : Return parsing status and data
 
-
+@enduml

doc/plantuml/cellular_module_porting_functions.pu

@@ -0,0 +1,35 @@
+@startuml
+
+Title FreeRTOS Cellular Library interaction with cellular module porting APIs
+
+participant Application
+participant "FreeRTOS Cellular Library"
+participant Cellular_common
+participant Cellular_modules_porting
+
+Application ->"FreeRTOS Cellular Library" : Cellular_Init()
+
+"FreeRTOS Cellular Library" -> Cellular_common : Cellular_CommonInit()
+
+Cellular_common -> Cellular_modules_porting : Cellular_moduleInit()
+
+Cellular_common -> Cellular_modules_porting : Cellular_moduleEnableUE()
+
+Cellular_common -> Cellular_modules_porting : Cellular_moduleEnableUrc
+
+Cellular_common --> "FreeRTOS Cellular Library" :
+
+"FreeRTOS Cellular Library" --> Application :
+
+
+Application ->"FreeRTOS Cellular Library" : Cellular_CleanUp()
+
+"FreeRTOS Cellular Library" -> Cellular_common : Cellular_CommonCleanUp()
+
+Cellular_common -> Cellular_modules_porting : Cellular_moduleCleanUp()
+
+Cellular_common --> "FreeRTOS Cellular Library" :
+
+"FreeRTOS Cellular Library" --> Application :
+
+@enduml

doc/plantuml/cellular_module_porting_functions.txt

@@ -0,0 +1,74 @@
+@startuml
+
+Title FreeRTOS Cellular Library interaction with com interface
+
+participant Application
+participant "FreeRTOS Cellular Library"
+participant cellular_comm_interface
+participant cellular_modem
+
+note over Application : Application needs cellular connecitvity.\nCellular_Init() is called to open FreeRTOS \nCellular Library. Communication interface\n, pCommInterface, is provided by\napplication to "FreeRTOS Cellular Library".
+
+Application -> "FreeRTOS Cellular Library" : Cellular_Init( pCommInterface )
+
+activate Application
+
+"FreeRTOS Cellular Library" ->cellular_comm_interface : pCommInterface->Open( receiveCallback )
+
+cellular_comm_interface->cellular_modem : Register receive callback\nOpen and setup communication device driver\nPower on and enable device
+
+cellular_comm_interface-->"FreeRTOS Cellular Library":
+
+"FreeRTOS Cellular Library"-->Application:
+
+deactivate Application
+
+note over Application : "FreeRTOS Cellular Library" APIs ready.\nApplication get network time with\nCellular_GetNetworkTime() function
+
+Application -> "FreeRTOS Cellular Library" : Cellular_GetNetworkTime()
+
+activate Application
+
+"FreeRTOS Cellular Library"->cellular_comm_interface : pCommInterface->Send()
+
+cellular_comm_interface->cellular_modem : AT+CCLK?
+
+cellular_modem->cellular_comm_interface : +CCLK: "20/06/09,12:06:33+32"
+
+cellular_comm_interface->cellular_comm_interface : Store `+CCLK: "20/06/09,12:06:33+32"` in buffer
+
+cellular_comm_interface->"FreeRTOS Cellular Library" : receiveCallback
+
+"FreeRTOS Cellular Library"->cellular_comm_interface : pCommInterface->recv()
+
+cellular_comm_interface-->"FreeRTOS Cellular Library" : Return data in buffer
+
+cellular_modem->cellular_comm_interface : OK
+
+cellular_comm_interface->cellular_comm_interface : Store `OK` in buffer
+
+cellular_comm_interface->"FreeRTOS Cellular Library" : receiveCallback
+
+cellular_comm_interface-->"FreeRTOS Cellular Library" : Return data in buffer
+
+"FreeRTOS Cellular Library"->Application : Return network time
+
+deactivate Application
+
+note over Application : Applicaton no longer need cellular\nconnectivity. Cellular_Cleanup() is \ncalled to close FreeRTOS Cellular Library.
+
+Application -> "FreeRTOS Cellular Library" : Cellular_Cleanup()
+
+activate Application
+
+"FreeRTOS Cellular Library"->cellular_comm_interface : pCommInterface->Close()
+
+cellular_comm_interface->cellular_modem : Power off device\nClose communication device driver\n
+
+cellular_comm_interface-->"FreeRTOS Cellular Library":
+
+"FreeRTOS Cellular Library"-->Application:
+
+deactivate Application
+
+@enduml