Updates to maybe allow library to be added to library manager

KurtE · KurtE · commit 350ebf1f6c6c · 2022-01-24T06:29:04.000-08:00
Update library.properties
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Kurt E
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,34 +1,59 @@
 Overview and Warning: 
 =====
+This Arduino library is for driving ILI9341 displays on Teensy 3.x or 4.x boards from 
+PJRC(https://www.pjrc.com/) and I have played with it on a few different
+ILI9341 displays including ones from PJRC such as: https://www.pjrc.com/store/display_ili9341_touch.html and ones from Adafruit such as: https://www.adafruit.com/product/1770
+
 This is a modified version of the official PJRC ILI9341_t3 library (https://github.com/PaulStoffregen/ILI9341_t3).
 And it is always a Work In Progress.
 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
 This library borrows some concepts and functionality like the usage of DMA from another variant library: https://github.com/FrankBoesing/ILI9341_t3DMA
 
 This library was originally created to be able to test out SPI on the newer Teensy boards (3.5 and 3.6), which have multiple SPI busses. Later it was
 also adapted to allow this on the Teensy LC as well. 
 
 
-SPIN
+Constructor and begin
 ----
+This library was developed to allow you to use any of the SPI busses on a Teensy 3.x or 4.x processor. 
+It detects this by looking at which pins were specified on the constructor. 
 
-This version no longer uses or requires my SPIN library. 
-Currently this library uses my SPIN library (https://github.com/KurtE/SPIN), which allows me to use different SPI busses.
-
-As such it no longer accepts a SPIN object to be passed in to the constructor. 
+```
+  ILI9341_t3n(uint8_t _CS, uint8_t _DC, uint8_t _RST = 255, uint8_t _MOSI = 11,
+              uint8_t _SCLK = 13, uint8_t _MISO = 12);
+```
 
-However there is code in place that when the begin method is called.  The paremeters passed in for MISO/MOSI/SCK are 
-checked to see if they are valid for the SPI object.  If so SPI is used.  If not and the board type has SPI1, it will check to 
+When the begin method is called.  The parameters passed in for MISO/MOSI/SCK are checked to see if they are valid 
+for the SPI object.  If so SPI is used.  If not and the board type has SPI1, it will check to 
 see if those pins are valid for SPI1 and if so use SPI1, if not if there is an SPI2, it will check...
+```
+  void begin(uint32_t spi_clock = ILI9341_SPICLOCK,
+             uint32_t spi_clock_read = ILI9341_SPICLOCK_READ);
+```
 
-
-In addition, this code allows the ILI9341 code to work with only one hardware CS pin available, 
-which in this case must be used for the DC pin.  This is very useful to support SPI1 on the new T3.5 and T3.6 boards which only
+In addition, On Teensy 3.x boards, this code allows the ILI9341 code to work with only 
+one hardware CS pin available, which in this case must be used for the DC pin.  
+This is very useful to support SPI1 on the T3.5 and T3.6 boards which only
 have one CS pin unless you use some form of adapter to use the SPI pins that are on the SDCARD.   
 
+On Teensy 4.x including the Sparkfun Micromod Teensy, you are free to use any digital pin for CS and DC, but you might
+get a modest speed increase if hardware CS pin is used for the DC signal. 
+
+
 Frame Buffer
 ------------
-The teensy 3.6 and now 3.5 and now the T4.0 have a lot more memory than previous Teensy processors, so on these boards, I borrowed some ideas from the ILI9341_t3DMA library and added code to be able to use a logical Frame Buffer.  To enable this I added a couple of API's 
+The teensy 3.6 and now 3.5 and now the T4.x have a lot more memory than previous Teensy processors, so on these boards, 
+I borrowed some ideas from the ILI9341_t3DMA library and added code to be able to use a logical Frame Buffer.  
+To enable this I added a couple of API's 
 ```c++
     uint8_t useFrameBuffer(boolean b) - if b non-zero it will allocate memory and start using
     void	freeFrameBuffer(void) - Will free up the memory that was used.
diff --git a/library.properties b/library.properties
@@ -1,11 +1,10 @@
 name=ILI9341_t3n
-version=1.0
+version=1.1.0
 author=Limor Fried, Adafruit, Paul Stoffregen, Kurt Eckhardt
 maintainer=Kurt Eckhardt
 sentence=Optimized ILI9341 (320x240 Color TFT) Display Support different SPI buses
-paragraph=
+paragraph=ILI9341 display support for Teensy(PJRC) T3.x and T4.x boards
 category=Display
 url=https://github.com/KurtE/ILI9341_t3n
 architectures=*
 dot_a_linkage=true
-
diff --git a/src/ILI9341_t3n.cpp b/src/ILI9341_t3n.cpp
@@ -1,4 +1,4 @@
-// https://github.com/PaulStoffregen/ILI9341_t3n
+// https://github.com/KurtE/ILI9341_t3n
 // http://forum.pjrc.com/threads/26305-Highly-optimized-ILI9341-(320x240-TFT-color-display)-library
 
 /***************************************************
diff --git a/src/ILI9341_t3n.h b/src/ILI9341_t3n.h
@@ -1,13 +1,16 @@
+//***************************************************
 // https://github.com/kurte/ILI9341_t3n
 // http://forum.pjrc.com/threads/26305-Highly-optimized-ILI9341-(320x240-TFT-color-display)-library
 //
-// Warning this is Kurt's hacked up version whcih allow different SPI busses,
-// which hopefully
-//         will no longer be reliant on the SPIN library.
+// Warning this is Kurt's updated version which allows it to work on different SPI busses.
+//
+// On Teensy 3.x allows you to use on only one valid hardware CS pin  which must 
+// be used for DC
+//
+// On Teensy 4.x including Micromod you are free to use any digital pin for
+// CS and DC, but you might get a modest speed increase if hardware CS is
+// used for the DC pin
 //
-// Also allows use on only one valid CS pin on that buss, which must be used for
-// DC
-
 /***************************************************
   This is our library for the Adafruit  ILI9341 Breakout and Shield
   ----> http://www.adafruit.com/products/1651

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// https://github.com/PaulStoffregen/ILI9341_t3n`
	`1`	`+// https://github.com/KurtE/ILI9341_t3n`
`2`	`2`	`// http://forum.pjrc.com/threads/26305-Highly-optimized-ILI9341-(320x240-TFT-color-display)-library`
`3`	`3`
`4`	`4`	`/***************************************************`