Tested with STM32, example added, Readme updated

i998 · i998 · commit fac1bdbd8984 · 2021-03-04T21:18:57.000+10:00
diff --git a/NKKSmartDisplayLCD.cpp b/NKKSmartDisplayLCD.cpp
@@ -9,8 +9,8 @@ GNU General Public License,  check license.txt for more information
 All text above must be included in any redistribution
 *********************************************************************/
 /*********************************************************************
-2021-02-25
-Version: v01 , initial version
+2021-03-04
+Version: v01.0.1 , tested with STM32
 Status: Works OK 
 
 Key Features:
@@ -28,7 +28,8 @@ Key Features:
 - Can be used with Adafruit GFX Graphics core which does all the circles, text and fonts, 
   rectangles, etc. You can get it from https://github.com/adafruit/Adafruit-GFX-Library. 
   See /examples folder for implementation examples. 
-- Tested with hardware SPI for Arduino Pro Mini board   
+- Tested with hardware SPI for Arduino Pro Mini board
+- Tested with Maple Mini board and Arduino STM32 core (https://github.com/rogerclarkmelbourne/Arduino_STM32)    
 - Tested with NKK IS15EBFP4RGB-09YN LCD 64 x 32 Pushbutton, shall work with these models as well:
     S15DBFP4RGB
     IS15DBFP4RGB-09YN
diff --git a/NKKSmartDisplayLCD.h b/NKKSmartDisplayLCD.h
@@ -9,8 +9,8 @@ GNU General Public License,  check license.txt for more information
 All text above must be included in any redistribution
 *********************************************************************/
 /*********************************************************************
-2021-02-25
-Version: v01 , initial version
+2021-03-04
+Version: v01.0.1 , tested with STM32
 Status: Works OK 
 
 Key Features:
@@ -28,7 +28,8 @@ Key Features:
 - Can be used with Adafruit GFX Graphics core which does all the circles, text and fonts, 
   rectangles, etc. You can get it from https://github.com/adafruit/Adafruit-GFX-Library. 
   See /examples folder for implementation examples. 
-- Tested with hardware SPI for Arduino Pro Mini board   
+- Tested with hardware SPI for Arduino Pro Mini board  
+- Tested with Maple Mini board and Arduino STM32 core (https://github.com/rogerclarkmelbourne/Arduino_STM32)  
 - Tested with NKK IS15EBFP4RGB-09YN LCD 64 x 32 Pushbutton, shall work with these models as well:
     S15DBFP4RGB
     IS15DBFP4RGB-09YN
diff --git a/README.md b/README.md
@@ -9,13 +9,14 @@ It has been designed and tested for NKK IS15EBFP4RGB-09YN LCD 64 x 32 Pushbutton
     IS01DBFRGB
     IS15EBFP4RGB
     IS15ESBFP4RGB
+	IS15EBFP4RGB-09YN
     IS01EBFRGB
 
 With minimal changes in configuration settings it shall support other LCD resolutions if required.  
     
 The library supports: 
  1. Two image formats:    
-     - Normal GFX  (first pixel is top left corner, represented by bit0 in the first byte)
+    - Normal GFX  (first pixel is top left corner, represented by bit0 in the first byte)
     - Native NKK  (first pixel is top right corner, represented by bit7 in the first byte, as per NKK specs)
 2. Landscape (64x32) and Portrait (32x64) display configurations 	 
 3. Two formats for background colour - three bytes RGB format and native NKK format (RRGGBBxx)
@@ -56,7 +57,7 @@ The library supports:
    
    *display()* method is also used for integration with Adafruit_GFX library.	 
 	 
- 7. Use other NKK_SmartDisplayLCD library methods like *clearImageBufferGFX()*, *invertImageBufferGFX()* etc to manage content of the image bugger you use.
+ 7. Use other NKK_SmartDisplayLCD library methods like *clearImageBufferGFX()*, *invertImageBufferGFX()* etc to manage content of the image buffer you use.
 
  8. Use Adafruit_GFX_Ext object to access to Adafruit_GFX library methods like *setCursor()*, *print()*, *drawPixel()*, *fillRect()* etc to build 
    or adjust your image in the *imageBufferGFX[]* image buffer.  Do not forget to call *display()* method to transfer your image to the NKK device 
@@ -66,8 +67,12 @@ See the examples and descriptions of the library functions provided in the code
   
       
 ## Known Limitations:
-Requres a native SPI object (like Arduino one) which handles SPI communications. With a mimimal changes to the library (an update to the class constructor) it can use a separate SPI handler such as https://github.com/adafruit/Adafruit_BusIO
+Requires a native SPI object (like Arduino one) which handles SPI communications. With a mimimal changes to the library (an update to the class constructor) it can use a separate SPI handler such as https://github.com/adafruit/Adafruit_BusIO
 
+## Hardware:
+Tested with
+    - Arduino Pro Mini 
+	- Maple Mini board (STM32F103CBT6) and Arduino STM32 core (https://github.com/rogerclarkmelbourne/Arduino_STM32)  
 
 ## Repository Contents:
     /documentation - Image Builder (MS Excel file), NKK LCD 64x32 SmartDisplay application notes 
@@ -109,7 +114,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 See the GNU General Public License for more details.
 
-## Donation
+## Donation:
 If this project help you reduce your time to develop, you can give me a cup of coffee :) 
 
-[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/donate/?business=ifhone777-hub%40yahoo.com&currency_code=AUD)
+[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/donate/?business=ifhone777-hub%40yahoo.com&currency_code=USD)
diff --git a/README.txt b/README.txt
@@ -1,77 +1,82 @@
+
 ## Overview:
 This is a library for **NKK LCD 64x32 SmartDisplay** (https://www.nkkswitches.com/smartdisplay/) 
 It has been designed and tested for NKK IS15EBFP4RGB-09YN LCD 64 x 32 Pushbutton and shall work with these models as well:
+
     S15DBFP4RGB
     IS15DBFP4RGB-09YN
     S15DSBFP4RGB
     IS01DBFRGB
     IS15EBFP4RGB
     IS15ESBFP4RGB
+	IS15EBFP4RGB-09YN
     IS01EBFRGB
 
-With minimal changes in configuration settings it shall suppot other LCD resolutions if required.  
+With minimal changes in configuration settings it shall support other LCD resolutions if required.  
     
 The library supports: 
-  1. Two image formats:
-    -Normal GFX  (first pixel is top left corner, represented by bit0 in the first byte)
-    -Native NKK  (first pixel is top right corner, represented by bit7 in the first byte, as per NKK specs)
-  2. Landscape (64x32) and Portrait (32x64) display configurations 	 
-  3. Two formats for background colour - three bytes RGB format and native NKK format (RRGGBBxx)
-  4. A rotation of an image by 180 degrees to accommodate different possible footprints of an NKK device on your pcb.	
+ 1. Two image formats:    
+    - Normal GFX  (first pixel is top left corner, represented by bit0 in the first byte)
+    - Native NKK  (first pixel is top right corner, represented by bit7 in the first byte, as per NKK specs)
+2. Landscape (64x32) and Portrait (32x64) display configurations 	 
+3. Two formats for background colour - three bytes RGB format and native NKK format (RRGGBBxx)
+4. A rotation of an image by 180 degrees to accommodate different possible footprints of an NKK device on your pcb.	
 	
 ## Library usage:
-1. Create a NKK_SmartDisplayLCD object.  At this step specify: 
-    w: The NKK LCD screen width in pixels.  Maximum w is  256 and  Maximum w*h/8  = 65535 for this library code. 
-	h: The NKK LCD screen height in pixels  Maximum h is  256 and  Maximum w*h/8  = 65535 for this library code.  
-    isRotate180:  A flag to indicate that the picture need to be rotated by 180 degrees to accommodate different possible footprints of an NKK device on your pcb. Applied just before the picture is uploaded to the NKK device by the *display()* or *display_NKK()* functions.   
-    cspin: Slave Select(Chip Select) signal  (to allow use more than one NKK device with their own SS signals).
-	freqSPI: SPI frequency, Hz. 
-	pointer: A reference (pointer) to native SPI object which handles SPI communications. 
-
-2. Execute *begin()* method. That would start SPI interface and reset the NKK device.
+ 1. Create a NKK_SmartDisplayLCD object.  At this step specify: 
+    - w: The NKK LCD screen width in pixels.  Maximum w is  256 and  Maximum w x h/8  = 65535 for this library code. 
+    - h: The NKK LCD screen height in pixels  Maximum h is  256 and  Maximum w x h/8  = 65535 for this library code.  
+    - isRotate180:  A flag to indicate that the picture need to be rotated by 180 degrees to accommodate different possible footprints of an NKK device on your pcb. Applied just before the picture is uploaded to the NKK device by the *display()* or *display_NKK()* functions. 
+    - cspin: Slave Select(Chip Select) signal  (to allow use more than one NKK device with their own SS signals).
+    - freqSPI: SPI frequency, Hz. 
+    - pointer: A reference (pointer) to native SPI object which handles SPI communications. 
  
-3. Set required background colour and brightness:    
-   - By using library methods that would communicate directly to the NKK device:
+ 2. Execute *begin()* method. That would start SPI interface and reset the NKK device.
+
+ 3. Set required background colour and brightness:    
+    - By using library methods that would communicate directly to the NKK device:
         ```C++
        setColourNKK(byte data);  // set as per NKK specs (RRGGBBxx)
        setColourRGB(byte R, byte G, byte B);  // RGB get converted to the closest colour as per NKK specs (64 colours available)
        setBrightness(byte data); //set as per NKK specs  (BBBxxxxx)
        ```	   
-   - By setting library variables *bkgColour* and *bkgBrightnes*  which will be used when the *display()* and *display_NKK()* methods are called 	 
+    - By setting library variables *bkgColour* and *bkgBrightnes*  which will be used when the *display()* and *display_NKK()* methods are called 	 
 
-4. Set an image in a GFX or NKK format to library variables *imageBufferGFX[]* and *imageBufferNKK[]*.  No need to set both.
+ 4. Set an image in a GFX or NKK format to library variables *imageBufferGFX[]* and *imageBufferNKK[]*.  No need to set both.
   You can use an  NKK Bitmap bilder (MS Excel file) in the */documentation* folder to build an image in GFX or NKK formats, landscape or portrait.
-
-5. Use *drawPixel(x,y,color)* to set a pixel in the *imageBufferGFX[]*.   X and Y are pixel coordunates, starting from 0. For this monochrome 
+ 
+ 5. Use *drawPixel(x,y,color)* to set a pixel in the *imageBufferGFX[]*.   X and Y are pixel coordunates, starting from 0. For this monochrome 
   LCD display *color* can be any value, it will be converted either 0 or 1 in the library. This method is also used for integration with Adafruit_GFX library (https://github.com/adafruit/Adafruit-GFX-Library).
   
-6. Execute *display()* or *display_NKK()* methods which will do the following:  
+  6. Execute *display()* or *display_NKK()* methods which will do the following:  
      - upload an image to the NKK device from *imageBufferGFX[]* or *imageBufferNKK[]* and make the image visible.  
-	    *display()* will use *imageBufferGFX[]* as a source and will overwrite *imageBufferNKK[]*.  
-        *display_NKK()* use *imageBufferNKK[]* as a source and does NOT change *imageBufferGFX[]*.  
+        *display()* will use *imageBufferGFX[]* as a source and will overwrite *imageBufferNKK[]*.  
+         *display_NKK()* use *imageBufferNKK[]* as a source and does NOT change *imageBufferGFX[]*.  
 	AND	
 	 - set NKK device background colour and brightness as per library's variables *bkgColour* and *bkgBrightnes*.
    
    *display()* method is also used for integration with Adafruit_GFX library.	 
 	 
-7. Use other NKK_SmartDisplayLCD library methods like *clearImageBufferGFX()*, *invertImageBufferGFX()* etc to manage content of the image bugger you use.
+ 7. Use other NKK_SmartDisplayLCD library methods like *clearImageBufferGFX()*, *invertImageBufferGFX()* etc to manage content of the image buffer you use.
 
-8. Use Adafruit_GFX_Ext object to access to Adafruit_GFX library methods like *setCursor()*, *print()*, *drawPixel()*, *fillRect()* etc to build 
+ 8. Use Adafruit_GFX_Ext object to access to Adafruit_GFX library methods like *setCursor()*, *print()*, *drawPixel()*, *fillRect()* etc to build 
    or adjust your image in the *imageBufferGFX[]* image buffer.  Do not forget to call *display()* method to transfer your image to the NKK device 
    and make it visible.  
 
 See the examples and descriptions of the library functions provided in the code for more details.  
   
       
 ## Known Limitations:
-Requres a native SPI object (like Arduino one) which handles SPI communications. 
-With a mimimal changes to the library (an update to the class constructor) it can use 
-a separate SPI handler such as https://github.com/adafruit/Adafruit_BusIO
+Requires a native SPI object (like Arduino one) which handles SPI communications. With a mimimal changes to the library (an update to the class constructor) it can use a separate SPI handler such as https://github.com/adafruit/Adafruit_BusIO
 
+## Hardware:
+Tested with
+    - Arduino Pro Mini 
+	- Maple Mini board (STM32F103CBT6) and Arduino STM32 core (https://github.com/rogerclarkmelbourne/Arduino_STM32)  
 
 ## Repository Contents:
-    */documentation* - Image Builder (MS Excel file), NKK LCD 64x32 SmartDisplay application notes 
-    */examples* - examples on how the libraries can be used 
+    /documentation - Image Builder (MS Excel file), NKK LCD 64x32 SmartDisplay application notes 
+    /examples - examples on how the libraries can be used 
 
    
 ## License:
@@ -107,6 +112,4 @@ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-See the GNU General Public License for more details.
-
-
+See the GNU General Public License for more details.
diff --git a/examples/STM32_NKK_SmartDisplay_test/STM32_NKK_SmartDisplay_test.ino b/examples/STM32_NKK_SmartDisplay_test/STM32_NKK_SmartDisplay_test.ino
@@ -0,0 +1,134 @@
+/*********************************************************************
+This file is a part of a library for NKK LCD 64x32 SmartDisplay
+
+Copyright (c) 2021, IFH
+All rights reserved.
+
+GNU General Public License,  check license.txt for more information
+All text above must be included in any redistribution
+*********************************************************************/
+/*
+NKK Smart Display LCD 64*32 test code using library  NKK_SmartDisplayLCD 
+    
+ example 02- NKK as a library,
+ using Maple Mini hardware (http://docs.leaflabs.com/static.leaflabs.com/pub/leaflabs/maple-docs/0.0.12/hardware/maple-mini.html) 
+ and Arduino STM32 core (https://github.com/rogerclarkmelbourne/Arduino_STM32) 
+
+ Status: works ok
+
+
+// hardware setup for Maple Mini  
+    //Use SPI_2 as it is 5v tolerant
+    // Maple Mini SS   (NCS)  <-->  PB12 D31 pin no 31 -> NKK SS  (Signal is managed by NKK library to allow running several NKK devices with their own SS pins)
+    // Maple Mini SCK  (CLK)  <-->  PB13 D30 pin no 30 -> NKK SCK (Clock for serial communication, maximum 8 MHZ)
+    // Maple Mini MISO (SPI)  <-->  PB14 D29 pin no 29 -> NKK SDO (This is not required for NKK devices - no data output back from the NKK device) 
+    // Maple Mini MOSI (SDO)  <-->  PB15 D28 pin no 15 -> NKK SDI 
+    
+    //Please note that STM32F103CBT6 is 3.3v and NKK LCD 64x32 SmartDisplay is 5v.  While direct connection without a level shifter works with that example,
+    //such hardware setup is at your own risk.   
+*/ 
+	
+#include <SPI.h>
+#include <NKKSmartDisplayLCD.h>
+
+//Setup SPI
+#define SPIDEVICE_CS 31 //note this is for the SPI setup only. Actual SS signal is managed by NKK library to allow running several NKK devices with their own SS pins.  
+SPIClass SPI_2(2); //Create an instance of the SPI Class called SPI_2 that uses the 2nd SPI Port
+
+//Setup images 
+//Note: for simplisity we do not use PROGMEM  
+	 //"TEST 1" text with a corner white triangle *
+	byte imgTest1[] = 
+	{0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,6,0,127,131,131,241,252,0,5,0,8,4,64,16,32,0,4,128,8,0,64,16,32,0,4,64,8,0,64,16,32,0,4,0,8,0,64,16,32,0,4,0,8,0,128,16,32,0,4,0,8,1,0,240,32,0,4,0,8,2,0,16,32,0,4,0,8,4,0,16,32,0,4,0,8,4,0,16,32,128,4,0,8,4,0,16,32,192,4,0,8,4,64,16,32,160,63,128,8,3,131,240,32,144,0,0,0,0,0,0,0,136,0,0,0,0,0,0,0,132,0,0,0,0,0,0,0,130,0,0,0,0,0,0,0,129,0,0,0,0,0,0,0,128,128,0,0,0,0,0,0,128,64,0,0,0,0,0,0,128,32,0,0,0,0,0,0,128,16,0,0,0,0,0,0,128,8,0,0,0,0,0,0,128,4,0,0,0,0,0,0,128,2,0,0,0,0,0,0,128,1,0,0,0,0,0,0,255,255,128,0,0,0,0,0
+	};
+
+	 // Test GFX - landscape
+	byte imgGFX1[] = 
+	{0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,252,241,131,131,127,0,0,0,32,16,64,4,8,0,0,0,32,16,64,0,8,224,125,17,32,16,64,0,8,16,4,10,32,16,64,0,8,16,4,4,32,16,128,0,8,144,61,4,32,240,0,1,8,16,5,4,32,16,0,2,8,16,5,10,32,16,0,4,8,224,4,17,32,16,0,4,8,0,0,0,32,16,0,4,8,0,0,128,32,16,64,4,8,0,0,192,32,240,131,3,8,0,0,160,0,0,0,0,0,0,0,144,0,0,0,0,0,0,0,136,0,0,0,0,0,0,0,132,0,0,0,0,0,0,0,130,0,0,0,0,0,0,0,129,0,0,0,0,0,0,128,128,0,0,0,0,0,0,64,129,0,0,0,0,0,0,32,130,0,0,0,0,0,0,16,132,0,0,0,0,0,0,8,136,0,0,0,0,0,0,4,144,0,0,0,0,0,0,2,160,0,0,0,0,0,0,1,192,0,0,0,0,0,128,255,255
+	};
+
+	// Test GFX - portrait
+	byte imgGFX2[] = 
+	{0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,248,253,152,31,248,253,164,31,96,12,6,6,96,12,6,6,96,12,6,6,96,12,4,6,96,60,8,6,96,12,16,6,96,12,32,6,96,12,96,6,96,12,96,6,96,12,96,6,96,252,36,6,96,252,24,6,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,128,247,69,0,64,16,40,0,64,16,16,0,64,246,16,0,64,20,16,0,64,20,40,0,128,19,68,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,128,0,0,0,64,0,0,0,32,0,0,0,16,0,0,0,8,32,0,0,4,112,0,0,2,168,0,0,1,36,1,128,0,32,0,64,0,32,0,32,0,32,0,16,0,32,0,8,0,32,0,20,0,32,0,34,0,32,0,65,0,32,128,128,0,32,64,0,1,32,32,0,2,0,16,0,4,0,8,0,8,0,4,0,16,0,2,0,32,0,1,0,64,128,0,0,128
+	};
+
+
+// Initialise NKK device
+	  //Landscape
+	NKK_SmartDisplayLCD NKK = NKK_SmartDisplayLCD(64,32,0,SPIDEVICE_CS,1000000,&SPI_2); 
+	  //Portrait,with 180 rotation
+    //NKK_SmartDisplayLCD NKK = NKK_SmartDisplayLCD(32,64,1,SPIDEVICE_CS,1000000);
+
+
+    
+void setup() {
+  pinMode(SPIDEVICE_CS, OUTPUT);
+
+  //==============================
+   Serial.begin(9600);
+   //Serial.begin(115200);
+   //The program will wait for serial to be ready up to 10 sec then it will continue anyway  
+     for (int i=1; i<=10; i++){
+          delay(1000);
+     if (Serial){
+         break;
+       }
+     }
+    Serial.println("Setup() started ");
+  //===============================
+
+
+//start SPI interface
+  SPI_2.begin();
+	  
+// start NKK device
+  NKK.begin(); 
+  
+}
+
+
+void loop() {
+
+
+  NKK.reset();
+  
+//test NKK colours   
+  NKK.setColourNKK(255);  //White
+  NKK.setBrightness(255);
+  delay (1000);
+  NKK.setColourNKK(195);  //Red
+  delay (1000);
+  NKK.setColourNKK(51);   //Green 
+  delay (1000);
+  NKK.setColourNKK(15);  //Blue 
+  delay (1000); 
+  NKK.setColourNKK(255);  //White
+  delay (1000);
+
+//test NKK image transfer 
+  for(uint16_t i=0; i<256; i++)
+	   {
+		   NKK.imageBufferNKK[i] = imgTest1[i];
+	   }
+   NKK.display_NKK();
+   delay (2000);
+
+ 
+//test RGB colour 
+  NKK.setColourRGB(255,255,0);  // set Yellow
+  //delay (1000);  
+
+// test GFX image transfer  
+  for(uint16_t i=0; i<256; i++)
+    {
+        NKK.imageBufferGFX[i] = imgGFX1[i];
+ 
+    }
+  NKK.display();
+  delay (2000);
+ 
+ 
+  
+}// End of the Loop
+
+
