From fbf0cf1583074ddee73b881f8fc899cad628901b Mon Sep 17 00:00:00 2001 From: prenticedavid Date: Mon, 30 Jan 2017 20:51:35 +0000 Subject: [PATCH] Update instructions --- README.md | 15 ++++++++++----- extras/mcufriend_how_to.txt | 9 ++++----- 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 31a11ec..4669915 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,25 @@ #MCUFRIEND_kbv Library for Uno 2.4, 2.8, 3.5, 3.6, 3.95 inch mcufriend Shields -1. Install "Adafruit_GFX.h" library from GitHub into your User libraries folder if not already there. +1. The Arduino Library Manager should find and install MCUFRIEND_kbv library -2. Unzip the attached "MCUFRIEND_kbv.zip" into your User libraries folder. +2. Install the Adafruit_GFX library if not already in your User libraries. 3. Insert your Mcufriend style display shield into UNO. Only 28-pin shields are supported. -4. Start your Arduino IDE. - -5. Build any of the Examples from the File->Examples->Mcufriend_kbv menu. e.g. +4. Build any of the Examples from the File->Examples->Mcufriend_kbv menu. e.g. graphictest_kbv.ino: shows all the methods. LCD_ID_readreg.ino: diagnostic check to identify unsupported controllers. +MCUFRIEND_kbv inherits all the methods from the +[url=https://learn.adafruit.com/adafruit-gfx-graphics-library/overview]Adafruit_GFX class[/url] and +[url=https://www.arduino.cc/en/Serial/Print]Print class[/url] + +The only "new" methods are hardware related: +vertScroll(), readGRAM(), readPixel(), setAddrWindow(), pushColors(), readID(), begin() +readReg(), pushCommand() access the controller registers HOW TO INSTALL AND USE: is now in "mcufriend_how_to.txt" diff --git a/extras/mcufriend_how_to.txt b/extras/mcufriend_how_to.txt index d6a8720..295dd5b 100644 --- a/extras/mcufriend_how_to.txt +++ b/extras/mcufriend_how_to.txt @@ -1,13 +1,12 @@ -1. Install "Adafruit_GFX.h" library from GitHub into your User libraries folder if not already there. +1. The Arduino Library Manager should find and install MCUFRIEND_kbv library -2. Unzip the attached "MCUFRIEND_kbv.zip" into your User libraries folder. +2. Install the Adafruit_GFX library if not already in your User libraries. 3. Insert your Mcufriend style display shield into UNO. Only 28-pin shields are supported. -4. Start your Arduino IDE. +4. Build any of the Examples from the File->Examples->Mcufriend_kbv menu. e.g. graphictest_kbv.ino -5. Build any of the Examples from the File->Examples->Mcufriend_kbv menu. -Most of them will write some text to the Serial window (9600 baud). The BMP examples require you to copy the pictures from the bitmaps/ folder to your microSD (root directory) +5. Most of them will write some text to the Serial window (9600 baud). The BMP examples require you to copy the pictures from the bitmaps/ folder to your microSD (root directory) 6. This library is only intended for UNO and these specific Shields. It will work on a MEGA2560 but not very fast.