v1.0.1 to fix platform

### Releases v1.0.1 1. Fix platform in `library.json`
khoih-prog · Oct 22, 2021 · 0e9c838 · 0e9c838
1 parent dd6ad0c
commit 0e9c838
Show file tree

Hide file tree

Showing 25 changed files with 85 additions and 104 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,9 +14,9 @@ If you don't find anything, please [open a new issue](https://github.com/khoih-p
 
 Please ensure to specify the following:
 
-* Arduino IDE version (e.g. 1.8.15) or Platform.io version
-* `RP2040` Core Version (e.g. Arduino-mbed RP2040 v2.1.0 or arduino-pico core v1.8.4)
-* `RP2040` Board type (e.g. NANO_RP2040_CONNECT, RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040, GENERIC_RP2040, etc.)
+* Arduino IDE version (e.g. 1.8.16) or Platform.io version
+* `Arduino mbed_rp2040` Core Version (e.g. Arduino mbed_rp2040 core v2.5.2) or `RP2040` Core Version (e.g. RP2040 core v1.9.5)
+* `RP2040` Board type (e.g. Nano_RP2040_Connect, RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040, GENERIC_RP2040, etc.)
 * Contextual information (e.g. what you were trying to achieve)
 * Simplest possible steps to reproduce
 * Anything that might be relevant in your opinion, such as:
@@ -27,11 +27,11 @@ Please ensure to specify the following:
 ### Example
 
 ```
-Arduino IDE version: 1.8.15
-Arduino-mbed RP2040 v2.1.0
-NANO_RP2040_CONNECT Module
+Arduino IDE version: 1.8.16
+Arduino mbed_rp2040 core v2.5.2
+RASPBERRY_PI_PICO board
 OS: Ubuntu 20.04 LTS
-Linux xy-Inspiron-3593 5.4.0-74-generic #83-Ubuntu SMP Sat May 8 02:35:39 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
+Linux xy-Inspiron-3593 5.4.0-86-generic #97-Ubuntu SMP Fri Sep 17 19:19:40 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
 
 Context:
 I encountered a crash while using TimerInterrupt.

diff --git a/README.md b/README.md
@@ -14,8 +14,7 @@
 * [Why do we need this RP2040_SD library](#why-do-we-need-this-rp2040_sd-library)
   * [Features](#features)
   * [Currently supported Boards](#currently-supported-boards)
-* [Changelog](#changelog)
-  * [Releases v1.0.0](#releases-v100)
+* [Changelog](changelog.md)
 * [Prerequisites](#prerequisites)
 * [Installation](#installation)
   * [Use Arduino Library Manager](#use-arduino-library-manager)
@@ -44,7 +43,6 @@
   * [10. Files on RASPBERRY_PI_PICO](#10-files-on-raspberry_pi_pico)
 * [Debug](#debug)
 * [Troubleshooting](#troubleshooting)
-* [Releases](#releases)
 * [Issues](#issues)
 * [TO DO](#to-do)
 * [DONE](#done)
@@ -91,26 +89,15 @@ But if you need to write codes to be used in both [**Arduino-mbed RP2040** core]
 
 1. RP2040-based boards such as **NANO_RP2040_CONNECT, RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040**, etc. using either [**Arduino-mbed RP2040** core](https://github.com/arduino/ArduinoCore-mbed) or [**Earle Philhower's arduino-pico core**](https://github.com/earlephilhower/arduino-pico).
 
----
----
-
-
-## Changelog
-
-### Releases v1.0.0
-
-1. Port to RP2040-based boards using Arduino-mbed or arduino-pico core
-2. Add debugging feature
-
 
 ---
 ---
 
 ## Prerequisites
 
-1. [`Arduino IDE 1.8.15+` for Arduino](https://www.arduino.cc/en/Main/Software)
-2. [`Arduino mbed_rp2040 core 2.4.1+`](https://github.com/arduino/ArduinoCore-mbed) for Arduino RP2040-based boards, such as **Arduino Nano RP2040 Connect, RASPBERRY_PI_PICO, etc.**. [![GitHub release](https://img.shields.io/github/release/arduino/ArduinoCore-mbed.svg)](https://github.com/arduino/ArduinoCore-mbed/releases/latest)
-3. [`Earle Philhower's arduino-pico core v1.9.4+`](https://github.com/earlephilhower/arduino-pico) for RP2040-based boards such as **RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040**, etc. [![GitHub release](https://img.shields.io/github/release/earlephilhower/arduino-pico.svg)](https://github.com/earlephilhower/arduino-pico/releases/latest)
+1. [`Arduino IDE 1.8.16+` for Arduino](https://www.arduino.cc/en/Main/Software)
+2. [`Arduino mbed_rp2040 core 2.5.2+`](https://github.com/arduino/ArduinoCore-mbed) for Arduino (Use Arduino Board Manager) RP2040-based boards, such as **Arduino Nano RP2040 Connect, RASPBERRY_PI_PICO, etc.**. [![GitHub release](https://img.shields.io/github/release/arduino/ArduinoCore-mbed.svg)](https://github.com/arduino/ArduinoCore-mbed/releases/latest)
+3. [`Earle Philhower's arduino-pico core v1.9.5+`](https://github.com/earlephilhower/arduino-pico) for RP2040-based boards such as **RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040**, etc. [![GitHub release](https://img.shields.io/github/release/earlephilhower/arduino-pico.svg)](https://github.com/earlephilhower/arduino-pico/releases/latest)
 
 ---
 ---
@@ -305,7 +292,7 @@ The following is the sample terminal output when running example [CardInfo](exam
 
 ```
 Starting SD Card CardInfo on MBED RaspberryPi Pico
-MBED RP2040_SD v1.0.0
+MBED RP2040_SD v1.0.1
 Initializing SD card with SS = 5
 SCK = 2
 MOSI = 3
@@ -344,7 +331,7 @@ The following is the sample terminal output when running example [DumpFile](exam
 
 ```
 Starting SD Card DumpFile on MBED RaspberryPi Pico
-MBED RP2040_SD v1.0.0
+MBED RP2040_SD v1.0.1
 Initializing SD card with SS = 5
 SCK = 2
 MOSI = 3
@@ -364,7 +351,7 @@ The following is the sample terminal output when running example [ListFiles](exa
 
 ```
 Starting SD Card ListFiles on MBED RaspberryPi Pico
-MBED RP2040_SD v1.0.0
+MBED RP2040_SD v1.0.1
 Initializing SD card with SS = 5
 SCK = 2
 MOSI = 3
@@ -404,7 +391,7 @@ The following is the sample terminal output when running example [ReadWrite](exa
 
 ```
 Starting SD Card ReadWrite on MBED RaspberryPi Pico
-MBED RP2040_SD v1.0.0
+MBED RP2040_SD v1.0.1
 Initializing SD card with SS = 5
 SCK = 2
 MOSI = 3
@@ -437,7 +424,7 @@ The following is the sample terminal output when running example [Files](example
 
 ```
 Starting SD Card Files on MBED RaspberryPi Pico
-MBED RP2040_SD v1.0.0
+MBED RP2040_SD v1.0.1
 Initializing SD card with SS = 5
 SCK = 2
 MOSI = 3
@@ -463,7 +450,7 @@ The following is the sample terminal output when running example [CardInfo](exam
 
 ```
 Starting SD Card CardInfo on RASPBERRY_PI_PICO
-RP2040_SD v1.0.0
+RP2040_SD v1.0.1
 Initializing SD card with SS = 17
 SCK = 18
 MOSI = 19
@@ -500,7 +487,7 @@ The following is the sample terminal output when running example [DumpFile](exam
 
 ```
 Starting SD Card DumpFile on RASPBERRY_PI_PICO
-RP2040_SD v1.0.0
+RP2040_SD v1.0.1
 Initializing SD card with SS = 17
 SCK = 18
 MOSI = 19
@@ -520,7 +507,7 @@ The following is the sample terminal output when running example [ListFiles](exa
 
 ```
 Starting SD Card ListFiles on RASPBERRY_PI_PICO
-RP2040_SD v1.0.0
+RP2040_SD v1.0.1
 Initializing SD card with SS = 17
 SCK = 18
 MOSI = 19
@@ -554,7 +541,7 @@ The following is the sample terminal output when running example [ReadWrite](exa
 
 ```
 Starting SD Card ReadWrite on RASPBERRY_PI_PICO
-RP2040_SD v1.0.0
+RP2040_SD v1.0.1
 Initializing SD card with SS = 17
 SCK = 18
 MOSI = 19
@@ -587,7 +574,7 @@ The following is the sample terminal output when running example [Files](example
 
 ```
 Starting SD Card Files on RASPBERRY_PI_PICO
-RP2040_SD v1.0.0
+RP2040_SD v1.0.1
 Initializing SD card with SS = 17
 SCK = 18
 MOSI = 19
@@ -629,16 +616,6 @@ If you get compilation errors, more often than not, you may need to install a ne
 Sometimes, the library will only work if you update the board core to the latest version because I am using newly added functions.
 
 
----
----
-
-## Releases
-
-### Releases v1.0.0
-
-1. Port to RP2040-based boards using Arduino-mbed or arduino-pico core
-2. Add debugging feature
-
 ---
 ---
 

diff --git a/changelog.md b/changelog.md
@@ -0,0 +1,33 @@
+# RP2040_SD Library
+
+[![arduino-library-badge](https://www.ardu-badge.com/badge/RP2040_SD.svg?)](https://www.ardu-badge.com/RP2040_SD)
+[![GitHub release](https://img.shields.io/github/release/khoih-prog/RP2040_SD.svg)](https://github.com/khoih-prog/RP2040_SD/releases)
+[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/khoih-prog/RP2040_SD/blob/main/LICENSE)
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
+[![GitHub issues](https://img.shields.io/github/issues/khoih-prog/RP2040_SD.svg)](http://github.com/khoih-prog/RP2040_SD/issues)
+
+---
+---
+
+## Table of Contents
+
+* [Changelog](#changelog)
+  * [Releases v1.0.1](#releases-v101)
+  * [Releases v1.0.0](#releases-v100)
+
+---
+---
+
+
+## Changelog
+
+### Releases v1.0.1
+
+1. Fix platform in `library.json`
+
+### Releases v1.0.0
+
+1. Port to RP2040-based boards using Arduino-mbed or arduino-pico core
+2. Add debugging feature
+
+
diff --git a/examples/CardInfo/CardInfo.ino b/examples/CardInfo/CardInfo.ino
@@ -22,12 +22,6 @@
   
   Built by Khoi Hoang https://github.com/khoih-prog/RP2040_SD
   Licensed under GPL-3.0 license
-  
-  Version: 1.0.0
-  
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0  K Hoang       18/06/2021 Port to RP2040-based boards using Arduimo-mbed or arduino-pico core
  *****************************************************************************************************************************/
 /*
   SD card connection

diff --git a/examples/DataLogger/DataLogger.ino b/examples/DataLogger/DataLogger.ino
@@ -22,12 +22,6 @@
   
   Built by Khoi Hoang https://github.com/khoih-prog/RP2040_SD
   Licensed under GPL-3.0 license
-  
-  Version: 1.0.0
-  
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0  K Hoang       18/06/2021 Port to RP2040-based boards using Arduimo-mbed or arduino-pico core
  *****************************************************************************************************************************/
 /*
   SD card connection

diff --git a/examples/DumpFile/DumpFile.ino b/examples/DumpFile/DumpFile.ino
@@ -22,12 +22,6 @@
   
   Built by Khoi Hoang https://github.com/khoih-prog/RP2040_SD
   Licensed under GPL-3.0 license
-  
-  Version: 1.0.0
-  
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0  K Hoang       18/06/2021 Port to RP2040-based boards using Arduimo-mbed or arduino-pico core
  *****************************************************************************************************************************/
 /*
   SD card connection

diff --git a/examples/Files/Files.ino b/examples/Files/Files.ino
@@ -22,12 +22,6 @@
   
   Built by Khoi Hoang https://github.com/khoih-prog/RP2040_SD
   Licensed under GPL-3.0 license
-  
-  Version: 1.0.0
-  
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0  K Hoang       18/06/2021 Port to RP2040-based boards using Arduimo-mbed or arduino-pico core
  *****************************************************************************************************************************/
 /*
   SD card connection

diff --git a/examples/ListFiles/ListFiles.ino b/examples/ListFiles/ListFiles.ino
@@ -22,12 +22,6 @@
   
   Built by Khoi Hoang https://github.com/khoih-prog/RP2040_SD
   Licensed under GPL-3.0 license
-  
-  Version: 1.0.0
-  
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0  K Hoang       18/06/2021 Port to RP2040-based boards using Arduimo-mbed or arduino-pico core
  *****************************************************************************************************************************/
 
 /*

diff --git a/examples/NonBlockingWrite/NonBlockingWrite.ino b/examples/NonBlockingWrite/NonBlockingWrite.ino
@@ -22,12 +22,6 @@
   
   Built by Khoi Hoang https://github.com/khoih-prog/RP2040_SD
   Licensed under GPL-3.0 license
-  
-  Version: 1.0.0
-  
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0  K Hoang       18/06/2021 Port to RP2040-based boards using Arduimo-mbed or arduino-pico core
  *****************************************************************************************************************************/
 /*
   SD card connection

diff --git a/examples/ReadWrite/ReadWrite.ino b/examples/ReadWrite/ReadWrite.ino
@@ -22,12 +22,6 @@
   
   Built by Khoi Hoang https://github.com/khoih-prog/RP2040_SD
   Licensed under GPL-3.0 license
-  
-  Version: 1.0.0
-  
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0  K Hoang       18/06/2021 Port to RP2040-based boards using Arduimo-mbed or arduino-pico core
  *****************************************************************************************************************************/
 /*
   SD card connection

diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
   "name": "RP2040_SD",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "keywords": "data-storage, sd, sd-card, fat, fat16, fat32, sd-fat, ex-fat, spi, mbed, rpi-pico, rp2040, nano-rp2040-connect",
   "description": "This library enables you to use SPI SD cards (FAT16, FAT32, exFAT) with RP2040-based boards such as Nano_RP2040_Connect, RASPBERRY_PI_PICO using either RP2040 Arduino-mbed or arduino-pico core.. This SD-Fat v2 can support FAT16, FAT32, exFAT. exFAT supports files larger than 4GB by using uint64_t as file offset.",
   "authors": [
@@ -30,7 +30,7 @@
     ]
   },
   "frameworks": "*",
-  "platforms": ["rp2040", "mbed_rp2040", "mbed_nano"],
+  "platforms": ["raspberrypi"],
   "examples": "examples/*/*/*.ino",
   "license": "MIT"
 }
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=RP2040_SD
-version=1.0.0
+version=1.0.1
 author=Bill Greiman <fat16lib@sbcglobal.net>, Khoi Hoang <khoih.prog@gmail.com>
 maintainer=Khoi Hoang <khoih.prog@gmail.com>
 sentence=This library enables you to use SPI SD cards with RP2040-based boards such as Nano_RP2040_Connect, RASPBERRY_PI_PICO using either RP2040 Arduino-mbed or arduino-pico core.

diff --git a/src/File.hpp b/src/File.hpp
@@ -23,11 +23,12 @@
   Built by Khoi Hoang https://github.com/khoih-prog/RP2040_SD
   Licensed under GPL-3.0 license
   
-  Version: 1.0.0
+  Version: 1.0.1
   
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.0.0  K Hoang       18/06/2021 Port to RP2040-based boards using Arduimo-mbed or arduino-pico core
+  1.0.1  K Hoang       22/10/2021 Fix platform in library.json for PIO
  *****************************************************************************************************************************/
 
 #pragma once

diff --git a/src/RP2040_SD.h b/src/RP2040_SD.h
@@ -23,11 +23,12 @@
   Built by Khoi Hoang https://github.com/khoih-prog/RP2040_SD
   Licensed under GPL-3.0 license
   
-  Version: 1.0.0
+  Version: 1.0.1
   
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.0.0  K Hoang       18/06/2021 Port to RP2040-based boards using Arduimo-mbed or arduino-pico core
+  1.0.1  K Hoang       22/10/2021 Fix platform in library.json for PIO
  *****************************************************************************************************************************/
 
 #pragma once
@@ -39,10 +40,10 @@
   #error For RP2040 only
 #elif defined(ARDUINO_ARCH_MBED)
   #warning Using Arduino-mbed core and architecture for RP2040
-  #define RP2040_SD_VERSION     "MBED RP2040_SD v1.0.0"
+  #define RP2040_SD_VERSION     "MBED RP2040_SD v1.0.1"
 #else
   #warning Using arduino-pico architecture for RP2040
-  #define RP2040_SD_VERSION     "RP2040_SD v1.0.0"
+  #define RP2040_SD_VERSION     "RP2040_SD v1.0.1"
 #endif
 
 #include <Arduino.h>

diff --git a/src/RP2040_SD.hpp b/src/RP2040_SD.hpp
@@ -23,11 +23,12 @@
   Built by Khoi Hoang https://github.com/khoih-prog/RP2040_SD
   Licensed under GPL-3.0 license
   
-  Version: 1.0.0
+  Version: 1.0.1
   
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.0.0  K Hoang       18/06/2021 Port to RP2040-based boards using Arduimo-mbed or arduino-pico core
+  1.0.1  K Hoang       22/10/2021 Fix platform in library.json for PIO
  *****************************************************************************************************************************/
 
 /*