From a650091968dcaeb3f0265fdd398bda9ca0df99eb Mon Sep 17 00:00:00 2001 From: Larry Bernstone Date: Tue, 26 Mar 2024 09:45:30 -1000 Subject: [PATCH 1/3] Matched pin numbers in doco to numbers in variants files --- libraries/SD/README.md | 12 ++++++------ libraries/SD/examples/SD_Test/SD_Test.ino | 22 +++++++++++----------- libraries/SD/examples/SD_time/SD_time.ino | 22 +++++++++++----------- 3 files changed, 28 insertions(+), 28 deletions(-) diff --git a/libraries/SD/README.md b/libraries/SD/README.md index 136703c9452..746c72f4acc 100644 --- a/libraries/SD/README.md +++ b/libraries/SD/README.md @@ -18,12 +18,12 @@ Some ESP32 modules have different pin outs! ## Default SPI pins: 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)` -| SPI Pin Name | ESP8266 | ESP32 | ESP32-S2 | ESP32-C3 | ESP32-S3 | -|--------------|---------|-------|----------|----------|----------| -| CS (SS) | GPIO15 | GPIO5 | GPIO5 | GPIO13 | GPIO13 | -| DI (MOSI) | GPIO13 | GPIO23| GPIO24 | GPIO14 | GPIO14 | -| DO (MISO) | GPIO12 | GPIO19| GPIO25 | GPIO15 | GPIO15 | -| SCK (SCLK) | GPIO14 | GPIO18| GPIO19 | GPIO16 | GPIO16 | +| SPI Pin Name | ESP8266 | ESP32 | ESP32-S2 | ESP32-S3 | ESP32-C3 | ESP32-C6 | ESP32-H2 | +|--------------|---------|-------|----------|----------|----------|----------|----------| +| CS (SS) | GPIO15 | GPIO5 | GPIO34 | GPIO10 | GPIO7 | GPIO18 | GPIO0 | +| DI (MOSI) | GPIO13 | GPIO23| GPIO35 | GPIO11 | GPIO6 | GPIO19 | GPIO25 | +| DO (MISO) | GPIO12 | GPIO19| GPIO37 | GPIO13 | GPIO5 | GPIO20 | GPIO11 | +| SCK (SCLK) | GPIO14 | GPIO18| GPIO36 | GPIO12 | GPIO4 | GPIO21 | GPIO10 | ## FAQ: diff --git a/libraries/SD/examples/SD_Test/SD_Test.ino b/libraries/SD/examples/SD_Test/SD_Test.ino index 2028f91850c..63c2c5a8d1e 100644 --- a/libraries/SD/examples/SD_Test/SD_Test.ino +++ b/libraries/SD/examples/SD_Test/SD_Test.ino @@ -22,17 +22,17 @@ * 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 | - * +==============+=========+=======+==========+==========+==========+ - * | CS (SS) | GPIO15 | GPIO5 | GPIO5 | GPIO13 | GPIO13 | - * +--------------+---------+-------+----------+----------+----------+ - * | DI (MOSI) | GPIO13 | GPIO23| GPIO24 | GPIO14 | GPIO14 | - * +--------------+---------+-------+----------+----------+----------+ - * | DO (MISO) | GPIO12 | GPIO19| GPIO25 | GPIO15 | GPIO15 | - * +--------------+---------+-------+----------+----------+----------+ - * | SCK (SCLK) | GPIO14 | GPIO18| GPIO19 | GPIO16 | GPIO16 | - * +--------------+---------+-------+----------+----------+----------+ + * +--------------+---------+-------+----------+----------+----------+----------+----------+ + * | SPI Pin Name | ESP8266 | ESP32 | ESP32-S2 | ESP32-S3 | ESP32-C3 | ESP32-C6 | ESP32-H2 | + * +==============+=========+=======+==========+==========+==========+==========+==========+ + * | CS (SS) | GPIO15 | GPIO5 | GPIO34 | GPIO10 | GPIO7 | GPIO18 | GPIO0 | + * +--------------+---------+-------+----------+----------+----------+----------+----------+ + * | DI (MOSI) | GPIO13 | GPIO23| GPIO35 | GPIO11 | GPIO6 | GPIO19 | GPIO25 | + * +--------------+---------+-------+----------+----------+----------+----------+----------+ + * | DO (MISO) | GPIO12 | GPIO19| GPIO37 | GPIO13 | GPIO5 | GPIO20 | GPIO11 | + * +--------------+---------+-------+----------+----------+----------+----------+----------+ + * | SCK (SCLK) | GPIO14 | GPIO18| GPIO36 | GPIO12 | GPIO4 | GPIO21 | GPIO10 | + * +--------------+---------+-------+----------+----------+----------+----------+----------+ * * For more info see file README.md in this library or on URL: * https://github.com/espressif/arduino-esp32/tree/master/libraries/SD diff --git a/libraries/SD/examples/SD_time/SD_time.ino b/libraries/SD/examples/SD_time/SD_time.ino index e161bf036e0..fa94fe8e8be 100644 --- a/libraries/SD/examples/SD_time/SD_time.ino +++ b/libraries/SD/examples/SD_time/SD_time.ino @@ -22,17 +22,17 @@ * 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 | - * +==============+=========+=======+==========+==========+==========+ - * | CS (SS) | GPIO15 | GPIO5 | GPIO5 | GPIO13 | GPIO13 | - * +--------------+---------+-------+----------+----------+----------+ - * | DI (MOSI) | GPIO13 | GPIO23| GPIO24 | GPIO14 | GPIO14 | - * +--------------+---------+-------+----------+----------+----------+ - * | DO (MISO) | GPIO12 | GPIO19| GPIO25 | GPIO15 | GPIO15 | - * +--------------+---------+-------+----------+----------+----------+ - * | SCK (SCLK) | GPIO14 | GPIO18| GPIO19 | GPIO16 | GPIO16 | - * +--------------+---------+-------+----------+----------+----------+ ++----------+ + * | SPI Pin Name | ESP8266 | ESP32 | ESP32-S2 | ESP32-S3 | ESP32-C3 | ESP32-C6 | ESP32-H2 | + * +==============+=========+=======+==========+==========+==========+==========+==========+ + * | CS (SS) | GPIO15 | GPIO5 | GPIO34 | GPIO10 | GPIO7 | GPIO18 | GPIO0 | + * +--------------+---------+-------+----------+----------+----------+----------+----------+ + * | DI (MOSI) | GPIO13 | GPIO23| GPIO35 | GPIO11 | GPIO6 | GPIO19 | GPIO25 | + * +--------------+---------+-------+----------+----------+----------+----------+----------+ + * | DO (MISO) | GPIO12 | GPIO19| GPIO37 | GPIO13 | GPIO5 | GPIO20 | GPIO11 | + * +--------------+---------+-------+----------+----------+----------+----------+----------+ + * | SCK (SCLK) | GPIO14 | GPIO18| GPIO36 | GPIO12 | GPIO4 | GPIO21 | GPIO10 | + * +--------------+---------+-------+----------+----------+----------+----------+----------+ * * For more info see file README.md in this library or on URL: * https://github.com/espressif/arduino-esp32/tree/master/libraries/SD From b4999721924881cd17346577a6b5f81d5dd70551 Mon Sep 17 00:00:00 2001 From: Larry Bernstone Date: Tue, 26 Mar 2024 09:50:13 -1000 Subject: [PATCH 2/3] Non-breaking dashes --- libraries/SD/README.md | 2 +- libraries/SD/examples/SD_Test/SD_Test.ino | 2 +- libraries/SD/examples/SD_time/SD_time.ino | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/libraries/SD/README.md b/libraries/SD/README.md index 746c72f4acc..4e0a05ee06d 100644 --- a/libraries/SD/README.md +++ b/libraries/SD/README.md @@ -18,7 +18,7 @@ Some ESP32 modules have different pin outs! ## Default SPI pins: 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)` -| SPI Pin Name | ESP8266 | ESP32 | ESP32-S2 | ESP32-S3 | ESP32-C3 | ESP32-C6 | ESP32-H2 | +| SPI Pin Name | ESP8266 | ESP32 | ESP32‑S2 | ESP32‑S3 | ESP32‑C3 | ESP32‑C6 | ESP32‑H2 | |--------------|---------|-------|----------|----------|----------|----------|----------| | CS (SS) | GPIO15 | GPIO5 | GPIO34 | GPIO10 | GPIO7 | GPIO18 | GPIO0 | | DI (MOSI) | GPIO13 | GPIO23| GPIO35 | GPIO11 | GPIO6 | GPIO19 | GPIO25 | diff --git a/libraries/SD/examples/SD_Test/SD_Test.ino b/libraries/SD/examples/SD_Test/SD_Test.ino index 63c2c5a8d1e..7adf35901a3 100644 --- a/libraries/SD/examples/SD_Test/SD_Test.ino +++ b/libraries/SD/examples/SD_Test/SD_Test.ino @@ -23,7 +23,7 @@ * 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-S3 | ESP32-C3 | ESP32-C6 | ESP32-H2 | + * | SPI Pin Name | ESP8266 | ESP32 | ESP32‑S2 | ESP32‑S3 | ESP32‑C3 | ESP32‑C6 | ESP32‑H2 | * +==============+=========+=======+==========+==========+==========+==========+==========+ * | CS (SS) | GPIO15 | GPIO5 | GPIO34 | GPIO10 | GPIO7 | GPIO18 | GPIO0 | * +--------------+---------+-------+----------+----------+----------+----------+----------+ diff --git a/libraries/SD/examples/SD_time/SD_time.ino b/libraries/SD/examples/SD_time/SD_time.ino index fa94fe8e8be..b3f7751ee32 100644 --- a/libraries/SD/examples/SD_time/SD_time.ino +++ b/libraries/SD/examples/SD_time/SD_time.ino @@ -23,7 +23,7 @@ * 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-S3 | ESP32-C3 | ESP32-C6 | ESP32-H2 | + * | SPI Pin Name | ESP8266 | ESP32 | ESP32‑S2 | ESP32‑S3 | ESP32‑C3 | ESP32‑C6 | ESP32‑H2 | * +==============+=========+=======+==========+==========+==========+==========+==========+ * | CS (SS) | GPIO15 | GPIO5 | GPIO34 | GPIO10 | GPIO7 | GPIO18 | GPIO0 | * +--------------+---------+-------+----------+----------+----------+----------+----------+ From 9b870c58b6832a234c7bd333da8352c31ecacd08 Mon Sep 17 00:00:00 2001 From: Larry Bernstone Date: Tue, 26 Mar 2024 09:57:03 -1000 Subject: [PATCH 3/3] Changed SD examples to make REASSIGN_PINS more transparent. Fixes #9082 --- libraries/SD/examples/SD_Test/SD_Test.ino | 5 +++-- libraries/SD/examples/SD_time/SD_time.ino | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/libraries/SD/examples/SD_Test/SD_Test.ino b/libraries/SD/examples/SD_Test/SD_Test.ino index 7adf35901a3..2d7d5bf1dd4 100644 --- a/libraries/SD/examples/SD_Test/SD_Test.ino +++ b/libraries/SD/examples/SD_Test/SD_Test.ino @@ -214,9 +214,10 @@ void setup(){ #ifdef REASSIGN_PINS SPI.begin(sck, miso, mosi, cs); -#endif - //if(!SD.begin(cs)){ //Change to this function to manually change CS pin + if(!SD.begin(cs)){ +#else if(!SD.begin()){ +#endif Serial.println("Card Mount Failed"); return; } diff --git a/libraries/SD/examples/SD_time/SD_time.ino b/libraries/SD/examples/SD_time/SD_time.ino index b3f7751ee32..79f6edb0952 100644 --- a/libraries/SD/examples/SD_time/SD_time.ino +++ b/libraries/SD/examples/SD_time/SD_time.ino @@ -208,9 +208,10 @@ void setup(){ #ifdef REASSIGN_PINS SPI.begin(sck, miso, mosi, cs); -#endif - //if(!SD.begin(cs)){ //Change to this function to manually change CS pin + if(!SD.begin(cs)){ +#else if(!SD.begin()){ +#endif Serial.println("Card Mount Failed"); return; }