- README

Author: ubidefeo

README.md

@@ -24,3 +24,17 @@ Lesser General Public License for more details.
 You should have received a copy of the GNU Lesser General Public
 License along with this library; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+
+### ConnectionHandler
+
+**Connection Handler** is configured via a series of compiler directives, including the correct implementation of the class based on which board is selected.
+
+### How to use it
+- Instantiate the class with `ConnectionHandler conHandler(SECRET_SSID, SECRET_PASS);` if you are using a WiFi board, otherwise replace **WiFi** with **GSM** or any future implementation minding to carefully pass the init parameters to the constructor (i.e.: for the GSM you'll need to pass PIN, APN, login, password).
+
+- The `update()` method does all the work. It uses a finite state machine and is responsible for connection and reconnection to a network. The method is designed to be non-blocking by using time (milliseconds) to perform its tasks.
+
+- `&getClient()` returns a reference to an instance of the `Client` class used to connect to the network.
+
+- `getStatus()` returns the network connection status. The different states are defined in an `enum`

src/Arduino_GSMConnectionHandler.cpp

@@ -112,6 +112,7 @@ void GSMConnectionHandler::update() {
       init();
     }
     break;
+
     case NetworkConnectionState::CONNECTING: {
       // NOTE: Blocking Call when 4th parameter == true
       GSM3_NetworkStatus_t networkStatus;
@@ -216,7 +217,7 @@ void GSMConnectionHandler::changeConnectionState(NetworkConnectionState _newStat
 
 
 void GSMConnectionHandler::connect() {
-  if(netConnectionState == NetworkConnectionState::INIT || netConnectionState == NetworkConnectionState::CONNECTING){
+  if (netConnectionState == NetworkConnectionState::INIT || netConnectionState == NetworkConnectionState::CONNECTING) {
     return;
   }
   keepAlive = true;
@@ -225,7 +226,7 @@ void GSMConnectionHandler::connect() {
 }
 void GSMConnectionHandler::disconnect() {
   //WiFi.end();
-  
+
   changeConnectionState(NetworkConnectionState::DISCONNECTING);
   keepAlive = false;
 }