Merge pull request #167 from Marzogh/stable

Final v3.3.0 code being pushed to master prior to release

Author: Marzogh

.github/ISSUE_TEMPLATE.md

@@ -2,7 +2,7 @@
 ![GitHub issue author](https://img.shields.io/github/issues/detail/u/Marzogh/SPIFlash/14.svg) ![GitHub issue label](https://img.shields.io/github/issues/detail/label/Marzogh/SPIFlash/14.svg) ![GitHub issue comments](https://img.shields.io/github/issues/detail/comments/Marzogh/SPIFlash/14.svg)
 ![GitHub issue age](https://img.shields.io/github/issues/detail/age/Marzogh/SPIFlash/14.svg) ![GitHub issue last update](https://img.shields.io/github/issues/detail/last-update/Marzogh/SPIFlash/14.svg)
 ###### ---------------------------- **DO NOT DELETE OR EDIT** anything above this line ----------------------------
-###### ---------------------------- **DO NOT DELETE OR EDIT** anything above this line ----------------------------
+
 
 Hey there! Thanks for using the SPIFlash library for Arduino.
 ### Please note that starting 01.03.2018 any issue raised here MUST be submitted according to this template or it will be flagged with 'Not enough information'. No action will be taken till all the prerequisite information is provided. If no information is provided for over a month, the issue will be closed.
@@ -20,7 +20,7 @@ Do the checklist before filing an issue:
 
 - [ ] Is this something you can **debug and fix**? Send a pull request! Bug fixes and documentation fixes are welcome.
 - [ ] Is this an idea for a feature? Post the feature request as an issue here with a title that clearly says "Feature Request".
-- [ ] Is this a bug that you cannot fix? Post the bug report as an issue here with a title that cleary says "Bug Report".
+- [ ] Is this a bug that you cannot fix? Post the bug report as an issue here with a title that clearly says "Bug Report".
 
 When opening an issue please include the following details:
 -------------------------------------------------------------
@@ -29,7 +29,7 @@ When opening an issue please include the following details:
 - [ ] Which library version are you using?
 - [ ] Which Arduino IDE version are you compiling the library on?
 - [ ] Which OS are you compiling your code on? [Linux / Mac / Windows]
-- [ ] Which microcontroller platform are you using?
+- [ ] Which micro controller platform are you using?
 - [ ] Which Flash memory module are you using?
 - [ ] What is the current behavior?
 - [ ] What is the expected behavior?
@@ -38,19 +38,15 @@ When opening an issue please include the following details:
 ###### Bug reports only
 - If this is a bug report -
 
-- [ ] Make sure you have run FlashDiagnostics.ino with ``` #define RUNDIAGNOSTICS ``` uncommented in SPIFlash.h. **List any error codes** that pop up in your Serial output when you run FlashDiagnostics.ino.here:
-      Error codes
-      ------------
-        -
-        -
-        -
-        -
-        -
+- [ ] Make sure you have run FlashDiagnostics.ino with ``` #define RUNDIAGNOSTICS ``` uncommented in SPIFlash.h. Paste the **relevant sections** of the output from your Serial console when you run FlashDiagnostics.ino.here:
+```
+```FlashDiagnostics output```
+```
 - [ ] If you have a problem with a particular function, call the flash.error() function (after you have made sure you have started up your Serial port with a ``` Serial.begin(BAUD) ``` ). Provide details of the function, the data given to/ expected from the function and the error code here: (**Please repeat this for every function you have an error with***)
         Function -
         Data -
         Error code -
-- [ ] Provide a **minimal code snippet** example that reproduces the bug. Please make sure you wrap any code in the proper code blocks like below
+- [ ] Provide a **minimal code snippet** example that reproduces the bug (If you're using one of the examples that came with the library, just tell us which one). Please make sure you wrap any code in the proper code blocks like below
 ```
 ```CODE HERE```
 ```

.github/PULL_REQUEST_TEMPLATE.md

@@ -23,7 +23,7 @@ Hey there! Thanks for using the SPIFlash library for Arduino.
 
 
 
-* **What is the new behavior (if this is a feature change)?**
+* **What is the new behavior?** (if this is a feature change)
 
 
 

README.md

@@ -54,7 +54,7 @@ Example code:
     flash.begin();
     uint16_t manID = flash.getManID();      // Function is used to get the manufacturer ID and store it as
                                             // a 16 bit unsigned integer
-    Serial.print("Chip Manufacturer ID: 0x");
+    Serial.print(F("Chip Manufacturer ID: 0x"));
     Serial.println(manID, HEX);                  // The manufacturer ID is printed as a Hexadecimal number
     ...
   }
@@ -101,7 +101,7 @@ Example code:
     flash.begin();
     uint32_t JEDEC = flash.getJEDECID();      // Function is used to get the JEDEC ID and store it as
                                               // a 32 bit unsigned integer
-    Serial.print("JEDEC ID: 0x");
+    Serial.print(F("JEDEC ID: 0x"));
     Serial.println(JEDEC, HEX);                  // The JEDEC ID is printed as a Hexadecimal number
     ...
   }
@@ -150,7 +150,7 @@ Example code:
     flash.begin();
     uint64_t uniqueID = flash.getUniqueID();      // Function is used to get the unique ID and store it as
                                                   // a 64 bit unsigned integer
-    Serial.print("Unique ID: 0x");
+    Serial.print(F("Unique ID: 0x"));
     Serial.println(uniqueID, HEX);                  // The unique ID is printed as a Hexadecimal number
     ...
   }
@@ -197,7 +197,7 @@ Example code:
     flash.begin();
     uint32_t cap = flash.getCapacity();      // Function is used to get the unique ID and store it as
                                                   // a 32 bit unsigned integer
-    Serial.print("Capacity: ");
+    Serial.print(F("Capacity: "));
     Serial.println(cap);               // The unique ID is printed as a decimal number - in bytes
     ...
   }
@@ -253,7 +253,7 @@ Example code:
     flash.begin();
     uint32_t maxPage = flash.getMaxPage();  // Function is used to get the number of pages and store it as
                                             // a 32 bit unsigned integer
-    Serial.print("Maximum pages: ");
+    Serial.print(F("Maximum pages: "));
     Serial.println(maxPage);                  // The number of pages is printed
     ...
   }

docs/pages/SPIFlash/chipID.rst

@@ -58,16 +58,16 @@ Example code:
   void setup() {
     flash.begin();
     _address = flash.getAddress(sizeof(dataIn));
-    Serial.print("Address = ");
+    Serial.print(F("Address = "));
     Serial.println(_address);
 
     dataIn = flash.readByteArray(_address, dataIn, _bufferSize);
     // This function should be changed depending on the type of data being read from the flash memory
 
-    Serial.print("Data read: ");
+    Serial.print(F("Data read: "));
     for (uint8_t i = 0; i < _bufferSize; i++) {
       Serial.print(dataIn[i]);
-      Serial.print(", ");
+      Serial.print(F(", "));
     }
     Serial.println();
 

docs/pages/SPIFlash/readArray.rst

@@ -54,15 +54,15 @@ Example code:
   void setup() {
     flash.begin();
     _address = flash.getAddress(sizeof(dataIn));
-    Serial.print("Address = ");
+    Serial.print(F("Address = "));
     Serial.println(_address);
-    Serial.print("readAnything()");
+    Serial.print(F("readAnything()"));
     if (!flash.readAnything(_address, dataIn)) { // Function is used to get the data from
                                                // address '_address' and save it to the struct 'test'
-      Serial.println("Failed");
+      Serial.println(F("Failed"));
     }
     else {
-      Serial.println("Passed");
+      Serial.println(F("Passed"));
     }
     ...
   }

docs/pages/SPIFlash/readDataIndependent.rst

@@ -62,9 +62,9 @@ Example code:
     _address = flash.getAddress(sizeof(dataIn));
     dataIn = flash.readByte(_address);    // This function should be changed depending on the type of data
                                           // being read from the flash memory
-    Serial.print("Address = ");
+    Serial.print(F("Address = "));
     Serial.println(_address);
-    Serial.print("Data read : 0x");
+    Serial.print(F("Data read : 0x"));
     Serial.println(dataIn, HEX);
   }
 

docs/pages/SPIFlash/readSingleVariable.rst

@@ -53,16 +53,16 @@ Example code:
   void setup() {
     flash.begin();
     _address = flash.getAddress(sizeof(dataIn));
-    Serial.print("Address = ");
+    Serial.print(F("Address = "));
     Serial.println(_address);
 
-    Serial.print("Data write: ");
+    Serial.print(F("Data write: "));
     if (flash.writeByteArray(_address, dataOut, _bufferSize) {
     // This function should be changed depending on the type of data being written to the flash memory
-      Serial.println ("Successful");
+      Serial.println(F("Successful"));
     }
     else {
-      Serial.println("Failed");
+      Serial.println(F("Failed"));
     }
 
   }

docs/pages/SPIFlash/writeArray.rst

@@ -54,16 +54,16 @@ Example code:
   void setup() {
     flash.begin();
     _address = flash.getAddress(sizeof(dataIn));
-    Serial.print("Address = ");
+    Serial.print(F("Address = "));
     Serial.println(_address);
 
-    Serial.print("writeAnything()");
+    Serial.print(F("writeAnything()"));
     if (!flash.writeAnything(_address, dataOut)) { // Function is used to write the data to
                                                    // address '_address'
-      Serial.println("Failed");
+      Serial.println(F("Failed"));
     }
     else {
-      Serial.println("Passed");
+      Serial.println(F("Passed"));
     }
     ...
   }

docs/pages/SPIFlash/writeDataIndependent.rst

@@ -69,16 +69,16 @@ Example code:
   void setup() {
     flash.begin();
     _address = flash.getAddress(sizeof(dataIn));
-    Serial.print("Address = ");
+    Serial.print(F("Address = "));
     Serial.println(_address);
 
-    Serial.print("Data write ");
+    Serial.print(F("Data write "));
     // This function should be changed depending on the type of data being written to the flash memory
     if (flash.writeStr(_address, dataOut)) {
-      Serial.println("successful");
+      Serial.println(F("successful"));
     }
     else {
-      Serial.println("failed");
+      Serial.println(F("failed"));
     }
   }