Merge pull request #874 from adafruit/v1-esp8266-build-sz

Reduce firmware size on ESP8266

Author: tyeth

Doxyfile

@@ -2034,7 +2034,7 @@ ENABLE_PREPROCESSING   = YES
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-MACRO_EXPANSION        = NO
+MACRO_EXPANSION        = YES
 
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
 # the macro expansion is limited to the macros specified with the PREDEFINED and
@@ -2074,7 +2074,7 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = __cdecl=, ARDUINO_ARCH_ESP32=1, ARDUINO_FUNHOUSE_ESP32S2=1
+PREDEFINED             = __cdecl=, ARDUINO_ARCH_ESP32=1, ARDUINO_FUNHOUSE_ESP32S2=1, PROGMEM=
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

examples/Wippersnapper_demo/Wippersnapper_demo.ino

@@ -26,6 +26,7 @@ void setup() {
   Serial.begin(115200);
   //while (!Serial) delay(10);
 
+
   wipper.connect();
 
 }

library.properties

@@ -1,5 +1,5 @@
 name=Adafruit WipperSnapper
-version=1.0.0-beta.123
+version=1.0.0-beta.124
 author=Adafruit
 maintainer=Adafruit <adafruitio@adafruit.com>
 sentence=Arduino application for Adafruit.io WipperSnapper

platformio.ini

@@ -508,12 +508,11 @@ build_flags =
     -DSSL_ALL
     -DMMU_3232
     -DNON32XFER_FAST
-    -DDEBUG_DISABLED
-    -DDEBUG_LEVEL_NONE
+    -DDEBUG_ENABLED
+    -DDEBUG_LEVEL_CORE
     -DPIO_FRAMEWORK_ARDUINO_MMU_CACHE16_IRAM48 ; avoid section `.text1' will not fit in region `iram1_0_seg'
 board_build.eesz=4M2M
 board_build.filesystem = littlefs
-upload_port = COM19
 
 ; SAMD51 Boards ;
 

src/Wippersnapper.cpp

@@ -116,8 +116,10 @@ void Wippersnapper::provision() {
 #else
   set_user_key(); // non-fs-backed, sets global credentials within network iface
 #endif
+
   // Set the status pixel's brightness
   setStatusLEDBrightness(WS._config.status_pixel_brightness);
+
   // Set device's wireless credentials
   set_ssid_pass();
 }
@@ -405,7 +407,7 @@ bool cbSignalMsg(pb_istream_t *stream, const pb_field_t *field, void **arg) {
 
   pb_size_t arr_sz = field->array_size;
   WS_DEBUG_PRINT("Sub-messages found: ");
-  WS_DEBUG_PRINTLN(arr_sz);
+  WS_DEBUG_PRINTLNVAR(arr_sz);
 
   if (field->tag ==
       wippersnapper_signal_v1_CreateSignalRequest_pin_configs_tag) {
@@ -492,7 +494,7 @@ bool Wippersnapper::decodeSignalMsg(
 /**************************************************************************/
 void cbSignalTopic(char *data, uint16_t len) {
   WS_DEBUG_PRINTLN("cbSignalTopic: New Msg on Signal Topic");
-  WS_DEBUG_PRINT(len);
+  WS_DEBUG_PRINTVAR(len);
   WS_DEBUG_PRINTLN(" bytes.");
   // zero-out current buffer
   memset(WS._buffer, 0, sizeof(WS._buffer));
@@ -877,7 +879,7 @@ bool cbDecodeSignalRequestI2C(pb_istream_t *stream, const pb_field_t *field,
 /**************************************************************************/
 void cbSignalI2CReq(char *data, uint16_t len) {
   WS_DEBUG_PRINTLN("* NEW MESSAGE [Topic: Signal-I2C]: ");
-  WS_DEBUG_PRINT(len);
+  WS_DEBUG_PRINTVAR(len);
   WS_DEBUG_PRINTLN(" bytes.");
   // zero-out current buffer
   memset(WS._buffer, 0, sizeof(WS._buffer));
@@ -936,11 +938,11 @@ bool cbDecodeServoMsg(pb_istream_t *stream, const pb_field_t *field,
       attached = false;
     } else {
       WS_DEBUG_PRINT("ATTACHED servo w/minPulseWidth: ");
-      WS_DEBUG_PRINT(msgServoAttachReq.min_pulse_width);
+      WS_DEBUG_PRINTVAR(msgServoAttachReq.min_pulse_width);
       WS_DEBUG_PRINT(" uS and maxPulseWidth: ");
-      WS_DEBUG_PRINT(msgServoAttachReq.min_pulse_width);
+      WS_DEBUG_PRINTVAR(msgServoAttachReq.min_pulse_width);
       WS_DEBUG_PRINT("uS on pin: ");
-      WS_DEBUG_PRINTLN(servoPin);
+      WS_DEBUG_PRINTLNVAR(servoPin);
     }
 
     // Create and fill a servo response message
@@ -986,9 +988,9 @@ bool cbDecodeServoMsg(pb_istream_t *stream, const pb_field_t *field,
     char *servoPin = msgServoWriteReq.servo_pin + 1;
 
     WS_DEBUG_PRINT("Writing pulse width of ");
-    WS_DEBUG_PRINT((int)msgServoWriteReq.pulse_width);
+    WS_DEBUG_PRINTVAR((int)msgServoWriteReq.pulse_width);
     WS_DEBUG_PRINT("uS to servo on pin#: ");
-    WS_DEBUG_PRINTLN(servoPin);
+    WS_DEBUG_PRINTLNVAR(servoPin);
     WS._servoComponent->servo_write(atoi(servoPin),
                                     (int)msgServoWriteReq.pulse_width);
   } else if (field->tag ==
@@ -1008,7 +1010,7 @@ bool cbDecodeServoMsg(pb_istream_t *stream, const pb_field_t *field,
     // execute servo detach request
     char *servoPin = msgServoDetachReq.servo_pin + 1;
     WS_DEBUG_PRINT("Detaching servo from pin ");
-    WS_DEBUG_PRINTLN(servoPin);
+    WS_DEBUG_PRINTLNVAR(servoPin);
     WS._servoComponent->servo_detach(atoi(servoPin));
   } else {
     WS_DEBUG_PRINTLN("Unable to decode servo message type!");
@@ -1029,7 +1031,7 @@ bool cbDecodeServoMsg(pb_istream_t *stream, const pb_field_t *field,
 /**************************************************************************/
 void cbServoMsg(char *data, uint16_t len) {
   WS_DEBUG_PRINTLN("* NEW MESSAGE [Topic: Servo]: ");
-  WS_DEBUG_PRINT(len);
+  WS_DEBUG_PRINTVAR(len);
   WS_DEBUG_PRINTLN(" bytes.");
   // zero-out current buffer
   memset(WS._buffer, 0, sizeof(WS._buffer));
@@ -1143,9 +1145,9 @@ bool cbPWMDecodeMsg(pb_istream_t *stream, const pb_field_t *field, void **arg) {
     // execute PWM pin duty cycle write request
     char *pwmPin = msgPWMWriteFreqRequest.pin + 1;
     WS_DEBUG_PRINT("Writing frequency:  ");
-    WS_DEBUG_PRINT(msgPWMWriteFreqRequest.frequency);
+    WS_DEBUG_PRINTVAR(msgPWMWriteFreqRequest.frequency);
     WS_DEBUG_PRINT("Hz to pin ");
-    WS_DEBUG_PRINTLN(atoi(pwmPin));
+    WS_DEBUG_PRINTLNVAR(atoi(pwmPin));
     WS._pwmComponent->writeTone(atoi(pwmPin), msgPWMWriteFreqRequest.frequency);
   } else if (field->tag ==
              wippersnapper_signal_v1_PWMRequest_write_duty_request_tag) {
@@ -1184,7 +1186,7 @@ bool cbPWMDecodeMsg(pb_istream_t *stream, const pb_field_t *field, void **arg) {
 /**************************************************************************/
 void cbPWMMsg(char *data, uint16_t len) {
   WS_DEBUG_PRINTLN("* NEW MESSAGE [Topic: PWM]: ");
-  WS_DEBUG_PRINT(len);
+  WS_DEBUG_PRINTVAR(len);
   WS_DEBUG_PRINTLN(" bytes.");
   // zero-out current buffer
   memset(WS._buffer, 0, sizeof(WS._buffer));
@@ -1271,7 +1273,7 @@ bool cbDecodeDs18x20Msg(pb_istream_t *stream, const pb_field_t *field,
 /**************************************************************************/
 void cbSignalDSReq(char *data, uint16_t len) {
   WS_DEBUG_PRINTLN("* NEW MESSAGE [Topic: Signal-DS]: ");
-  WS_DEBUG_PRINT(len);
+  WS_DEBUG_PRINTVAR(len);
   WS_DEBUG_PRINTLN(" bytes.");
   // zero-out current buffer
   memset(WS._buffer, 0, sizeof(WS._buffer));
@@ -1384,7 +1386,7 @@ bool cbDecodePixelsMsg(pb_istream_t *stream, const pb_field_t *field,
 /**************************************************************************/
 void cbPixelsMsg(char *data, uint16_t len) {
   WS_DEBUG_PRINTLN("* NEW MESSAGE [Topic: Pixels]: ");
-  WS_DEBUG_PRINT(len);
+  WS_DEBUG_PRINTVAR(len);
   WS_DEBUG_PRINTLN(" bytes.");
   // zero-out current buffer
   memset(WS._buffer, 0, sizeof(WS._buffer));
@@ -1509,7 +1511,7 @@ bool cbDecodeUARTMessage(pb_istream_t *stream, const pb_field_t *field,
 /**************************************************************************/
 void cbSignalUARTReq(char *data, uint16_t len) {
   WS_DEBUG_PRINTLN("* NEW MESSAGE on Signal of type UART: ");
-  WS_DEBUG_PRINT(len);
+  WS_DEBUG_PRINTVAR(len);
   WS_DEBUG_PRINTLN(" bytes.");
   // zero-out current buffer
   memset(WS._buffer, 0, sizeof(WS._buffer));
@@ -1627,7 +1629,7 @@ bool cbDecodeDisplayMsg(pb_istream_t *stream, const pb_field_t *field,
 */
 void cbDisplayMessage(char *data, uint16_t len) {
   WS_DEBUG_PRINTLN("* NEW MESSAGE [Topic: Display]: ");
-  WS_DEBUG_PRINT(len);
+  WS_DEBUG_PRINTVAR(len);
   WS_DEBUG_PRINTLN(" bytes.");
   // zero-out current buffer
   memset(WS._buffer, 0, sizeof(WS._buffer));
@@ -1708,7 +1710,7 @@ void cbRegistrationStatus(char *data, uint16_t len) {
 void cbErrorTopic(char *errorData, uint16_t len) {
   (void)len; // marking unused parameter to avoid compiler warning
   WS_DEBUG_PRINT("IO Ban Error: ");
-  WS_DEBUG_PRINTLN(errorData);
+  WS_DEBUG_PRINTLNVAR(errorData);
   // Disconnect client from broker
   WS_DEBUG_PRINT("Disconnecting from MQTT..");
   if (!WS._mqtt->disconnect()) {
@@ -1732,7 +1734,7 @@ void cbErrorTopic(char *errorData, uint16_t len) {
 void cbThrottleTopic(char *throttleData, uint16_t len) {
   (void)len; // marking unused parameter to avoid compiler warning
   WS_DEBUG_PRINT("IO Throttle Error: ");
-  WS_DEBUG_PRINTLN(throttleData);
+  WS_DEBUG_PRINTLNVAR(throttleData);
   char *throttleMessage;
   // Parse out # of seconds from message buffer
   throttleMessage = strtok(throttleData, ",");
@@ -1741,7 +1743,7 @@ void cbThrottleTopic(char *throttleData, uint16_t len) {
   int throttleDuration = atoi(throttleMessage) * 1000;
 
   WS_DEBUG_PRINT("Device is throttled for ");
-  WS_DEBUG_PRINT(throttleDuration);
+  WS_DEBUG_PRINTVAR(throttleDuration);
   WS_DEBUG_PRINTLN("ms and blocking command execution.");
 
   // If throttle duration is less than the keepalive interval, delay for the
@@ -2346,7 +2348,7 @@ bool Wippersnapper::generateWSTopics() {
   _topic_signal_display_sub =
       new Adafruit_MQTT_Subscribe(WS._mqtt, WS._topic_signal_display_brkr, 1);
   WS_DEBUG_PRINTLN("Subscribing to DISPLAY topic: ");
-  WS_DEBUG_PRINTLN(WS._topic_signal_display_brkr);
+  WS_DEBUG_PRINTLNVAR(WS._topic_signal_display_brkr);
   WS._mqtt->subscribe(_topic_signal_display_sub);
   WS_DEBUG_PRINTLN("Subscribed to DISPLAY topic!");
   _topic_signal_display_sub->setCallback(cbDisplayMessage);
@@ -2387,7 +2389,7 @@ bool Wippersnapper::generateWSTopics() {
 /**************************************************************************/
 void Wippersnapper::errorWriteHang(String error) {
   // Print error
-  WS_DEBUG_PRINTLN(error);
+  WS_DEBUG_PRINTLNVAR(error);
 #ifdef USE_TINYUSB
   _fileSystem->writeToBootOut(error.c_str());
   TinyUSBDevice.attach();
@@ -2396,7 +2398,7 @@ void Wippersnapper::errorWriteHang(String error) {
   // Signal and hang forever
   while (1) {
     WS_DEBUG_PRINTLN("ERROR: Halted execution");
-    WS_DEBUG_PRINTLN(error.c_str());
+    WS_DEBUG_PRINTLNVAR(error.c_str());
     WS.feedWDT();
     statusLEDBlink(WS_LED_STATUS_ERROR_RUNTIME);
     delay(1000);
@@ -2451,7 +2453,7 @@ void Wippersnapper::runNetFSM() {
         feedWDT();
         // attempt to connect
         WS_DEBUG_PRINT("Connecting to WiFi (attempt #");
-        WS_DEBUG_PRINT(5 - maxAttempts);
+        WS_DEBUG_PRINTVAR(5 - maxAttempts);
         WS_DEBUG_PRINTLN(")");
         WS_PRINTER.flush();
         feedWDT();
@@ -2477,11 +2479,11 @@ void Wippersnapper::runNetFSM() {
       maxAttempts = 5;
       while (maxAttempts > 0) {
         WS_DEBUG_PRINT("Connecting to AIO MQTT (attempt #");
-        WS_DEBUG_PRINT(5 - maxAttempts);
+        WS_DEBUG_PRINTVAR(5 - maxAttempts);
         WS_DEBUG_PRINTLN(")");
         WS_PRINTER.flush();
         WS_DEBUG_PRINT("WiFi Status: ");
-        WS_DEBUG_PRINTLN(networkStatus());
+        WS_DEBUG_PRINTLNVAR(networkStatus());
         WS_PRINTER.flush();
         feedWDT();
         statusLEDBlink(WS_LED_STATUS_MQTT_CONNECTING);
@@ -2493,8 +2495,8 @@ void Wippersnapper::runNetFSM() {
           break;
         }
         WS_DEBUG_PRINT("MQTT Connection Error: ");
-        WS_DEBUG_PRINTLN(mqttRC);
-        WS_DEBUG_PRINTLN(WS._mqtt->connectErrorString(mqttRC));
+        WS_DEBUG_PRINTLNVAR(mqttRC);
+        WS_DEBUG_PRINTLNVAR(WS._mqtt->connectErrorString(mqttRC));
         WS_DEBUG_PRINTLN(
             "Unable to connect to Adafruit IO MQTT, retrying in 3 seconds...");
         delay(3000);
@@ -2536,9 +2538,9 @@ void Wippersnapper::haltError(String error, ws_led_status_t ledStatusColor,
 
   for (int i = 0;; i++) {
     WS_DEBUG_PRINT("ERROR [WDT RESET IN ");
-    WS_DEBUG_PRINT(seconds_until_reboot - i);
+    WS_DEBUG_PRINTVAR(seconds_until_reboot - i);
     WS_DEBUG_PRINTLN("]: ");
-    WS_DEBUG_PRINTLN(error);
+    WS_DEBUG_PRINTLNVAR(error);
     // let the WDT fail out and reset!
     statusLEDSolid(ledStatusColor);
 #ifndef ARDUINO_ARCH_ESP8266
@@ -2610,7 +2612,7 @@ void Wippersnapper::pingBroker() {
     }
     _prv_ping = millis();
     WS_DEBUG_PRINT("WiFi RSSI: ");
-    WS_DEBUG_PRINTLN(getRSSI());
+    WS_DEBUG_PRINTLNVAR(getRSSI());
   }
   // blink status LED every STATUS_LED_KAT_BLINK_TIME millis
   if (millis() > (_prvKATBlink + STATUS_LED_KAT_BLINK_TIME)) {
@@ -2756,21 +2758,21 @@ void printDeviceInfo() {
   WS_DEBUG_PRINT("Board ID: ");
   WS_DEBUG_PRINTLN(BOARD_ID);
   WS_DEBUG_PRINT("Adafruit.io User: ");
-  WS_DEBUG_PRINTLN(WS._config.aio_user);
+  WS_DEBUG_PRINTLNVAR(WS._config.aio_user);
   if (strncmp(WS._config.aio_url, "io.adafruit.com", 16) != 0) {
     WS_DEBUG_PRINT("Adafruit.io URL: ");
-    WS_DEBUG_PRINTLN(WS._config.aio_url);
+    WS_DEBUG_PRINTLNVAR(WS._config.aio_url);
     WS_DEBUG_PRINT("Adafruit.io Port: ");
-    WS_DEBUG_PRINTLN(WS._config.io_port);
+    WS_DEBUG_PRINTLNVAR(WS._config.io_port);
   }
   WS_DEBUG_PRINT("WiFi Network: ");
-  WS_DEBUG_PRINTLN(WS._config.network.ssid);
+  WS_DEBUG_PRINTLNVAR(WS._config.network.ssid);
 
   char sMAC[18] = {0};
   sprintf(sMAC, "%02X:%02X:%02X:%02X:%02X:%02X", WS._macAddr[0], WS._macAddr[1],
           WS._macAddr[2], WS._macAddr[3], WS._macAddr[4], WS._macAddr[5]);
   WS_DEBUG_PRINT("MAC Address: ");
-  WS_DEBUG_PRINTLN(sMAC);
+  WS_DEBUG_PRINTLNVAR(sMAC);
   WS_DEBUG_PRINTLN("-------------------------------");
 
 // (ESP32-Only) Print reason why device was reset

src/Wippersnapper.h

@@ -48,17 +48,45 @@
 
 // Define actual debug output functions when necessary.
 #ifdef WS_DEBUG
+
+#ifdef ARDUINO_ARCH_ESP8266
+// ESP8266: Use F() macro to store string literals in Flash (PROGMEM) instead
+// of RAM. This saves precious RAM on memory-constrained ESP8266 devices.
+// NOTE: WS_DEBUG_PRINT/PRINTLN only accept string literals on ESP8266.
+// Use WS_DEBUG_PRINTVAR/PRINTLNVAR for variables.
+#define WS_DEBUG_PRINT(x)                                                      \
+  { WS_PRINTER.print(F(x)); } ///< Prints string literal from Flash
+#define WS_DEBUG_PRINTLN(x)                                                    \
+  { WS_PRINTER.println(F(x)); } ///< Prints string literal line from Flash
+#else
+// Other platforms: Standard variadic macros
 #define WS_DEBUG_PRINT(...)                                                    \
   { WS_PRINTER.print(__VA_ARGS__); } ///< Prints debug output.
 #define WS_DEBUG_PRINTLN(...)                                                  \
   { WS_PRINTER.println(__VA_ARGS__); } ///< Prints line from debug output.
+#endif
+
+// Variable printing macros - use for non-string-literal arguments
+#define WS_DEBUG_PRINTVAR(...)                                                 \
+  { WS_PRINTER.print(__VA_ARGS__); } ///< Prints variable (any type)
+#define WS_DEBUG_PRINTLNVAR(...)                                               \
+  { WS_PRINTER.println(__VA_ARGS__); } ///< Prints variable with newline
 #define WS_DEBUG_PRINTHEX(...)                                                 \
-  { WS_PRINTER.print(__VA_ARGS__, HEX); } ///< Prints debug output.
+  { WS_PRINTER.print(__VA_ARGS__, HEX); } ///< Prints in hexadecimal
+
 #else
 #define WS_DEBUG_PRINT(...)                                                    \
-  {} ///< Prints debug output
+  {} ///< Disabled debug output
 #define WS_DEBUG_PRINTLN(...)                                                  \
-  {} ///< Prints line from debug output.
+  {} ///< Disabled debug output
+#define WS_DEBUG_PRINTVAR(...)                                                 \
+  {} ///< Disabled debug output
+#define WS_DEBUG_PRINTLNVAR(...)                                               \
+  {} ///< Disabled debug output
+#define WS_DEBUG_PRINTHEX(...)                                                 \
+  {} ///< Disabled debug output
+#define WS_DEBUG_HEAP(label)                                                   \
+  {} ///< Disabled heap debug output
 #endif
 
 #define WS_DELAY_WITH_WDT(timeout)                                             \
@@ -139,7 +167,7 @@
 #endif
 
 #define WS_VERSION                                                             \
-  "1.0.0-beta.122" ///< WipperSnapper app. version (semver-formatted)
+  "1.0.0-beta.124" ///< WipperSnapper app. version (semver-formatted)
 
 // Reserved Adafruit IO MQTT topics
 #define TOPIC_IO_THROTTLE "/throttle" ///< Adafruit IO Throttle MQTT Topic