New Display documentation and updates to existing documents

gavrilyak · Feb 27, 2019 · 581de9e · 581de9e
1 parent 772024a
commit 581de9e
Show file tree

Hide file tree

Showing 19 changed files with 217 additions and 7 deletions.
diff --git a/documentation/displays/images/ESP32-display-wiring.jpg b/documentation/displays/images/ESP32-display-wiring.jpg
diff --git a/documentation/displays/images/adafruit-OLED-wiring.png b/documentation/displays/images/adafruit-OLED-wiring.png
diff --git a/documentation/displays/images/adafruit-oled.jpg b/documentation/displays/images/adafruit-oled.jpg
diff --git a/documentation/displays/images/buydisplay+esp-wiring.png b/documentation/displays/images/buydisplay+esp-wiring.png
diff --git a/documentation/displays/images/eink+adaptor+esp-wiring.png b/documentation/displays/images/eink+adaptor+esp-wiring.png
diff --git a/documentation/displays/images/eink-display.jpeg b/documentation/displays/images/eink-display.jpeg
diff --git a/documentation/displays/images/kuzyatech-breakout.jpg b/documentation/displays/images/kuzyatech-breakout.jpg
diff --git a/.../spi_serial_2.8_inch_320x240_tft_lcd_display_module_ili9341_arduino_stm32_1.jpg b/.../spi_serial_2.8_inch_320x240_tft_lcd_display_module_ili9341_arduino_stm32_1.jpg
diff --git a/documentation/displays/images/switch-science-LCD-relective-display.jpg b/documentation/displays/images/switch-science-LCD-relective-display.jpg
diff --git a/documentation/displays/images/switch-science-esp-wiring.png b/documentation/displays/images/switch-science-esp-wiring.png
diff --git a/documentation/displays/wiring-guide-adafruit-OLED.md b/documentation/displays/wiring-guide-adafruit-OLED.md
@@ -0,0 +1,45 @@
+# Wiring Guides for Moddable supported SPI displays
+
+Copyright 2018 Moddable Tech, Inc.  
+Revised: January 2, 2018
+
+
+## Adafruit OLED display
+**Part:** Adafruit Product ID: 1431 
+
+**Size:** 1.5", 128 × 128
+
+**Type:** OLED
+
+**Interface:** SPI
+
+**Drivers:** video [SSD1351](../../documentation/drivers/ssd1351/ssd1351.md), No touch
+
+**Availability:** [1.5" OLED Breakout Board] (https://www.adafruit.com/product/1431)
+
+**Description:** Excellent color, small OLED. 
+![Generic SPI Display](images/adafruit-oled.jpg)
+
+**Moddable Sample code:** The Piu example [transitions](../../examples/piu/transitions/) is good for testing this display. The build command below includes the -d, debug flag.
+
+```
+cd $MODDABLE/examples/piu/transitions
+mcconfig -d -m -r 0 -f rgb332 -p esp screen=ssd1351 touch="" 
+```
+
+
+**ESP8266 Pinout:**
+
+| Adafruit OLED | ESP8266 | ESP8266 Devboard label
+| --- | --- | --- |
+| GND | GND | 
+| VIN | 3.3v | 
+| 3Vo | 3.3v | 
+| OLEDCS | GPIO 15| (D8)
+| RESET | 3.3v  | 
+| DC | GPIO 2 | (D4)
+| SCK | GPIO 14 | (D5)
+| MOSI | GPIO 13 | (D7)
+
+![Generic 2.4"-2.8" wiring illustration](images/adafruit-oled-wiring.png)
+
diff --git a/documentation/displays/wiring-guide-crystalfontz-eink.md b/documentation/displays/wiring-guide-crystalfontz-eink.md
@@ -0,0 +1,54 @@
+# Wiring Guides for Moddable supported SPI displays
+
+Copyright 2018 Moddable Tech, Inc.  
+Revised: January 2, 2018
+
+
+## Crystalfontz ePaper display
+**Part:** CFAP128296C0-0290  
+[Datasheet] (https://www.crystalfontz.com/products/document/3660/CFAP128296C0-0290DatasheetReleaseDate2017-08-14.pdf)
+
+**Size:**  2.9" 128x296 
+
+**Type:** EPD (Electronic Paper Displays)
+
+**Interface:** SPI
+
+**Drivers:** video [destm32s](../../documentation/drivers/destm32s/destm32s.md), No touch
+
+**Availability:** [128x296 ePaper Display] (https://www.crystalfontz.com/product/cfap128296c00290-128x296-epaper-display-eink)
+
+**Description:** This is a TFT active matrix electrophoretic display (ePaper/E-Ink) with 1-bit white/black full display capabilities.
+
+One benefit of this display is very low power consumption. The only time you need to provide power to this ePaper module is while updating the display. Once the image is displayed you can remove the power source and the display will continue to display the image appropriately.
+
+We used the destm32s adaptor board to interface with the display. See: Crystalfontz part CFAP128296C0-E1-1 on the [display product](https://www.crystalfontz.com/product/cfap128296c00290-128x296-epaper-display-eink) page.
+
+
+![Generic SPI Display](images/eink-display.jpeg)
+
+**Moddable Sample code:** The Piu example [love-e-ink](../../examples/piu/love-e-ink/) is good for testing this display. The build command below includes the -d, debug flag.
+
+```
+cd $MODDABLE/examples/piu/love-e-ink
+mcconfig -d -m -p esp -f gray256 -r 270  
+```
+
+
+**ESP8266 Pinout:**
+
+| eInk Display | ESP8266 | ESP8266 Devboard label
+| --- | --- | --- |
+| 3 - GND | GND | 
+| 5 - 3.3v | 3.3v | 
+| 13 - SCK | GPIO 14 | (D5)
+| 14 - SDI | GPIO 13 | (D7)
+| 15 - DC | GPIO 2 | (D4) 
+| 16 - CS | GPIO 15 | (D8) 
+| 17 - BUSY | GPIO 5 | (D1)
+| 18 - Reset | 3.3v |
+| 19 - BUSSEL | GND |  
+
+
+![Generic 2.4"-2.8" wiring illustration](images/eink+adaptor+esp-wiring.png)
+
diff --git a/documentation/displays/wiring-guide-generic-1.44-spi.md b/documentation/displays/wiring-guide-generic-1.44-spi.md
@@ -9,6 +9,8 @@ Revised: January 2, 2018
 
 **Type:** TFT LCD
 
+**Interface:** SPI
+
 **Drivers:** video [ST7735](../../documentation/drivers/st7735/st7735.md), no touch
 
 **Availability:** [Generic 1.44" SPI Displays on eBay] (https://www.ebay.com/sch/i.html?_odkw=spi+display&_osacat=0&_from=R40&_trksid=p2045573.m570.l1313.TR0.TRC0.H0.Xspi+display+1.44%22.TRS1&_nkw=spi+display+1.44%22&_sacat=0)
@@ -17,7 +19,7 @@ Revised: January 2, 2018
 
 ![Generic SPI Display](images/generic-1.44-display.jpg)
 
-**Moddable Sample code:** The Piu example [Transitions](../../examples/piu/transitions/) is good for testing this display. The build command below includes the -d, debug flag so requires XSBug to be launched to run.
+**Moddable Sample code:** The Piu example [Transitions](../../examples/piu/transitions/) is good for testing this display. The build command below includes the -d, debug flag.
 
 ```
 cd $MODDABLE/examples/piu/transitions

diff --git a/documentation/displays/wiring-guide-generic-2.4-spi.md b/documentation/displays/wiring-guide-generic-2.4-spi.md
@@ -9,6 +9,8 @@ Revised: January 2, 2018
 
 **Type:** TFT LCD
 
+**Interface:** SPI
+
 **Drivers:** video [ILI9341](../../documentation/drivers/ili9341/ili9341.md), touch XPT2046
 
 **Availability:** [Generic SPI Displays on eBay] (https://www.ebay.com/sch/i.html?_odkw=spi+display+2.4&_osacat=0&_from=R40&_trksid=p2045573.m570.l1313.TR0.TRC0.H0.Xspi+display+2.4+touch.TRS0&_nkw=spi+display+2.4+touch&_sacat=0)
@@ -17,7 +19,7 @@ Revised: January 2, 2018
 
 ![Generic SPI Display](images/spi-touch-display.jpg)
 
-**Moddable Sample code:** The Piu example [Drag](../../examples/piu/drag/) is good for testing this display. The build command below includes the -d, debug flag so requires XSBug to be launched to run.
+**Moddable Sample code:** The Piu example [Drag](../../examples/piu/drag/) is good for testing this display. The build command below includes the -d, debug flag.
 
 ```
 cd $MODDABLE/examples/piu/drag

diff --git a/documentation/displays/wiring-guide-generic-2.8-CPT-spi.md b/documentation/displays/wiring-guide-generic-2.8-CPT-spi.md
@@ -0,0 +1,55 @@
+# Wiring Guides for Moddable supported SPI displays
+
+Copyright 2018 Moddable Tech, Inc.  
+Revised: January 2, 2018
+
+
+## BuyDisplay 2.8" CTP display
+**Part:** ER-TFTM028-4 LCD w/Capacitive Touch Screen Module  
+[Datasheet](http://www.buydisplay.com/download/manual/ER-TFTM028-4_Datasheet.pdf)
+
+**Size:** 2.8", 320 x 240
+
+**Type:** TFT LCD
+
+**Interface:** SPI
+
+**Drivers:** video [ILI9341](../../documentation/drivers/ili9341/ili9341.md), touch FT6206
+
+**Availability:** [2.8" BuyDisplay CTP display] (http://www.buydisplay.com/default/2-8-inch-tft-touch-shield-for-arduino-w-capacitive-touch-screen-module)
+
+**Description:** This BuyDisplay screen is highly configurable and can be ordered with varying touch modules, main power voltage and connection types. This sample is for the 3.3v CTP version.
+
+This display supports many configurations. For this sample Moddable configured the display  IMO settings to support 4 wire SPI. See the ER-TFTM028-4 [datasheet](http://www.buydisplay.com/download/manual/ER-TFTM028-4_Datasheet.pdf). The jumper settings below are open or closed drag solder pads on the PCB.
+
+| IMO Mode | Jumper settings
+| --- | --- |
+| 4-wire SPI Interface | J2,J3,J4,J5 Short and J1, J6, J7, J8 Open.  R1-R10=0R, R19=0R, R21-R28=0R. R17, R18, R20 not soldered.
+
+
+![Generic SPI Display](images/spi_serial_2.8_inch_320x240_tft_lcd_display_module_ili9341_arduino_stm32_1.jpg)
+
+**Moddable Sample code:** The Piu example [Drag](../../examples/piu/drag/) is good for testing this display. The build command below includes the -d, debug flag.
+
+```
+cd $MODDABLE/examples/piu/drag
+mcconfig -d -m -r 0 -f rgb565le -p esp screen=ili9341 touch=ft6206  
+```
+
+
+**ESP8266 Pinout:**
+
+| BuyDisplay CTP Display | ESP8266 | ESP8266 Devboard label
+| --- | --- | --- |
+| 1 - VSS | GND | 
+| 2 - VDD | 3.3V | 
+| 21 - Reset | 3.3v  |  
+| 23 - CS | GPIO 15 | (D8) 
+| 24 - SCK | GPIO 14 | (D5)
+| 25 - DC | GPIO 2 | (D4)  
+| 27 - SDI | GPIO 13 | (D7)
+| 28 - CPT SDL | GPIO 4 | (D2)
+| 31  -CPT SDA | GPIO 5 | (D1) 
+
+![Generic 2.4"-2.8" wiring illustration](images/buydisplay+esp-wiring.png)
+
diff --git a/documentation/displays/wiring-guide-sharp-memory-1.3-spi.md b/documentation/displays/wiring-guide-sharp-memory-1.3-spi.md
@@ -12,17 +12,21 @@ Revised: January 2, 2018
 
 **Type:** LCD, Monochrome
 
+**Interface:** SPI
+
 **Drivers:** video [ls013b4dn04](../../documentation/drivers/ls013b4dn04/ls013b4dn04.md), no touch
 
-**Availability:** [Sharp Memory Monochrome Display on Adafruit] (https://www.adafruit.com/product/3502)  
-[Sharp Memory Silver Display on Digi-Key] (https://www.digikey.com/product-detail/en/1393/1528-1183-ND/5353643)
+**Availability:**  
+[Sharp Memory Monochrome Display on Adafruit] (https://www.adafruit.com/product/3502)  
+[Sharp Memory Reflective Display on Digi-Key] (https://www.digikey.com/product-detail/en/1393/1528-1183-ND/5353643)  
+[Sharp Memory Reflective Display on Sparkfun](https://www.sparkfun.com/products/retired/13192)
 
 **Description:** These interesting displays have the ultra-low power usage of eInk and the fast-refresh rates of an LCD. The [older 96 x 96 version] (https://www.adafruit.com/product/1393) has an mirror-like display where the active pixels are reflective.
 
 
 ![Sharp Memory Display 1.3"](images/sharp-memory-display-1.3.jpg)
 
-**Moddable Sample code:** The Piu example [Balls](../../examples/piu/balls/) is good for testing this display. The build command below includes the -d, debug flag so requires XSBug to be launched to run.
+**Moddable Sample code:** The Piu example [Balls](../../examples/piu/balls/) is good for testing this display. The build command below includes the -d, debug flag.
 
 ```
 cd $MODDABLE/examples/piu/balls

diff --git a/documentation/displays/wiring-guide-sharp-memory-2.7-spi.md b/documentation/displays/wiring-guide-sharp-memory-2.7-spi.md
@@ -11,6 +11,8 @@ Revised: January 2, 2018
 
 **Type:** Sharp Memory TFT-LCD, Monochrome
 
+**Interface:** SPI
+
 **Drivers:** video [ls013b4dn04](../../documentation/drivers/ls013b4dn04/ls013b4dn04.md), no touch
 
 **Availability:** [Sharp Memory 2,7" LCD on Digi-Key] (https://www.digikey.com/product-detail/en/sharp-microelectronics/LS027B7DH01A/425-2908-ND/5054067?utm_adgroup=Optoelectronics&gclid=Cj0KCQiAvrfSBRC2ARIsAFumcm-L2iz88RlcYf9Z1MU0J1ZW97VgAa0oPoDBgqYSIIRUyZnhGNURyY4aAjIgEALw_wcB)
@@ -22,7 +24,7 @@ Moddable used the [Kuzyatech Sharp Memory display breakout board] (https://www.t
 
 ![Generic SPI Display](images/Sharp_Memory_LCD_LS027B7DH01.jpg)
 
-**Moddable Sample code:** The Piu example [Balls](../../examples/piu/balls/) is good for testing this display. The build command below includes the -d, debug flag so requires XSBug to be launched to run.
+**Moddable Sample code:** The Piu example [Balls](../../examples/piu/balls/) is good for testing this display. The build command below includes the -d, debug flag.
 
 ```
 cd $MODDABLE/examples/piu/balls

diff --git a/documentation/displays/wiring-guide-sparkFun-teensyview-spi.md b/documentation/displays/wiring-guide-sparkFun-teensyview-spi.md
@@ -11,6 +11,8 @@ Revised: January 2, 2018
 
 **Type:** OLED, Monochrome
 
+**Interface:** SPI
+
 **Drivers:** video [SSD1306](../../documentation/drivers/ssd1306/ssd1306.md), no touch
 
 **Availability:** [TeensyView on Sparkfun] (https://www.sparkfun.com/products/14048)
@@ -20,7 +22,7 @@ Revised: January 2, 2018
 
 ![Generic SPI Display](images/teensyview.jpg)
 
-**Moddable Sample code:** The Piu example [Balls](../../examples/piu/balls/) is good for testing this display. The build command below includes the -d, debug flag so requires XSBug to be launched to run.
+**Moddable Sample code:** The Piu example [Balls](../../examples/piu/balls/) is good for testing this display. The build command below includes the -d, debug flag.
 
 ```
 cd $MODDABLE/examples/piu/balls

diff --git a/documentation/displays/wiring-guide-switch-science-LCD.md b/documentation/displays/wiring-guide-switch-science-LCD.md
@@ -0,0 +1,44 @@
+# Wiring Guides for Moddable supported SPI displays
+
+Copyright 2018 Moddable Tech, Inc.  
+Revised: January 2, 2018
+
+
+## Switch Science reflective LCD display
+**Part:** 2858: JDI - REFLCD - 128 
+
+**Size:** 1.28", 176 × 176
+
+**Type:** Color reflective LCD (no backlight)
+
+**Interface:** SPI
+
+**Drivers:** video [lpm013m126a](../../documentation/drivers/lpm013m126a/lpm013m126a.md), No touch
+
+**Availability:** [1.28" Switch Science Color reflective LCD] (https://translate.google.com/translate?hl=en&sl=ja&tl=en&u=https%3A%2F%2Fwww.switch-science.com%2Fcatalog%2F2874%2F)
+
+**Description:** Moddable purchased this display in Tokyo. [Here](https://translate.googleusercontent.com/translate_c?depth=1&hl=en&rurl=translate.google.com&sl=ja&sp=nmt4&tl=en&u=https://www.switch-science.com/catalog/2858/&usg=ALkJrhijtlYZnC4qJ2sRkLE3mkVZujVU1w) is some info on the display.
+
+![Generic SPI Display](images/switch-science-LCD-relective-display.jpg)
+
+**Moddable Sample code:** The Piu example [transitions](../../examples/piu/transitions/) is good for testing this display. The build command below includes the -d, debug flag.
+
+```
+cd $MODDABLE/examples/piu/transitions
+mcconfig -d -m -r 0 -f rgb332 -p esp screen=lpm013m126a touch="" 
+```
+
+
+**ESP8266 Pinout:**
+
+| Switch Science LCD | ESP8266 | ESP8266 Devboard label
+| --- | --- | --- |
+| 14 - SCLK | GPIO 14 | (D5)
+| 13 - SI | GPIO 13 | (D7) 
+| 15 - SCS | GPIO 15 | (D8)
+| DISP | 3.3v | 
+| GND | GND | 
+| VIN | 3.3v | 
+
+![Generic 2.4"-2.8" wiring illustration](images/switch-science-esp-wiring.png)
+