squashed updates

Author: PilnyTomas

libraries/SD/examples/SD_Test/SD_Test.ino

@@ -19,8 +19,8 @@
  *                  |                                  █/
  *                  |__▍___▊___█___█___█___█___█___█___/
  *
- * Note:  that SPI pins can be configured by using `SPI.begin(sck, miso, mosi, cs);`
- *        alternatively you can change only the CS pin with `SD.begin(CSpin)`
+ * Note:  The SPI pins can be manually configured by using `SPI.begin(sck, miso, mosi, cs).`
+ *        Alternatively, you can change the CS pin and use the other default settings by using `SD.begin(cs)`.
  *
  * +--------------+---------+-------+----------+----------+----------+
  * | SPI Pin Name | ESP8266 | ESP32 | ESP32-S2 | ESP32-C3 | ESP32-S3 |
@@ -43,7 +43,7 @@
 #include "SPI.h"
 
 /*
-Uncomment and setup pins you want to use for the SPI communication
+Uncomment and set up if you want to use custom pins for the SPI communication
 #define REASSIGN_PINS
 int sck = -1;
 int miso = -1;

libraries/SD/examples/SD_time/SD_time.ino

@@ -19,8 +19,8 @@
  *                  |                                  █/
  *                  |__▍___▊___█___█___█___█___█___█___/
  *
- * Note:  that SPI pins can be configured by using `SPI.begin(sck, miso, mosi, cs);`
- *        alternatively you can change only the CS pin with `SD.begin(CSpin)`
+ * Note:  The SPI pins can be manually configured by using `SPI.begin(sck, miso, mosi, cs);`.
+ *        Alternatively you can change only the CS pin with `SD.begin(CSpin)` and keep the default settings for other pins.
  *
  * +--------------+---------+-------+----------+----------+----------+
  * | SPI Pin Name | ESP8266 | ESP32 | ESP32-S2 | ESP32-C3 | ESP32-S3 |

libraries/SD_MMC/examples/SDMMC_Test/SDMMC_Test.ino

@@ -21,8 +21,8 @@
  * SD pin number    |  8   7   6   5   4   3   2   1   9 /
  *                  |                                  █/
  *                  |__▍___▊___█___█___█___█___█___█___/
- * WARNING: ALL data pins must be pulled up to 3.3V with external 10k Ohm resistor!
- * Note to ESP32 pin 2 (D0) : add 1K pull up after flashing
+ * WARNING: ALL data pins must be pulled up to 3.3V with an external 10k Ohm resistor!
+ * Note to ESP32 pin 2 (D0): Add a 1K Ohm pull-up resistor to 3.3V after flashing
  *
  * For more info see file README.md in this library or on URL:
  * https://github.com/espressif/arduino-esp32/tree/master/libraries/SD_MMC
@@ -32,24 +32,24 @@
 #include "SD_MMC.h"
 
 // Default pins for ESP-S3
-// Warning: ESP32-S3-WROOM-2 is using most of the default SD_MMC GPIOs (33-37) to interface with on-board OPI flash.
-//   If the SD_MMC is initialized with default pins it will result in rebooting loop - please
-//   reassign the pins elsewhere using the mentioned command `setPins`.
+// Warning: ESP32-S3-WROOM-2 is using most of the default SD_MMC GPIOs (33-37) to interface with the on-board OPI flash.
+//   If the SD_MMC is initialized with the default pins it will result in rebooting loop.
+//   Please reassign the pins elsewhere using the mentioned command `setPins`.
 // Note: ESP32-S3-WROOM-1 does not have GPIO 33 and 34 broken out.
-// Note: The board SP32-S3-USB-OTG has predefined default pins and the following definitions with the setPins() call will not be compiled.
+// Note: The board ESP32-S3-USB-OTG has predefined default pins and the following definitions with the setPins() call will not be compiled.
 // Note: Pins in this definition block are ordered from top down in order in which they are on the full-sized SD card
-//       from left to right when facing the pins down (when connected to a breadboard)
+//   from left to right when facing the pins down (when connected to a breadboard)
 
 #if defined(SOC_SDMMC_USE_GPIO_MATRIX) && not defined(BOARD_HAS_SDMMC)
-    int d1  = 21; // SD pin 8 - add 10k Pullup to 3.3V if using 4-bit mode (use_1_bit_mode = false)
-    int d0  = 47; // SD pin 7 - add 10k Pullup
+    int d1  = 21; // SD pin 8 - Add a 10k Ohm pull-up resistor to 3.3V if using 4-bit mode (use_1_bit_mode = false)
+    int d0  = 47; // SD pin 7 - Add a 10k Ohm pull-up resistor to 3.3V
     //     GND pin - SD pin 6
-    int clk = 39; // SD pin 5 - add 10k Pullup
+    int clk = 39; // SD pin 5 - Add a 10k Ohm pull-up resistor to 3.3V
     //    3.3V pin - SD pin 4
     //     GND pin - SD pin 3
-    int cmd = 40; // SD pin 2 - add 10k Pullup
-    int d3  = 41; // SD pin 1 - add 10k Pullup to card's pin even when using 1-bit mode
-    int d2  = 42; // SD pin 9 - add 10k Pullup to 3.3V if using 4-bit mode (use_1_bit_mode = false)
+    int cmd = 40; // SD pin 2 - Add a 10k Ohm pull-up resistor to 3.3V
+    int d3  = 41; // SD pin 1 - Add a 10k Ohm pull-up resistor to 3.3V to card's pin even when using 1-bit mode
+    int d2  = 42; // SD pin 9 - Add a 10k Ohm pull-up resistor to 3.3V if using 4-bit mode (use_1_bit_mode = false)
 #endif
 
 bool use_1_bit_mode = false; // Change the value to `true` to use 1-bit mode instead of the 4-bit mode
@@ -214,9 +214,9 @@ void setup(){
     Serial.println("SDMMC_Test.ino starting!");
 
     // If you are using any other ESP32-S3 board than ESP32-S3-USB-OTG which has preset default pins, you will
-    //    need to specify the pins with the following example of SD_MMC.setPins()
+    // need to specify the pins with the following example of SD_MMC.setPins()
     // If you want to use only 1-bit mode, you can use the line with only one data pin (d0) begin changed.
-    // Please note that ESP32 does not allow pin change and will fail unless you enter the same pin config as is the hardwired.
+    // Please note that ESP32 does not allow pin changes and will fail unless you enter the same pin config as is the hardwired.
 #if defined(SOC_SDMMC_USE_GPIO_MATRIX) && not defined(BOARD_HAS_SDMMC)
     //if(! SD_MMC.setPins(clk, cmd, d0)){ // 1-bit line version
     if(! SD_MMC.setPins(clk, cmd, d0, d1, d2, d3)){ // 4-bit line version
@@ -225,19 +225,10 @@ void setup(){
     }
 #endif
 
-/*
-// This is waiting for implementation in peripheral manager (periman)
-    if(use_1_bit_mode){
-        Serial.printf("Begin in 1-bit mode; pins: CLK=%d, CMD=%d, D0=%d\n", SD_MMC.getClkPin(), SD_MMC.getCmdPin(), SD_MMC.getD0Pin());
-    }else{
-        Serial.printf("Begin in 4-bit mode; pins: CLK=%d, CMD=%d, D0=%d, D1=%d, D2=%d, D3=%d\n", SD_MMC.getClkPin(), SD_MMC.getCmdPin(), SD_MMC.getD0Pin(), SD_MMC.getD1Pin(), SD_MMC.getD2Pin(), SD_MMC.getD3Pin());
-    }
-*/
-
     if(!SD_MMC.begin("/sdcard", use_1_bit_mode)){
         Serial.println("Card Mount Failed.");
         Serial.println("Increase log level to see more info: Tools > Core Debug Level > Verbose");
-        Serial.println("Make sure that all data pins have 10 kOhm pull-up resistor");
+        Serial.println("Make sure that all data pins have a 10k Ohm pull-up resistor to 3.3V");
 #ifdef SOC_SDMMC_USE_GPIO_MATRIX
         Serial.println("Make sure that when using generic ESP32-S3 board the pins are setup using SD_MMC.setPins()");
 #endif

libraries/SD_MMC/examples/SDMMC_time/SDMMC_time.ino

@@ -22,7 +22,7 @@
  *                  |                                  █/
  *                  |__▍___▊___█___█___█___█___█___█___/
  * WARNING: ALL data pins must be pulled up to 3.3V with external 10k Ohm resistor!
- * Note to ESP32 pin 2 (D0) : add 1K pull up after flashing
+ * Note to ESP32 pin 2 (D0): Add 1K Ohm pull-up resistor to 3.3V after flashing
  *
  * For more info see file README.md in this library or on URL:
  * https://github.com/espressif/arduino-esp32/tree/master/libraries/SD_MMC
@@ -45,20 +45,20 @@ byte daysavetime = 1;
 //   If the SD_MMC is initialized with default pins it will result in rebooting loop - please
 //   reassign the pins elsewhere using the mentioned command `setPins`.
 // Note: ESP32-S3-WROOM-1 does not have GPIO 33 and 34 broken out.
-// Note: The board SP32-S3-USB-OTG has predefined default pins and the following definitions with the setPins() call will not be compiled.
+// Note: The board ESP32-S3-USB-OTG has predefined default pins and the following definitions with the setPins() call will not be compiled.
 // Note: Pins in this definition block are ordered from top down in order in which they are on the full-sized SD card
-//       from left to right when facing the pins down (when connected to a breadboard)
+//   from left to right when facing the pins down (when connected to a breadboard)
 
 #if defined(SOC_SDMMC_USE_GPIO_MATRIX) && not defined(BOARD_HAS_SDMMC)
-    int d1  = 21; // SD pin 8 - add 10k Pullup to 3.3V if using 4-bit mode (use_1_bit_mode = false)
-    int d0  = 47; // SD pin 7 - add 10k Pullup
+    int d1  = 21; // SD pin 8 - Add a 10k Ohm pull-up resistor to 3.3V if using 4-bit mode (use_1_bit_mode = false)
+    int d0  = 47; // SD pin 7 - Add a 10k Ohm pull-up resistor to 3.3V
     //     GND pin - SD pin 6
-    int clk = 39; // SD pin 5 - add 10k Pullup
+    int clk = 39; // SD pin 5 - Add a 10k Ohm pull-up resistor to 3.3V
     //    3.3V pin - SD pin 4
     //     GND pin - SD pin 3
-    int cmd = 40; // SD pin 2 - add 10k Pullup
-    int d3  = 41; // SD pin 1 - add 10k Pullup to card's pin even when using 1-bit mode
-    int d2  = 42; // SD pin 9 - add 10k Pullup to 3.3V if using 4-bit mode (use_1_bit_mode = false)
+    int cmd = 40; // SD pin 2 - Add a 10k Ohm pull-up resistor to 3.3V
+    int d3  = 41; // SD pin 1 - Add a 10k Ohm pull-up resistor to 3.3V to card's pin even when using 1-bit mode
+    int d2  = 42; // SD pin 9 - Add a 10k Ohm pull-up resistor to 3.3V if using 4-bit mode (use_1_bit_mode = false)
 #endif
 
 bool use_1_bit_mode = false; // Change the value to `true` to use 1-bit mode instead of the 4-bit mode
@@ -211,36 +211,27 @@ void setup(){
     Serial.println("");
 
     // If you are using any other ESP32-S3 board than ESP32-S3-USB-OTG which has preset default pins, you will
-    //    need to specify the pins with the following example of SD_MMC.setPins()
+    // need to specify the pins with the following example of SD_MMC.setPins()
     // If you want to use only 1-bit mode, you can use the line with only one data pin (d0) begin changed.
-    // Please note that ESP32 does not allow pin change and will fail unless you enter the same pin config as is the hardwired.
+    // Please note that ESP32 does not allow pin changes and will fail unless you enter the same pin config as is the hardwired.
 #if defined(SOC_SDMMC_USE_GPIO_MATRIX) && not defined(BOARD_HAS_SDMMC)
     if(use_1_bit_mode){
       if(! SD_MMC.setPins(clk, cmd, d0)){ // 1-bit line version
         Serial.println("Pin change failed!");
         return;
       }
-    }else{
+    } else {
       if(! SD_MMC.setPins(clk, cmd, d0, d1, d2, d3)){ // 4-bit line version
         Serial.println("Pin change failed!");
         return;
       }
     }
 #endif
 
-/*
-// This is waiting for implementation in peripheral manager (periman)
-    if(use_1_bit_mode){
-        Serial.printf("Begin in 1-bit mode; pins: CLK=%d, CMD=%d, D0=%d\n", SD_MMC.getClkPin(), SD_MMC.getCmdPin(), SD_MMC.getD0Pin());
-    }else{
-        Serial.printf("Begin in 4-bit mode; pins: CLK=%d, CMD=%d, D0=%d, D1=%d, D2=%d, D3=%d\n", SD_MMC.getClkPin(), SD_MMC.getCmdPin(), SD_MMC.getD0Pin(), SD_MMC.getD1Pin(), SD_MMC.getD2Pin(), SD_MMC.getD3Pin());
-    }
-*/
-
     if(!SD_MMC.begin("/sdcard", use_1_bit_mode)){
         Serial.println("Card Mount Failed.");
         Serial.println("Increase log level to see more info: Tools > Core Debug Level > Verbose");
-        Serial.println("Make sure that all data pins have 10 kOhm pull-up resistor");
+        Serial.println("Make sure that all data pins have a 10k Ohm pull-up resistor to 3.3V");
 #ifdef SOC_SDMMC_USE_GPIO_MATRIX
         Serial.println("Make sure that when using generic ESP32-S3 board the pins are setup using SD_MMC.setPins()");
 #endif