Add CellularConnectionHandler

Author: pennam

src/Arduino_CellularConnectionHandler.cpp

@@ -0,0 +1,89 @@
+/*
+  This file is part of the Arduino_ConnectionHandler library.
+
+  Copyright (c) 2024 Arduino SA
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+*/
+
+
+/******************************************************************************
+   INCLUDE
+ ******************************************************************************/
+
+#include "Arduino_CellularConnectionHandler.h"
+
+#ifdef BOARD_HAS_CELLULAR /* Only compile if the board has Cellular */
+
+/******************************************************************************
+   CTOR/DTOR
+ ******************************************************************************/
+
+CellularConnectionHandler::CellularConnectionHandler(const char * pin, const char * apn, const char * login, const char * pass, bool const keep_alive)
+: ConnectionHandler{keep_alive, NetworkAdapter::CELL}
+, _pin(pin)
+, _apn(apn)
+, _login(login)
+, _pass(pass)
+{
+
+}
+
+/******************************************************************************
+   PUBLIC MEMBER FUNCTIONS
+ ******************************************************************************/
+
+unsigned long CellularConnectionHandler::getTime()
+{
+  return _cellular.getCellularTime().getUNIXTimestamp();
+}
+
+/******************************************************************************
+   PROTECTED MEMBER FUNCTIONS
+ ******************************************************************************/
+
+NetworkConnectionState CellularConnectionHandler::update_handleInit()
+{
+  _cellular.begin();
+  _cellular.setDebugStream(Serial);
+  if (String(_pin).length() > 0 && !_cellular.unlockSIM(_pin)) {
+    Debug.print(DBG_ERROR, F("SIM not present or wrong PIN"));
+    return NetworkConnectionState::ERROR;
+  }
+  return NetworkConnectionState::CONNECTING;
+}
+
+NetworkConnectionState CellularConnectionHandler::update_handleConnecting()
+{
+  if (!_cellular.connect(_apn, _login, _pass)) {
+    Debug.print(DBG_ERROR, F("The board was not able to register to the network..."));
+    return NetworkConnectionState::ERROR;
+  }
+  Debug.print(DBG_INFO, F("Connected to Network"));
+  return NetworkConnectionState::CONNECTED;
+}
+
+NetworkConnectionState CellularConnectionHandler::update_handleConnected()
+{
+  if (!_cellular.isConnectedToInternet()) {
+    return NetworkConnectionState::DISCONNECTED;
+  }
+  return NetworkConnectionState::CONNECTED;
+}
+
+NetworkConnectionState CellularConnectionHandler::update_handleDisconnecting()
+{
+  return NetworkConnectionState::DISCONNECTED;
+}
+
+NetworkConnectionState CellularConnectionHandler::update_handleDisconnected()
+{
+  if (_keep_alive) {
+    return NetworkConnectionState::INIT;
+  }
+  return NetworkConnectionState::CLOSED;
+}
+
+#endif /* #ifdef BOARD_HAS_CELLULAR  */

src/Arduino_CellularConnectionHandler.h

@@ -0,0 +1,62 @@
+/*
+  This file is part of the Arduino_ConnectionHandler library.
+
+  Copyright (c) 2024 Arduino SA
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+*/
+
+
+#ifndef ARDUINO_CELLULAR_CONNECTION_HANDLER_H_
+#define ARDUINO_CELLULAR_CONNECTION_HANDLER_H_
+
+/******************************************************************************
+   INCLUDE
+ ******************************************************************************/
+
+#include "Arduino_ConnectionHandler.h"
+
+
+#ifdef BOARD_HAS_CELLULAR /* Only compile if the board has Cellular */
+
+/******************************************************************************
+   CLASS DECLARATION
+ ******************************************************************************/
+
+class CellularConnectionHandler : public ConnectionHandler
+{
+  public:
+
+    CellularConnectionHandler(const char * pin, const char * apn, const char * login, const char * pass, bool const keep_alive = true);
+
+
+    virtual unsigned long getTime() override;
+    virtual Client & getClient() override { return _gsm_client; };
+    virtual UDP & getUDP() override { } __attribute__((error("CellularConnectionHandler has no UDP support")));
+
+
+  protected:
+
+    virtual NetworkConnectionState update_handleInit         () override;
+    virtual NetworkConnectionState update_handleConnecting   () override;
+    virtual NetworkConnectionState update_handleConnected    () override;
+    virtual NetworkConnectionState update_handleDisconnecting() override;
+    virtual NetworkConnectionState update_handleDisconnected () override;
+
+
+  private:
+
+    const char * _pin;
+    const char * _apn;
+    const char * _login;
+    const char * _pass;
+
+    ArduinoCellular _cellular;
+    TinyGsmClient _gsm_client = _cellular.getNetworkClient();
+};
+
+#endif /* #ifdef BOARD_HAS_CELLULAR  */
+
+#endif /* #ifndef ARDUINO_CELLULAR_CONNECTION_HANDLER_H_ */

src/Arduino_ConnectionHandler.h

@@ -57,6 +57,7 @@
   #include <Ethernet.h>
   #include <PortentaEthernet.h>
   #include <GSM.h>
+  #include <Arduino_Cellular.h>
 
   #define BOARD_HAS_WIFI
   #define BOARD_HAS_ETHERNET
@@ -150,7 +151,7 @@
 #if defined(ARDUINO_ARCH_ESP32)
   #include <WiFi.h>
   #include <WiFiUdp.h>
-  
+
   #define BOARD_HAS_WIFI
   #define NETWORK_HARDWARE_ERROR WL_NO_SHIELD
   #define NETWORK_IDLE_STATUS WL_IDLE_STATUS
@@ -201,7 +202,8 @@ enum class NetworkAdapter {
   NB,
   GSM,
   LORA,
-  CATM1
+  CATM1,
+  CELL
 };
 
 typedef void (*OnNetworkEventCallback)();
@@ -237,13 +239,11 @@ class ConnectionHandler {
 
     NetworkConnectionState check();
 
-    #if defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT)
+    #if !defined(BOARD_HAS_LORA)
       virtual unsigned long getTime() = 0;
       virtual Client &getClient() = 0;
       virtual UDP &getUDP() = 0;
-    #endif
-
-    #if defined(BOARD_HAS_LORA)
+    #else
       virtual int write(const uint8_t *buf, size_t size) = 0;
       virtual int read() = 0;
       virtual bool available() = 0;
@@ -304,4 +304,8 @@ class ConnectionHandler {
   #include "Arduino_CatM1ConnectionHandler.h"
 #endif
 
+#if defined(BOARD_HAS_CELLULAR)
+  #include "Arduino_CellularConnectionHandler.h"
+#endif
+
 #endif /* CONNECTION_HANDLER_H_ */