ESP8266 subplatforms, wiring guide updates, etc.

gavrilyak · Feb 27, 2019 · ce088d6 · ce088d6
1 parent 9e6ed10
commit ce088d6
Show file tree

Hide file tree

Showing 18 changed files with 285 additions and 189 deletions.
diff --git a/build/devices/esp/targets/adafruit_oled/manifest.json b/build/devices/esp/targets/adafruit_oled/manifest.json
@@ -0,0 +1,10 @@
+{
+	"include": [
+		"$(MODULES)/drivers/ssd1351/manifest.json",
+	],
+	"config": {
+		"screen": "ssd1351",
+		"touch": "",
+		"format": "RGB565LE",
+	},
+}
diff --git a/build/devices/esp/targets/crystalfontz_monochrome_epaper/manifest.json b/build/devices/esp/targets/crystalfontz_monochrome_epaper/manifest.json
@@ -0,0 +1,16 @@
+{
+	"include": [
+		"$(MODULES)/drivers/destm32s/manifest.json",
+	],
+	"config": {
+		"screen": "destm32s",
+		"touch": "",
+		"format": "Gray256",
+	},
+	"defines": {
+		"destm32s": {
+			"width": 122,
+			"height": 250,
+		}
+	}
+}
diff --git a/build/devices/esp/targets/sharp_memory/manifest.json b/build/devices/esp/targets/sharp_memory/manifest.json
@@ -0,0 +1,18 @@
+{
+	"include": [
+		"$(MODULES)/drivers/ls013b4dn04/manifest.json",
+	],
+	"config": {
+		"screen": "ls013b4dn04",
+		"touch": "",
+		"format": "Gray256",
+	},
+	"defines": {
+		"ls013b4dn04": {
+			"width": 400,
+			"height": 240,
+			"cs_pin": 4,
+			"spi_port": "#HSPI",
+		}
+	}
+}
diff --git a/build/devices/esp/targets/sparkfun_teensyview/manifest.json b/build/devices/esp/targets/sparkfun_teensyview/manifest.json
@@ -0,0 +1,15 @@
+{
+	"include": [
+		"$(MODDABLE)/modules/drivers/ssd1306/manifest_spi.json",
+	],
+	"config": {
+		"screen": "ssd1306",
+		"touch": "",
+		"format": "Gray256",
+	},
+	"defines": {
+		"ssd1306": {
+			"dither": true,
+		}
+	},
+}
diff --git a/build/devices/esp/targets/switch_science_reflective_lcd/manifest.json b/build/devices/esp/targets/switch_science_reflective_lcd/manifest.json
@@ -0,0 +1,10 @@
+{
+	"include": [
+		"$(MODULES)/drivers/lpm013m126a/manifest.json",
+	],
+	"config": {
+		"screen": "lpm013m126a",
+		"touch": "",
+		"format": "RGB332",
+	},
+}
diff --git a/documentation/displays/wiring-guide-adafruit-OLED.md b/documentation/displays/wiring-guide-adafruit-OLED.md
@@ -1,35 +1,33 @@
-# Wiring Guides for Moddable supported SPI displays
+# Adafruit OLED Display Wiring Guide
 
 Copyright 2018 Moddable Tech, Inc.  
-Revised: January 2, 2018
+Revised: October 23, 2018
 
+<img src="images/adafruit-oled.jpg" height=225>
 
-## Adafruit OLED display
-**Part:** Adafruit Product ID: 1431 
+## Specs
 
-**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.
+| | |
+| :---: | :--- |
+| **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.
+## Moddable example code
+
+The [countdown](../../examples/piu/countdown/) example is good for testing this display. To run a debug build, use the following build command:
 
 ```
-cd $MODDABLE/examples/piu/transitions
-mcconfig -d -m -r 0 -f rgb332 -p esp screen=ssd1351 touch="" 
+cd $MODDABLE/examples/piu/countdown
+mcconfig -d -m -p esp/adafruit_oled
 ```
 
-
-**ESP8266 Pinout:**
+## ESP8266 pinout
 
 | Adafruit OLED | ESP8266 | ESP8266 Devboard label
 | --- | --- | --- |

diff --git a/documentation/displays/wiring-guide-crystalfontz-eink.md b/documentation/displays/wiring-guide-crystalfontz-eink.md
@@ -1,41 +1,32 @@
-# Wiring Guides for Moddable supported SPI displays
+# Crystalfontz ePaper Display Wiring Guide
 
 Copyright 2018 Moddable Tech, Inc.  
-Revised: January 2, 2018
+Revised: October 23, 2018
 
+<img src="images/eink-display.jpeg" height=350>
 
-## Crystalfontz ePaper display
-**Part:** CFAP128296C0-0290  
-[Datasheet] (https://www.crystalfontz.com/products/document/3660/CFAP128296C0-0290DatasheetReleaseDate2017-08-14.pdf)
+## Specs
 
-**Size:**  2.9" 128x296 
+| | |
+| :---: | :--- |
+| **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.<BR><BR>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.<BR><BR>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.
 
-**Type:** EPD (Electronic Paper Displays)
+## Moddable example code
 
-**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.
+The [love-e-ink](../../examples/piu/love-e-ink/) example is good for testing this display. To run a debug build, use the following build command:
 
 ```
-cd $MODDABLE/examples/piu/love-e-ink
-mcconfig -d -m -p esp -f gray256 -r 270  
+cd $MODDABLE/examples/piu/love-e-ink/
+mcconfig -d -m -p esp/crystalfontz_monochrome_epaper -r 270
 ```
 
-
-**ESP8266 Pinout:**
+## ESP8266 Pinout
 
 | eInk Display | ESP8266 | ESP8266 Devboard label
 | --- | --- | --- |

diff --git a/documentation/displays/wiring-guide-generic-2.4-spi-esp32.md b/documentation/displays/wiring-guide-generic-2.4-spi-esp32.md
@@ -1,36 +1,35 @@
-# Wiring Guides for Moddable supported SPI displays
+# Generic 2.4" & 2.8" Displays (Resistive Touch) Wiring Guide - ESP32
 
 Copyright 2018 Moddable Tech, Inc.  
-Revised: January 2, 2018
+Revised: October 23, 2018
 
+<img src="images/spi-touch-display.jpg" height=250>
 
-## Generic 2.4" & 2.8" displays - ESP32 
-**Size:** 2.4" & 2.8", 320 x 240
+## Specs
 
-**Type:** TFT LCD
+| | |
+| :---: | :--- |
+| **Size** | 2.4" & 2.8", 320 x 240
+| **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)
+| **Description** | These inexpensive displays are available on eBay and other resources.<BR><BR>Note: They are available in touch and non-touch versions which appear very similar.
 
-**Interface:** SPI
 
-**Drivers:** video [ILI9341](../../documentation/drivers/ili9341/ili9341.md), touch XPT2046
+## Moddable example code
 
-**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)
-
-**Description:** These inexpensive displays are available on eBay and other resources. Note: They are available in touch and non-touch versions which appear very similar.
-
-![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.
+The [drag](../../examples/piu/drag/) example is good for testing this display.  To run a debug build, use the following build command:
 
 ```
 cd $MODDABLE/examples/piu/drag
-mcconfig -d -m -r 0 -f rgb565le -p esp screen=ili9341 touch=xpt2046  
+mcconfig -d -m -p esp32/moddable_zero
 ```
-At this time Moddable sample code does not include display SD card support.
 
-**ESP8266 Pinout:**
+## ESP8266 Pinout
 
 | ILI9341 Display | ESP32 | 
-| --- | --- | --- |
+| --- | --- |
 | SDO / MISO | GPIO 12  
 | LED | 3.3V | 
 | SCK | GPIO 14 |

diff --git a/documentation/displays/wiring-guide-generic-2.4-spi.md b/documentation/displays/wiring-guide-generic-2.4-spi.md
@@ -1,33 +1,33 @@
-# Wiring Guides for Moddable supported SPI displays
+# Generic 2.4" & 2.8" Displays (Resistive Touch) Wiring Guide - ESP8266
 
 Copyright 2018 Moddable Tech, Inc.  
-Revised: January 2, 2018
+Revised: October 23, 2018
 
+<img src="images/spi-touch-display.jpg" height=250>
 
-## Generic 2.4" & 2.8" displays (with resistive touch)
-**Size:** 2.4" & 2.8", 320 x 240
+## Specs
 
-**Type:** TFT LCD
+| | |
+| :---: | :--- |
+| **Size** | 2.4" & 2.8", 320 x 240
+| **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)
+| **Description** | These inexpensive displays are available on eBay and other resources. <BR><BR>Note: They are available in touch and non-touch versions which appear very similar.
 
-**Interface:** SPI
+> At this time Moddable sample code does not include display SD card support.
 
-**Drivers:** video [ILI9341](../../documentation/drivers/ili9341/ili9341.md), touch XPT2046
+## Moddable example code
 
-**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)
-
-**Description:** These inexpensive displays are available on eBay and other resources. Note: They are available in touch and non-touch versions which appear very similar.
-
-![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.
+The [drag](../../examples/piu/drag/) example is good for testing this display.  To run a debug build, use the following build command:
 
 ```
 cd $MODDABLE/examples/piu/drag
-mcconfig -d -m -r 0 -f rgb565le -p esp screen=ili9341 touch=xpt2046  
+mcconfig -d -m -p esp/moddable_zero
 ```
-At this time Moddable sample code does not include display SD card support.
 
-**ESP8266 Pinout:**
+## ESP8266 Pinout
 
 | ILI9341 Display | ESP8266 | ESP8266 Devboard label
 | --- | --- | --- |

diff --git a/documentation/displays/wiring-guide-sharp-memory-2.7-spi.md b/documentation/displays/wiring-guide-sharp-memory-2.7-spi.md
@@ -1,39 +1,34 @@
-# Wiring Guides for Moddable supported SPI displays
+# Sharp Memory Display Wiring Guide
 
 Copyright 2018 Moddable Tech, Inc.  
-Revised: January 2, 2018
+Revised: October 23, 2018
 
+<img src="images/Sharp_Memory_LCD_LS027B7DH01.jpg" height=275>
 
-## Sharp Memory Screen 
-**Part:** LS027B7DH01A
+## Specs
 
-**Size:** 2.7", 240 x 400
+| | |
+| :---: | :--- |
+| **Part** | LS027B7DH01A
+| **Size** | 2.7", 240 x 400
+| **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)
+| **Description** | The Sharp Memory display is a blend of an eInk (e-paper) display and an LCD. It has the very-low power draw of eInk and fast-refresh rates of an LCD.<BR><BR>Moddable uses the [Kuzyatech Sharp Memory display breakout board] (https://www.tindie.com/products/kuzyatech/sharp-memory-lcd-breakout-a2/) to interface with the display FFC and boost the ESP8266 power to the 5V needed to drive the display.
 
-**Type:** Sharp Memory TFT-LCD, Monochrome
+## Moddable example code
 
-**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)
-
-**Description:** The Sharp Memory display is a blend of an eInk (e-paper) display and an LCD. It has the very-low power draw of eInk and fast-refresh rates of an LCD.
-
-Moddable used the [Kuzyatech Sharp Memory display breakout board] (https://www.tindie.com/products/kuzyatech/sharp-memory-lcd-breakout-a2/) to interface with the display FFC and boost the ESP8266 power to the 5v needed to drive the display.
-
-
-![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.
+The [balls](../../examples/piu/balls/) example is good for testing this display. To run a debug build, use the following build command:
 
 ```
 cd $MODDABLE/examples/piu/balls
-mcconfig -d -m -r 0 -f rgb565le -p esp screen=ili9341 touch=xpt2046  
+mcconfig -d -m -p esp/sharp_memory  
 ```
 
-**ESP8266 Pinout:**
+## ESP8266 pinout
 
-| 2.7" Memory Display | ESP8266 | ESP8266 Devboard label
+| Sharp Memory Display | ESP8266 | ESP8266 Devboard label
 | --- | --- | --- |
 | VIN | 3.3V |  
 | GND | GND |