Merge pull request #33 from Marzogh/v2.4.0-w.i.p

V2.4.0 final release

.gitignore

@@ -1 +1,6 @@
 *.development
+
+#OS specific ignores
+
+*.DS_Store
+Thumbs.db

.travis.yml

@@ -11,6 +11,7 @@ script:
   - build_platform mega
   - build_platform fio
   - build_platform micro
+  - build_platform due
 notifications:
   email:
     on_success: change

Changes.log

@@ -2,9 +2,27 @@
 //										  SPIFlash Library 				 						   //
 //					  				  		Changes log 									   	   //
 //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~//
+//				 	 						Version 2.4.0 									   	   //
+//									Author: Prajwal Bhattaram									   //
+//					  						11.09.2016											   //
+//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~//
+Bugs Squashed:
+--> Fixed bug preventing writing to Address 0x00
+--> Fixed bug in _notPrevWritten() which did did not perform a thorough enough check to see if a location had been previously written to.
+--> Fixed errorchecking bug - it now works for all data types - not just byte/char as previously.
+Enhancements & Optimizations:
+--> Added a function 'error()' to enable users to check for errors generated at any point in their program.
+--> Optimized writePage() so it doesn't depend on other functions and so runs faster than before.
+--> Diagnostics.ino now outputs time taken for each function as a part of its and provides additional diagnostic data.
+--> Now have a common set of private functions - _prep(), _beginSPI(), _nextByte() & _endSPI() - to replace _prepWrite(), _prepRead(), _beginRead(), _readNextByte(), _beginWrite(), _writeNextByte() & _endProcess();
+--> Changed the way _addressCheck() works. It now checks all addresses involved in writing the data rather than one address block at a time and returns the correct address to write to in case overflow is enabled. Also, this function is now built into _prep().
+--> Reading and writing using page numbers + offset has been optimised to be faster than before.
+--> Optimized the way address and error checking is done so its more efficient and uses few system resources and runs faster.
+--> Using this library with an ESP8266 board defaults to using GPIO15 as the Slave Select - unless something different is explicitly specified in the constructor.
+//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~//
 //				 	 						Version 2.3.1 									   	   //
 //									Author: Prajwal Bhattaram									   //
-//					  						04.06.2016											   //
+//					  						19.06.2016											   //
 //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~//
 
 --> W25Q256FV support added. (Thanks Stanislav-Povolotsky!)

README.md

@@ -1,7 +1,7 @@
 
-# SPIFlash [![Build Status](https://travis-ci.org/Marzogh/SPIFlash.svg?branch=v2.2.1-esp8266_compat)](https://travis-ci.org/Marzogh/SPIFlash) [![DOI](https://zenodo.org/badge/18908/Marzogh/SPIFlash.svg)](https://zenodo.org/badge/latestdoi/18908/Marzogh/SPIFlash)
+# SPIFlash [![Build Status](https://travis-ci.org/Marzogh/SPIFlash.svg?branch=master)](https://travis-ci.org/Marzogh/SPIFlash) [![DOI](https://zenodo.org/badge/18908/Marzogh/SPIFlash.svg)](https://zenodo.org/badge/latestdoi/18908/Marzogh/SPIFlash)
 ### Arduino library for Winbond Flash Memory Chips
-<sup> Download the latest stable release (v2.3.0) from <a href = "https://github.com/Marzogh/SPIFlash/releases/latest">here</a>. Please report any bugs in issues.</sup>
+<sup> Download the latest stable release (v2.4.0) from <a href = "https://github.com/Marzogh/SPIFlash/releases/latest">here</a>. Please report any bugs in issues.</sup>
 
 This Arduino library is for use with Winbond serial flash memory chips. In its current form it supports identifying the flash chip and its various features; automatic address allocation and management; reading and writing bytes/chars/ints/longs/floats/Strings from and to various locations; reading and writing pages of bytes; continous reading/writing of data from/to arrays of bytes/chars; sector, block and chip erase; and powering down for low power operation.
 
@@ -11,7 +11,7 @@ This Arduino library is for use with Winbond serial flash memory chips. In its c
 #####Arduino IDEs supported
 - IDE v1.5.x
 - IDE v1.6.0-v1.6.5
-- IDE v1.6.9
+- IDE v1.6.9-v1.6.11
 
 #####Boards
 
@@ -53,6 +53,8 @@ The library enables the following functions:
 ##### Primary commands
 ###### begin()
 Must be called at the start in setup(). This function detects the type of chip being used and sets parameters accordingly.
+###### error()
+Returns the (8-bit) error code generated by the function called immediately before this is called. Refer to the [Error codes & Error reporting] (https://github.com/Marzogh/SPIFlash/wiki/Error-codes-&-Error-reporting) section the Wiki for further reference.
 ###### getMANID()
 Returns the Manufacturer ID as a 16-bit value.
 ###### getJEDECID()