Merge branch 'develop' into MCU8MASS-512-513-changelog-version

Author: M68426

CHANGELOG.md

@@ -47,6 +47,13 @@
 * Split HTTP example into a HTTP and HTTPS example 
 * Add a log message when HTTPS security profile is not set up
 * Update library.properties to pass lint checks for PR with library-registry 
+* Improve error messages for MQTT
+
+## Changes 
+
+* Use Arduino interrupt system so that the library doesn't hijack interrupt service routines used by other libraries 
+* Change sandbox application to use increased MQTT Quality of Service in order to not lose received messages
+* Remove MqttClient.disconnect() (full functionality given in MqttClient.end())
 
 ## Bugfixes
 

examples/mqtt_polling/mqtt_polling.ino

@@ -69,7 +69,7 @@ void loop() {
     String message = MqttClient.readMessage(MQTT_SUB_TOPIC);
 
     // Read message will return an empty string if there were no new
-    // messages, so anything other than that means that there were a new
+    // messages, so anything other than that means that there was a new
     // message
     if (message != "") {
         Log.infof("Got new message: %s\r\n", message.c_str());
@@ -87,5 +87,5 @@ void loop() {
         Log.error("Failed to publish");
     }
 
-    delay(1000);
+    delay(5000);
 }

examples/power_down/power_down.ino

@@ -18,7 +18,7 @@
 
 #define SW0 PIN_PD2
 
-ISR(PORTD_PORT_vect) {
+void buttonPressedInterrupt(void) {
     if (PORTD.INTFLAGS & PIN2_bm) {
         // Reset the interupt flag so that we can process the next incoming
         // interrupt
@@ -35,6 +35,7 @@ void setup() {
     // Configure SW0 for interrupt so we can wake the device up from sleep by
     // pressing the button
     pinConfigure(SW0, PIN_DIR_INPUT | PIN_INT_FALL);
+    attachInterrupt(SW0, buttonPressedInterrupt, FALLING);
 
     // Now we configure the low power module for power down configuration, where
     // the LTE modem and the CPU will be powered down

examples/power_save/power_save.ino

@@ -19,7 +19,7 @@
 
 #define SW0 PIN_PD2
 
-ISR(PORTD_PORT_vect) {
+void buttonPressedInterrupt(void) {
     if (PORTD.INTFLAGS & PIN2_bm) {
         PORTD.INTFLAGS = PIN2_bm;
     }
@@ -34,6 +34,7 @@ void setup() {
     // Configure SW0 for interrupt so we can wake the device up from sleep by
     // pressing the button
     pinConfigure(SW0, PIN_DIR_INPUT | PIN_INT_FALL);
+    attachInterrupt(SW0, buttonPressedInterrupt, FALLING);
 
     // Now we configure the power save configuration. Note that this has to be
     // done before calling Lte.begin().

examples/sandbox/sandbox.ino

@@ -34,6 +34,10 @@
 #define START_PUBLISHING_SENSOR_DATA_FLAG (1 << 6)
 #define SEND_SENSOR_DATA_FLAG             (1 << 7)
 
+// Allow 32 messsages in flight
+#define RECEIVE_MESSAGE_ID_BUFFER_SIZE 32
+#define RECEIVE_MESSAGE_ID_BUFFER_MASK (RECEIVE_MESSAGE_ID_BUFFER_SIZE - 1)
+
 typedef enum {
     NOT_CONNECTED,
     CONNECTED_TO_NETWORK,
@@ -55,7 +59,12 @@ static volatile uint16_t target_seconds = 0;
 static volatile uint16_t data_frequency = 0;
 static unsigned long last_data_time = 0;
 
-static volatile uint16_t awaiting_messages = 0;
+/**
+ * @brief Circular buffer for the message identifiers of the received messages.
+ */
+static uint32_t received_message_identifiers[RECEIVE_MESSAGE_ID_BUFFER_SIZE];
+static volatile uint8_t received_message_identifiers_head = 0;
+static volatile uint8_t received_message_identifiers_tail = 0;
 
 static const char heartbeat_message[] = "{\"type\": \"heartbeat\"}";
 
@@ -71,15 +80,14 @@ ISR(TCA0_OVF_vect) {
     TCA0.SINGLE.INTFLAGS = TCA_SINGLE_OVF_bm;
 }
 
-ISR(PORTD_PORT_vect) {
+void sendHeartbeatInterrupt(void) {
     if (PORTD.INTFLAGS & PIN2_bm) {
-
         event_flags |= SEND_HEARTBEAT_FLAG;
         PORTD.INTFLAGS = PIN2_bm;
     }
 }
 
-ISR(PORTF_PORT_vect) {
+void resetInterrupt(void) {
     if (PORTF.INTFLAGS & PIN6_bm) {
         asm("jmp 0");
         PORTF.INTFLAGS = PIN6_bm;
@@ -93,7 +101,12 @@ void disconnectedFromBroker(void) { event_flags |= BROKER_DISCONN_FLAG; }
 void receivedMessage(const char *topic,
                      const uint16_t msg_length,
                      const int32_t msg_id) {
-    awaiting_messages++;
+
+    received_message_identifiers_head =
+        (received_message_identifiers_head + 1) &
+        RECEIVE_MESSAGE_ID_BUFFER_MASK;
+
+    received_message_identifiers[received_message_identifiers_head] = msg_id;
 }
 
 void connectMqtt() {
@@ -272,9 +285,11 @@ void setup() {
 
     // Set PD2 as input (button)
     pinConfigure(PIN_PD2, PIN_DIR_INPUT | PIN_INT_FALL);
+    attachInterrupt(PIN_PD2, sendHeartbeatInterrupt, FALLING);
 
     // Set PF6 as input (reset button)
     pinConfigure(PIN_PF6, PIN_DIR_INPUT | PIN_INT_FALL);
+    attachInterrupt(PIN_PF6, resetInterrupt, FALLING);
 
     sei();
 
@@ -317,6 +332,7 @@ void setup() {
     delay(500);
     while (!SequansController.retryCommand(
         "AT+SQNSPCFG=1,2,\"0xC02B\",1,19,0,0,\"\",\"\",1,0,0")) {}
+
     // - Patch end -
 
     connectLTE();
@@ -372,7 +388,7 @@ void loop() {
 
             Log.info("Connected to MQTT broker, subscribing to topics!\r\n");
 
-            MqttClient.subscribe(mqtt_sub_topic);
+            MqttClient.subscribe(mqtt_sub_topic, AT_LEAST_ONCE);
 
             break;
         default:
@@ -409,34 +425,34 @@ void loop() {
         }
 
         event_flags &= ~BROKER_DISCONN_FLAG;
-    } else if (awaiting_messages > 0) {
+    } else if (received_message_identifiers_head !=
+               received_message_identifiers_tail) {
 
         switch (state) {
         case CONNECTED_TO_BROKER:
         case STREAMING_DATA: {
 
             char message[400] = "";
 
-            const bool message_read_successfully = MqttClient.readMessage(
-                mqtt_sub_topic, (uint8_t *)message, sizeof(message));
+            cli();
+            received_message_identifiers_tail =
+                (received_message_identifiers_tail + 1) &
+                RECEIVE_MESSAGE_ID_BUFFER_MASK;
+
+            const uint32_t message_id =
+                received_message_identifiers[received_message_identifiers_tail];
+            sei();
 
-            awaiting_messages--;
+            const bool message_read_successfully =
+                MqttClient.readMessage(mqtt_sub_topic,
+                                       (uint8_t *)message,
+                                       sizeof(message),
+                                       message_id);
 
             if (message_read_successfully) {
                 decodeMessage(message);
             } else {
                 Log.error("Failed to read message\r\n");
-
-                // In case we lost some messages, we clear them out from the
-                // Sequans Modem such that the memory is freed
-                if (awaiting_messages > 0) {
-                    Log.errorf("Lost %d message(s) due to messages coming in "
-                               "too quickly to process\r\n",
-                               awaiting_messages);
-
-                    MqttClient.clearMessages(mqtt_sub_topic, awaiting_messages);
-                    awaiting_messages = 0;
-                }
             }
 
         } break;
@@ -513,7 +529,7 @@ void loop() {
                     Veml3328.getRed());
 
             if (!MqttClient.publish(mqtt_pub_topic, transmit_buffer)) {
-                Log.errorf("Could not publish message: %s\r\n",
+                Log.errorf("Failed to publish message: %s\r\n",
                            transmit_buffer);
             }
 

src/lte.cpp

@@ -71,7 +71,7 @@ static void connectionStatus(char *buffer) {
 
             // The modem does not give any notification of a MQTT disconnect.
             // This must be called directly following a connection loss
-            MqttClient.disconnect(true);
+            MqttClient.end();
 
             if (disconnected_callback != NULL) {
                 disconnected_callback();
@@ -98,8 +98,8 @@ bool LteClass::begin(const bool print_messages) {
     if (!SequansController.isInitialized()) {
         SequansController.begin();
 
-        // Allow 50ms for boot
-        delay(50);
+        // Allow 2s for boot, we have to wait until the SYSSTART URC arrives
+        delay(2000);
     }
 
     SequansController.clearReceiveBuffer();
@@ -119,16 +119,12 @@ bool LteClass::begin(const bool print_messages) {
     // Clear receive buffer before querying the SIM card
     SequansController.clearReceiveBuffer();
 
-    // We check that the SIM card is inserted and ready. Note that we can only
-    // do this and get a meaningful response in CFUN=1 or CFUN=4.
-    SequansController.retryCommand(AT_COMMAND_CHECK_SIM);
-
     char response[32] = "";
 
-    ResponseResult result =
-        SequansController.readResponse(response, sizeof(response));
-
-    if (result != ResponseResult::OK) {
+    // We check that the SIM card is inserted and ready. Note that we can only
+    // do this and get a meaningful response in CFUN=1 or CFUN=4.
+    if (!SequansController.retryCommand(
+            AT_COMMAND_CHECK_SIM, response, sizeof(response))) {
         Log.error("Checking SIM status failed, is the SIM card inserted?");
         SequansController.retryCommand(AT_COMMAND_DISCONNECT);
         return false;
@@ -175,13 +171,10 @@ bool LteClass::begin(const bool print_messages) {
     delay(500);
 
     SequansController.clearReceiveBuffer();
-    SequansController.retryCommand(AT_COMMAND_GET_CLOCK);
-
     char clock_response[48] = "";
-    result =
-        SequansController.readResponse(clock_response, sizeof(clock_response));
 
-    if (result != ResponseResult::OK) {
+    if (!SequansController.retryCommand(
+            AT_COMMAND_GET_CLOCK, clock_response, sizeof(clock_response))) {
         Log.errorf("Retrieving LTE modem time failed");
         SequansController.retryCommand(AT_COMMAND_DISCONNECT);
         return false;