From 7ccf2acfe0ed3d5c41103a0e56eafd5cc4d89897 Mon Sep 17 00:00:00 2001 From: prenticedavid Date: Sat, 19 Mar 2016 21:13:10 +0000 Subject: [PATCH] split readme into README.md, how_to, history --- README.md | 64 ++++-------------------------------------- mcufriend_how_to.txt | 66 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+), 58 deletions(-) create mode 100644 mcufriend_how_to.txt diff --git a/README.md b/README.md index 97d0b59..b15a434 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -1. Install library from GitHub into your User libraries folder if not already there. +1. Install "Adafruit_GFX.h" library from GitHub into your User libraries folder if not already there. 2. Unzip the attached "MCUFRIEND_kbv.zip" into your User libraries folder. @@ -6,61 +6,9 @@ 4. Start your Arduino IDE. -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. 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. -6. This library is only intended for UNO and these specific Shields. It will work on a MEGA2560 but not very fast. - -7. The constructor takes no arguments (because it only works with these shields) - -8. The examples are the standard Adafruit ones. You can see my edits by searching for "kbv" - -9. Any Adafruit sketch should work with the MCUFRIEND_kbv constructor() but should allow extra ID values -An Adafruit constructor(cs, rs, wr, rd, rst) IGNORES any arguments. i.e. it only uses the shield control pins - -10. It currently supports UNO shields with "mcufriend.com" pcbs with controllers: ------ HX8347-A 240x320 ID=0x8347 new Untested -HX8347-D 240x320 ID=0x4747 -HX8347-I 240x320 ID=0x9595 -ILI9302 240x320 ID=0x9302 -ILI9320 240x320 ID=0x9320 -ILI9325 240x320 ID=0x9325 -ILI9327 240x400 ID=0x9327 -ILI9329 240x320 ID=0x9329 -ILI9335 240x320 ID=0x9335 -ILI9338 240x320 ID=0x9338 -ILI9341 240x320 ID=0x9341 -ILI9481 320x480 ID=0x9481 -ILI9486 320x480 ID=0x9486 -ILI9488 320x480 ID=0x9488 -LGDP4535 240x320 ID=0x4535 -RM68090 240x320 ID=0x6809 -R61505V 240x320 ID=0xB505 -R61505W 240x320 ID=0xC505 new Untested -R61509V 240x400 ID=0xB509 ------ S6D0139 240x320 ID=0x0139 removed due to lack of tester -S6D0154 240x320 ID=0x0154 -SPFD5408 240x320 ID=0x5408 ------ SSD1963 800x480 ID=0x1963 new Untested -SSD1289 240x320 ID=0x1289 -ST7781 240x320 ID=0x7783 -ST7789V 240x320 ID=0x7789 - -11. It should run on a UNO, MEGA2560, LEONARDO, DUE, ZERO and M0-PRO. - -12. These Mcufriend-style shields tend to have a resistive TouchScreen on A1, 7, A2, 6 but are not always the same rotation of direction. -Run the TouchScreen_Calibr_kbv.ino sketch to diagnose your model and then scale the result from TouchScreen.h methods() -The Resistive TouchScreen does not work on the Due. It seems to be upset by sharing pins. I have discovered why. -(You need a new Touch library.) - -13. The aspect_kbv.ino sketch should show the 4 different rotations. Please report the results for an ILI9335, ILI9327. - -14. The scroll_kbv.ino sketch should scroll a window or subwindow for most chips. Not all chips can scroll. - -15. The readpixel_kbv.ino sketch should display memory in each aspect. - -16. The GLUE_Demo_320x240.ino sketch uses a "GLUE" class to display a UTFT sketch on supported mcufriend shields. - It is NOT perfect. Please report any problems. It is designed as a CONVENIENCE for legacy UTFT code. - Please use MCUFRIEND_kbv method()s in new code. - -CHANGE HISTORY: is now in "mcufriend_history.txt" +HOW TO INSTALL AND USE: is now in "mcufriend_how_to.txt" +CHANGE HISTORY: is now in "mcufriend_history.txt" diff --git a/mcufriend_how_to.txt b/mcufriend_how_to.txt new file mode 100644 index 0000000..d1f0a8f --- /dev/null +++ b/mcufriend_how_to.txt @@ -0,0 +1,66 @@ +1. Install "Adafruit_GFX.h" library from GitHub into your User libraries folder if not already there. + +2. Unzip the attached "MCUFRIEND_kbv.zip" into your User libraries folder. + +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. +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. + +7. The constructor takes no arguments (because it only works with these shields) + +8. The examples are the standard Adafruit ones. You can see my edits by searching for "kbv" + +9. Any Adafruit sketch should work with the MCUFRIEND_kbv constructor() but should allow extra ID values +An Adafruit constructor(cs, rs, wr, rd, rst) IGNORES any arguments. i.e. it only uses the shield control pins + +10. It currently supports UNO shields with "mcufriend.com" pcbs with controllers: +----- HX8347-A 240x320 ID=0x8347 new Untested +HX8347-D 240x320 ID=0x4747 +HX8347-I 240x320 ID=0x9595 +ILI9302 240x320 ID=0x9302 +ILI9320 240x320 ID=0x9320 +ILI9325 240x320 ID=0x9325 +ILI9327 240x400 ID=0x9327 +ILI9329 240x320 ID=0x9329 +ILI9335 240x320 ID=0x9335 +ILI9338 240x320 ID=0x9338 +ILI9341 240x320 ID=0x9341 +ILI9481 320x480 ID=0x9481 +ILI9486 320x480 ID=0x9486 +ILI9488 320x480 ID=0x9488 +LGDP4535 240x320 ID=0x4535 +RM68090 240x320 ID=0x6809 +R61505V 240x320 ID=0xB505 +R61505W 240x320 ID=0xC505 new Untested +R61509V 240x400 ID=0xB509 +----- S6D0139 240x320 ID=0x0139 removed due to lack of tester +S6D0154 240x320 ID=0x0154 +SPFD5408 240x320 ID=0x5408 +----- SSD1963 800x480 ID=0x1963 new Untested +SSD1289 240x320 ID=0x1289 +ST7781 240x320 ID=0x7783 +ST7789V 240x320 ID=0x7789 + +11. It should run on a UNO, MEGA2560, LEONARDO, DUE, ZERO and M0-PRO. + +12. These Mcufriend-style shields tend to have a resistive TouchScreen on A1, 7, A2, 6 but are not always the same rotation of direction. +Run the TouchScreen_Calibr_kbv.ino sketch to diagnose your model and then scale the result from TouchScreen.h methods() +The Resistive TouchScreen does not work on the Due. It seems to be upset by sharing pins. I have discovered why. +(You need a new Touch library.) + +13. The aspect_kbv.ino sketch should show the 4 different rotations. Please report the results for an ILI9335, ILI9327. + +14. The scroll_kbv.ino sketch should scroll a window or subwindow for most chips. Not all chips can scroll. + +15. The readpixel_kbv.ino sketch should display memory in each aspect. + +16. The GLUE_Demo_320x240.ino sketch uses a "GLUE" class to display a UTFT sketch on supported mcufriend shields. + It is NOT perfect. Please report any problems. It is designed as a CONVENIENCE for legacy UTFT code. + Please use MCUFRIEND_kbv method()s in new code. + +CHANGE HISTORY: is now in "mcufriend_history.txt"