chore: Strip BOARD_HAS_SECRET_KEY

Author: zfields

src/AIoTC_Config.h

@@ -21,7 +21,6 @@
 #if defined __has_include
   #if __has_include (<Notecard.h>)
     #define USE_NOTECARD
-    #define BOARD_HAS_SECRET_KEY
   #endif
 #endif
 

src/ArduinoIoTCloudNotecard.cpp

@@ -28,6 +28,7 @@
 #include <algorithm>
 #include <functional>
 
+#include <Arduino.h>
 #include <Arduino_NotecardConnectionHandler.h>
 
 #include "cbor/CBOREncoder.h"
@@ -79,9 +80,6 @@ ArduinoIoTCloudNotecard::ArduinoIoTCloudNotecard()
   ,_notecard_read_interval_ms{DEFAULT_READ_INTERVAL_MS}
   ,_interrupt_pin{-1}
   ,_data_available{false}
-#if defined(BOARD_HAS_SECRET_KEY)
-  ,_secret_device_key{""}
-#endif /* BOARD_HAS_SECRET_KEY */
 #if OTA_ENABLED
   ,_ota_cap{false}
   ,_ota_error{static_cast<int>(OTAError::None)}
@@ -99,33 +97,36 @@ ArduinoIoTCloudNotecard::ArduinoIoTCloudNotecard()
  * PUBLIC MEMBER FUNCTIONS
  ******************************************************************************/
 
-int ArduinoIoTCloudNotecard::begin(ConnectionHandler &connection, int interrupt_pin)
+int ArduinoIoTCloudNotecard::begin(ConnectionHandler &connection_, int interrupt_pin_)
 {
-  _connection = &connection;
+  _connection = &connection_;
+  NotecardConnectionHandler *notecard_connection = reinterpret_cast<NotecardConnectionHandler *>(_connection);
+
+  // Configure the interrupt pin
+  if (interrupt_pin_ >= 0) {
+    _interrupt_pin = interrupt_pin_;
+    ::pinMode(_interrupt_pin, INPUT);
+    ::attachInterrupt(digitalPinToInterrupt(_interrupt_pin), ISR_dataAvailable, RISING);
+    notecard_connection->enableHardwareInterrupts();
+  }
+
+  // Initialize the connection to the Notecard
   if (NetworkConnectionState::ERROR == _connection->check()) {
     DEBUG_ERROR("ArduinoIoTCloudNotecard::%s encountered fatal connection error!", __FUNCTION__);
     return 0; // (false -> failure)
   }
 
-#ifdef BOARD_HAS_SECRET_KEY
-  // Update Device ID using connection cache
-  setBoardId(getDeviceId());
-#endif
-
-  // Configure the interrupt pin
-  if (interrupt_pin >= 0) {
-    ::pinMode(interrupt_pin, INPUT);
-    ::attachInterrupt(digitalPinToInterrupt(interrupt_pin), ISR_dataAvailable, RISING);
-    _interrupt_pin = interrupt_pin;
-  }
+  //TODO: Remove if not needed
+  // Pull the Arduino IoT Cloud Device ID from the Notecard
+  setDeviceId(notecard_connection->getDeviceId());
 
 #if  OTA_ENABLED
   /* Setup OTA TLS client */
   _otaClient.begin(connection);
 #endif
 
   // Begin the Notecard time service
-  _time_service.begin(&connection);
+  _time_service.begin(&connection_);
 
   /* Setup retry timers */
   _connection_attempt.begin(AIOT_CONFIG_RECONNECTION_RETRY_DELAY_ms, AIOT_CONFIG_MAX_RECONNECTION_RETRY_DELAY_ms);
@@ -148,6 +149,7 @@ void ArduinoIoTCloudNotecard::printDebugInfo()
   NetworkConnectionState conn_state = _connection->check();
   DEBUG_INFO("***** Arduino IoT Cloud Notecard - configuration info *****");
   DEBUG_INFO("Notecard UID: %s", reinterpret_cast<NotecardConnectionHandler *>(_connection)->getNotecardUid().c_str());
+  //TODO: Remove if not needed
   DEBUG_INFO("Arduino Device ID: %s", getDeviceId().c_str());
   if (NetworkConnectionState::CONNECTED == conn_state)
   {
@@ -167,7 +169,6 @@ void ArduinoIoTCloudNotecard::update()
   {
   case State::ConnectPhy:           next_state = handle_ConnectPhy();           break;
   case State::SyncTime:             next_state = handle_SyncTime();             break;
-  case State::ConfigureNotehub:     next_state = handle_ConfigureNotehub();     break;
   case State::Connected:            next_state = handle_Connected();            break;
   case State::Disconnect:           next_state = handle_Disconnect();           break;
   }
@@ -199,39 +200,20 @@ ArduinoIoTCloudNotecard::State ArduinoIoTCloudNotecard::handle_SyncTime()
   if (TimeServiceClass::isTimeValid(current_time))
   {
     DEBUG_VERBOSE("ArduinoIoTCloudNotecard::%s internal clock configured to posix timestamp %d", __FUNCTION__, current_time);
-    return State::ConfigureNotehub;
+    return State::Connected;
   }
 
   DEBUG_ERROR("ArduinoIoTCloudNotecard::%s could not get valid time. Retrying now.", __FUNCTION__);
   return State::ConnectPhy;
 }
 
-ArduinoIoTCloudNotecard::State ArduinoIoTCloudNotecard::handle_ConfigureNotehub()
-{
-  if (!connected())
-  {
-    DEBUG_ERROR("ArduinoIoTCloudNotecard::%s connection to Notehub lost", __FUNCTION__);
-    return State::ConnectPhy;
-  }
-
-#if defined(BOARD_HAS_SECRET_KEY)
-  if (reinterpret_cast<NotecardConnectionHandler *>(_connection)->syncSecretDeviceKey(_secret_device_key)) {
-    DEBUG_WARNING("ArduinoIoTCloudNotecard::%s failed to set secret device key", __FUNCTION__);
-    DEBUG_WARNING("You may manually enter the secret key on Notehub as a device level environment variable named `arduino_iot_cloud_secret_device_key`");
-  }
-#endif
-
-  return State::Connected;
-}
-
 ArduinoIoTCloudNotecard::State ArduinoIoTCloudNotecard::handle_Connected()
 {
   if (!connected() || !_thing.connected() || !_device.connected())
   {
     return State::Disconnect;
   }
 
-  //TODO: Understand how available applies to the _device.update() and _thing.update()
   /* Poll Notecard for new messages */
   pollNotecard();
 

src/ArduinoIoTCloudNotecard.h

@@ -48,6 +48,11 @@ typedef bool (*onOTARequestCallbackFunc)(void);
  * CLASS DECLARATION
  ******************************************************************************/
 
+/**
+ * @brief The ArduinoIoTCloudNotecard class
+ *
+ * This class is used to connect to the Arduino IoT Cloud using a Notecard.
+ */
 class ArduinoIoTCloudNotecard : public ArduinoIoTCloudClass
 {
   public:
@@ -59,13 +64,30 @@ class ArduinoIoTCloudNotecard : public ArduinoIoTCloudClass
     virtual void printDebugInfo() override;
     inline virtual PropertyContainer &getThingPropertyContainer() override { return _thing.getPropertyContainer(); }
 
+    /**
+     * @brief Begin the connection to the Arduino IoT Cloud.
+     *
+     * @param connection The connection handler to use.
+     * @param interrupt_pin The interrupt pin to use for the Notecard.
+     *
+     * @note The interrupt pin is optional and only required if you want to
+     * eliminate the need to poll the Notecard for new data.
+     *
+     * @return 1 on success, 0 on failure.
+     */
     int begin(ConnectionHandler &connection, int interrupt_pin = -1);
 
-#ifdef BOARD_HAS_SECRET_KEY
-    inline void setBoardId        (String const & device_id) { (_connection && (NetworkConnectionState::INIT != _connection->check())) ? setDeviceId(reinterpret_cast<NotecardConnectionHandler *>(_connection)->syncArduinoDeviceId(device_id)) : setDeviceId(device_id); }
-    inline void setSecretDeviceKey(String const & secret_device_key)  { _secret_device_key = secret_device_key; }
-#endif
-
+    /**
+     * @brief Set the Notecard read interval.
+     *
+     * The interval at which the Notecard is polled for new data. The default
+     * interval is 1000ms, and the minimum interval is 250ms.
+     *
+     * @param interval_ms The interval in milliseconds.
+     *
+     * @note The Notecard read interval is ignored if an interrupt pin is
+     * provided to the `begin()` function.
+     */
     inline void setNotecardReadInterval(uint32_t interval_ms) { _notecard_read_interval_ms = ((interval_ms < 250) ? 250 : interval_ms); }
 
   private:
@@ -74,7 +96,6 @@ class ArduinoIoTCloudNotecard : public ArduinoIoTCloudClass
     {
       ConnectPhy,
       SyncTime,
-      ConfigureNotehub,
       Connected,
       Disconnect,
     };
@@ -93,10 +114,6 @@ class ArduinoIoTCloudNotecard : public ArduinoIoTCloudClass
     int _interrupt_pin;
     volatile bool _data_available;
 
-#ifdef BOARD_HAS_SECRET_KEY
-    String _secret_device_key;
-#endif
-
 #if OTA_ENABLED
     // OTA member variables
     bool _ota_cap;
@@ -110,7 +127,6 @@ class ArduinoIoTCloudNotecard : public ArduinoIoTCloudClass
 
     State handle_ConnectPhy();
     State handle_SyncTime();
-    State handle_ConfigureNotehub();
     State handle_Connected();
     State handle_Disconnect();
 
@@ -137,4 +153,4 @@ class ArduinoIoTCloudNotecard : public ArduinoIoTCloudClass
 
 extern ArduinoIoTCloudNotecard ArduinoCloud;
 
-#endif
+#endif // ARDUINO_IOT_CLOUD_NOTECARD_H