[SD] Refactor and make pins dynaically allocated for sdcard

Author: brentru

src/Wippersnapper_Boards.h

@@ -58,7 +58,6 @@
 #define STATUS_NEOPIXEL_PIN 46
 #define STATUS_NEOPIXEL_NUM 1
 #define USE_PSRAM ///< Board has PSRAM, use it for dynamic memory allocation
-#define SD_CS_PIN SS
 #elif defined(ARDUINO_MAGTAG29_ESP32S2)
 #define BOARD_ID "magtag"
 #define USE_TINYUSB
@@ -72,7 +71,6 @@
 #define USE_STATUS_NEOPIXEL
 #define STATUS_NEOPIXEL_PIN 33
 #define STATUS_NEOPIXEL_NUM 1
-#define SD_CS_PIN 33
 #define USE_PSRAM ///< Board has PSRAM, use it for dynamic memory allocation
 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S2_TFT)
 #define BOARD_ID "feather-esp32s2-tft"
@@ -81,69 +79,59 @@
 #define STATUS_NEOPIXEL_PIN 33
 #define STATUS_NEOPIXEL_NUM 1
 #define PIN_I2C_POWER_INVERTED 7
-#define SD_CS_PIN 33
 #define USE_PSRAM ///< Board has PSRAM, use it for dynamic memory allocation
 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S2_REVTFT)
 #define BOARD_ID "feather-esp32s2-reverse-tft"
 #define USE_TINYUSB
 #define USE_STATUS_NEOPIXEL
 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
 #define STATUS_NEOPIXEL_NUM NEOPIXEL_NUM
-#define SD_CS_PIN 33
 #define USE_PSRAM ///< Board has PSRAM, use it for dynamic memory allocation
 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S3_NOPSRAM)
 #define BOARD_ID "feather-esp32s3"
 #define USE_TINYUSB
 #define USE_STATUS_NEOPIXEL
 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
 #define STATUS_NEOPIXEL_NUM NEOPIXEL_NUM
-#define SD_CS_PIN 33
 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S3)
 #define BOARD_ID "feather-esp32s3-4mbflash-2mbpsram"
 #define USE_TINYUSB
 #define USE_STATUS_NEOPIXEL
 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
 #define STATUS_NEOPIXEL_NUM NEOPIXEL_NUM
-#define SD_CS_PIN 33
 #define USE_PSRAM ///< Board has PSRAM, use it for dynamic memory allocation
 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S3_TFT)
 #define BOARD_ID "feather-esp32s3-tft"
 #define USE_TINYUSB
 #define USE_STATUS_NEOPIXEL
 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
 #define STATUS_NEOPIXEL_NUM NEOPIXEL_NUM
-#define SD_CS_PIN 33
 #define USE_PSRAM ///< Board has PSRAM, use it for dynamic memory allocation
 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S3_REVTFT)
 #define BOARD_ID "feather-esp32s3-reverse-tft"
 #define USE_TINYUSB
 #define USE_STATUS_NEOPIXEL
 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
 #define STATUS_NEOPIXEL_NUM NEOPIXEL_NUM
-#define SD_CS_PIN 33
 #define USE_PSRAM ///< Board has PSRAM, use it for dynamic memory allocation
 #elif defined(ARDUINO_ADAFRUIT_QTPY_ESP32S2)
 #define BOARD_ID "qtpy-esp32s2"
 #define USE_TINYUSB
 #define USE_STATUS_NEOPIXEL
 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
 #define STATUS_NEOPIXEL_NUM 1
-#define SD_CS_PIN 33
 #define USE_PSRAM ///< Board has PSRAM, use it for dynamic memory allocation
 #elif defined(ARDUINO_ADAFRUIT_QTPY_ESP32S3_NOPSRAM)
 #define BOARD_ID "qtpy-esp32s3"
 #define USE_TINYUSB
 #define USE_STATUS_NEOPIXEL
 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
-#define STATUS_NEOPIXEL_NUM 1
-#define SD_CS_PIN 33
 #elif defined(ARDUINO_ADAFRUIT_QTPY_ESP32S3_N4R2)
 #define BOARD_ID "qtpy-esp32s3-n4r2"
 #define USE_TINYUSB
 #define USE_STATUS_NEOPIXEL
 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
 #define STATUS_NEOPIXEL_NUM 1
-#define SD_CS_PIN 33
 #define USE_PSRAM ///< Board has PSRAM, use it for dynamic memory allocation
 #elif defined(ARDUINO_ADAFRUIT_QTPY_ESP32C3)
 #define BOARD_ID "qtpy-esp32c3"
@@ -156,41 +144,35 @@
 #define USE_LITTLEFS
 #define USE_STATUS_LED
 #define STATUS_LED_PIN 0
-#define SD_CS_PIN 15
 #elif defined(ARDUINO_ADAFRUIT_ITSYBITSY_ESP32)
 #define BOARD_ID "itsybitsy-esp32"
 #define USE_LITTLEFS
 #define USE_STATUS_NEOPIXEL
 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
 #define STATUS_NEOPIXEL_NUM 1
-#define SD_CS_PIN 33
 #define USE_PSRAM ///< Board has PSRAM, use it for dynamic memory allocation
 #elif defined(ARDUINO_FEATHER_ESP32)
 #define BOARD_ID "feather-esp32"
 #define USE_LITTLEFS
 #define USE_STATUS_LED
 #define STATUS_LED_PIN 13
-#define SD_CS_PIN 33
 #elif defined(ARDUINO_ESP32_DEV) || defined(ESP32_DEV)
 #define BOARD_ID "feather-esp32"
 #define USE_STATUS_LED
 #define STATUS_LED_PIN 13
-#define SD_CS_PIN 15
 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32_V2)
 #define BOARD_ID "feather-esp32-v2"
 #define USE_LITTLEFS
 #define USE_STATUS_NEOPIXEL
 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
 #define STATUS_NEOPIXEL_NUM 1
-#define SD_CS_PIN 33
 #define USE_PSRAM ///< Board has PSRAM, use it for dynamic memory allocation
 #elif defined(ARDUINO_ADAFRUIT_QTPY_ESP32_PICO)
 #define BOARD_ID "qtpy-esp32"
 #define USE_LITTLEFS
 #define USE_STATUS_NEOPIXEL
 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
 #define STATUS_NEOPIXEL_NUM 1
-#define SD_CS_PIN 33
 #define USE_PSRAM ///< Board has PSRAM, use it for dynamic memory allocation
 #elif defined(ARDUINO_SAMD_NANO_33_IOT)
 #define BOARD_ID "nano-33-iot"
@@ -205,13 +187,11 @@
 #define USE_TINYUSB
 #define USE_STATUS_LED
 #define STATUS_LED_PIN 32
-#define SD_CS_PIN 17
 #elif defined(ARDUINO_RASPBERRY_PI_PICO_2)
 #define BOARD_ID "rpi-pico-2"
 #define USE_TINYUSB
 #define USE_STATUS_LED
 #define STATUS_LED_PIN LED_BUILTIN
-#define SD_CS_PIN 17
 #else
 #warning "Board type not identified within Wippersnapper_Boards.h!"
 #endif

src/Wippersnapper_V2.cpp

@@ -23,7 +23,7 @@
  *
  * @section author Author
  *
- * Copyright (c) Brent Rubell 2020-2023 for Adafruit Industries.
+ * Copyright (c) Brent Rubell 2020-2025 for Adafruit Industries.
  *
  * @section license License
  *
@@ -105,6 +105,7 @@ void Wippersnapper_V2::provisionV2() {
 #endif
 
   // Are we using sd-card/offline mode?
+  WsV2._fileSystemV2->GetSDCSPin(); // TODO: Implement this for LittleFS TOO
   if (WsV2._sdCardV2->InitSDCard())
     return;
 

src/Wippersnapper_V2.h

@@ -255,6 +255,9 @@ class Wippersnapper_V2 {
                              ///< otherwise.
   std::vector<std::vector<uint8_t>>
       _sharedConfigBuffers; ///< Shared JSON config buffers for offline mode
+
+
+  uint8_t pin_sd_cs; ///< SD card chip select pin  
 private:
   void _initV2();
 
@@ -268,7 +271,6 @@ class Wippersnapper_V2 {
   Adafruit_MQTT_Subscribe *_subscribeB2d;
   Adafruit_MQTT_Subscribe *_subscribeError;
   Adafruit_MQTT_Subscribe *_subscribeThrottle;
-
 protected:
   ws_status_t _statusV2 = WS_IDLE; ///< Wippersnapper status
 

src/provisioning/sdcard/ws_sdcard.cpp

@@ -20,12 +20,6 @@
 */
 /**************************************************************************/
 ws_sdcard::ws_sdcard() {
-  is_mode_offline = false;
-#ifdef OFFLINE_MODE_WOKWI
-  _is_using_wokwi = true;
-#else
-  _is_using_wokwi = false;
-#endif
   _use_test_data = false;
   _sz_log_file = 0;
 }
@@ -43,12 +37,13 @@ ws_sdcard::~ws_sdcard() {
 }
 
 bool ws_sdcard::InitSDCard() {
-#ifdef SD_CS_PIN
-  // Attempt to initialize the SD card
-  if (_sd.begin(SD_CS_PIN)) {
-    is_mode_offline = true;
+  is_mode_offline = false;
+  if (WsV2.pin_sd_cs == 255) { // No SD card CS pin defined
+    return is_mode_offline;
+  } else { // SD card CS pin defined
+    if (_sd.begin(WsV2.pin_sd_cs))
+      is_mode_offline = true;
   }
-#endif
   return is_mode_offline;
 }
 
@@ -504,19 +499,12 @@ bool ws_sdcard::parseConfigFile() {
   WS_DEBUG_PRINTLN("[SD] Successfully deserialized JSON config file!");
 
   // Calculate the 8-bit checksum of the JSON file to ensure it is valid data
-  if (! ValidateChecksum(doc)) {
-    WS_DEBUG_PRINTLN("[SD] Checksum mismatch, file has been modified from its original state!");
+  if (!ValidateChecksum(doc)) {
+    WS_DEBUG_PRINTLN("[SD] Checksum mismatch, file has been modified from its "
+                     "original state!");
   }
   WS_DEBUG_PRINTLN("[SD] JSON checksum OK!");
 
-  // NOTE: This is only used by the CI runner, production builds do not run
-  // this!
-  // TODO: Do we even need this anymore? We switched to a compile-time constant instead
-  const char *exportedBy = doc["exportedBy"];
-  if (strcmp(exportedBy, "wokwi") == 0) {
-    _is_using_wokwi = true;
-  }
-
   // Parse the exportedFromDevice array
   JsonObject exportedFromDevice = doc["exportedFromDevice"];
   if (exportedFromDevice.isNull()) {
@@ -788,7 +776,8 @@ bool ws_sdcard::LogJSONDoc(JsonDocument &doc) {
   File32 file;
   file = _sd.open(_log_filename, FILE_WRITE);
   if (!file) {
-    WS_DEBUG_PRINTLN("[SD] FATAL Error - Unable to open the log file for writing!");
+    WS_DEBUG_PRINTLN(
+        "[SD] FATAL Error - Unable to open the log file for writing!");
     return false;
   }
   BufferingPrint bufferedFile(file, 64); // Add buffering to the file
@@ -936,13 +925,6 @@ bool ws_sdcard::waitForSerialConfig() {
   // 2. Provide a JSON string via the hardware's serial input
   // 3. Use a test JSON string - for debugging purposes ONLY
 
-  // TODO: Redundant conditional - should this just be enabled within the class
-  // ctor?
-  if (_is_using_wokwi)
-    _use_test_data = false;
-  else
-    _use_test_data = true;
-
   json_test_data = "{"
                    "\"exportVersion\": \"1.0.0\","
                    "\"exportedBy\": \"tester\","

src/provisioning/sdcard/ws_sdcard.h

@@ -57,14 +57,12 @@ class ws_sdcard {
   bool ValidateJSONKey(const char *key, const char *error_msg);
   void CheckIn(uint8_t max_digital_pins, uint8_t max_analog_pins,
                float ref_voltage);
-
   bool ConfigureRTC(const char *rtc_type);
   uint32_t GetTimestamp();
   bool InitDS1307();
   bool InitDS3231();
   bool InitPCF8523();
   bool InitSoftRTC();
-
   wippersnapper_sensor_SensorType ParseSensorType(const char *sensor_type);
   bool ParseDigitalIOAdd(wippersnapper_digitalio_DigitalIOAdd &msg_DigitalIOAdd,
                          const char *pin, float period, bool value,
@@ -76,15 +74,13 @@ class ws_sdcard {
                        const char *pin, int resolution, float period,
                        int num_sensors, const char *sensor_type_1,
                        const char *sensor_type_2);
-
   void BuildJSONDoc(JsonDocument &doc, uint8_t pin, float value,
                     wippersnapper_sensor_SensorType read_type);
   void BuildJSONDoc(JsonDocument &doc, uint8_t pin, uint16_t value,
                     wippersnapper_sensor_SensorType read_type);
   void BuildJSONDoc(JsonDocument &doc, uint8_t pin, bool value,
                     wippersnapper_sensor_SensorType read_type);
   bool LogJSONDoc(JsonDocument &doc);
-
   bool
   PushSignalToSharedBuffer(wippersnapper_signal_BrokerToDevice &msg_signal);
   SdFat _sd;            ///< SD object from Adafruit SDFat library
@@ -97,9 +93,7 @@ class ws_sdcard {
   RTC_DS1307 *_rtc_ds1307 = nullptr; ///< DS1307 RTC object
   RTC_PCF8523 *_rtc_pcf8523 = nullptr; ///< PCF8523 RTC object
   RTC_Millis *_rtc_soft = nullptr;     ///< Software RTC object
-  // Testing
-  bool _use_test_data;  ///< True if sample data is being used for testing
-  bool _is_using_wokwi; ///< True if `exportedBy` key is "wokwi"
+  bool _use_test_data; ///< True if sample data is being used for testing
 };
 extern Wippersnapper_V2 WsV2;
 #endif // WS_SDCARD_H

src/provisioning/tinyusb/Wippersnapper_FS_V2.cpp

@@ -162,6 +162,24 @@ Wippersnapper_FS_V2::~Wippersnapper_FS_V2() {
   wipperFatFs_v2.end();
 }
 
+void GetSDCSPin() { 
+  File32 file_cfg = wipperFatFs_v2.open("/config.json");
+  if (!file_cfg) {
+    WsV2.pin_sd_cs = 255;
+    return;
+  }
+  DeserializationError error = deserializeJson(doc, file_cfg);
+  // failed to deserialize the config file, bail out
+  if (error) {
+    file_cfg.close();
+    WsV2.pin_sd_cs = 255;
+    return;
+  }
+  JsonObject exportedFromDevice = doc["exportedFromDevice"];
+  WsV2.pin_sd_cs = exportedFromDevice["sd_cs_pin"] | 255;
+  file_cfg.close();
+}
+
 /**************************************************************************/
 /*!
     @brief    Writes files to the filesystem to disable macOS from indexing.

src/provisioning/tinyusb/Wippersnapper_FS_V2.h

@@ -59,6 +59,8 @@ class Wippersnapper_FS_V2 {
   bool getSecretsFile();
   void parseSecrets();
 
+  void GetSDCSPin();
+
 #ifdef ARDUINO_FUNHOUSE_ESP32S2
   void parseDisplayConfig(displayConfig &displayFile);
   void createDisplayConfig();