lpm013m126a display driver thrash: clean-up code, add manifest and docs

Author: phoddie

documentation/drivers/lpm013m126a/lpm013m126a.md

@@ -0,0 +1,57 @@
+# LPM013M126A display driver
+Copyright 2017 Moddable Tech, Inc.
+
+Revised: December 29, 2017
+
+**Warning**: These notes are preliminary. Omissions and errors are likely. If you encounter problems, please ask for assistance.
+
+The [LPM013M126A](http://www.j-display.com/product/pdf/Datasheet/4LPM013M126A_specification_Ver02.pdf) JDI (Japan Display Inc. Group) memory display controller drives 3-bit per pixel displays. The controller allows one bit of color information per channel, for a total of 8 colors.
+
+### Adding LPM013M126A to a project
+To add the LPM013M126A driver to a project, include its manifest:
+
+	"include": [
+		/* other includes here */
+		"$(MODULES)/drivers/lpm013m126a/manifest.json",
+	],
+
+If using Commodetto or Piu, set the `screen` property of the `config` object in the manifest to `lpm013m126a` to make LPM013M126A the default display driver. Since there is no touch input, set the touch driver name to an empty string to disable it.
+
+	"config": {
+		"screen": "lpm013m126a",
+		"touch": "",
+	},
+
+### Pixel format
+The LPM013M126A driver requires 8-bit color pixels as input. When building with `mcconfig`, set the pixel format to `rgb332` on the command line:
+
+	mcconfig -m -p esp -f rgb332
+
+### Defines
+There are no unique `defines` in the manifest apart from those described in the Dither and SPI sections below.
+
+### Dither
+The LPM013M126A driver implements optional dithering. Dithering provides an approximation of more color levels. Enabling dithering uses about an additional 380 bytes of RAM and renders slower. Whether dithering is best for a given application depends on what it draws and the required frame rate. Dithering is disabled by default. To enable dithering, set the `dither` property to `true` in the `defines` section of the manifest.
+
+	"defines": {
+		"lpm013m126a": {
+			/* other properties here */
+			"dither": true,
+		}
+	}
+
+### Configuring SPI
+The `defines` object must contain the `spi_port`, along with the `CS` pin number. If the `cs_port` property is not provided, it defaults to NULL. 
+
+	"defines": {
+		"lpm013m126a": {
+			/* other properties here */	
+			"cs_pin": 4,
+			"spi_port": "#HSPI",
+		}
+	}
+
+The `hz` property, when present, specifies the SPI bus speed. The default value is 2,500,000 Hz which is near the maximum SPI speed supported by the LPM013M126A.
+
+### Drawing
+The LPM013M126A driver always updates full scan lines, but can update arbitrary scan lines. This allows for partial updates of full rows. Piu automatically takes care of this, so script using Piu do not need to take this into account. Scripts using Poco need to ensure  when calling `poco.begin()` that the `x` parameter is zero and the `width` parameter is equal to `poco.width`.

documentation/drivers/ls013b4dn04/ls013b4dn04.md

@@ -22,6 +22,11 @@ If using Commodetto or Piu, set the `screen` property of the `config` object in
 		"touch": "",
 	},
 
+### Pixel format
+The LS013B4DN04 driver requires 8-bit gray pixels as input. When building with `mcconfig`, set the pixel format to `gray256` on the command line:
+
+	mcconfig -m -p esp -f gray256
+
 ### Defines
 In the `defines` object, declare the pixel `width` and `height`.
 
@@ -32,10 +37,6 @@ In the `defines` object, declare the pixel `width` and `height`.
 		}
 	}
 
-The LS013B4DN04 driver requires 8-bit gray pixels as input. When building with `mcconfig`, set the pixel format to `gray256` on the command line:
-
-	mcconfig -m -p esp -f gray256
-
 ### Configuring SPI
 The `defines` object must contain the `spi_port`, along with the `CS` pin number. If the `cs_port` property is not provided, it defaults to NULL. 
 

documentation/drivers/ssd1306/ssd1306.md

@@ -22,6 +22,11 @@ If using Commodetto or Piu, set the `screen` property of the `config` object in
 		"touch": "",
 	},
 
+### Pixel format
+The SSD1306 driver requires 8-bit gray (`gray256`) pixels as input. When building with `mcconfig`, set the pixel format to `gray256` on the command line:
+
+	mcconfig -m -p esp -f gray256
+
 ### Defines
 In the `defines` object, declare the pixel `width` and `height`. The default connection is SPI, but it is recommended to explicitly set the connection type in the application manifest:
 
@@ -33,10 +38,6 @@ In the `defines` object, declare the pixel `width` and `height`. The default con
 			"i2c": false,
 		}
 	}
-	
-The SSD1306 driver requires 8-bit gray (`gray256`) pixels as input. When building with `mcconfig`, set the pixel format to `gray256` on the command line:
-
-	mcconfig -m -p esp -f gray256
 
 ### Dither
 The SSD1306 driver implements optional dithering. Dithering allows an approximation of gray pixels on black and white OLED displays. Enabling dithering uses about an additional 520 bytes of RAM and renders slower. Whether dithering is best for a given application depends on what it draws and the required frame rate. Dithering is disabled by default. To enable dithering, set the `dither` property to `true` in the `defines` section of the manifest.

documentation/drivers/ssd1351/ssd1351.md

@@ -22,6 +22,11 @@ If using Commodetto or Piu, set the `screen` property of the `config` object in
 		"touch": "",
 	},
 
+### Pixel format
+The SSD1351 driver requires 16-bit color pixels as input. When building with `mcconfig`, set the pixel format to `rgb565le` on the command line:
+
+	mcconfig -m -p esp -f rgb565le
+
 ### Defines
 In the `defines` object, declare the pixel `width` and `height`.
 
@@ -73,10 +78,6 @@ The optional `initialization` property is used to override the default initializ
 		}
 	}
 
-The SSD1351 driver requires 16-bit color pixels as input. When building with `mcconfig`, set the pixel format to `rgb565le` on the command line:
-
-	mcconfig -m -p esp -f rgb565le
-
 ### Configuring SPI
 The `defines` object must contain the `spi_port`, along with the `DC` and `CS` pin numbers. If a `RST` pin is provided, the device will be reset when the constructor is invoked. If the `cs_port`, `dc_port`, or `rst_port` properties are not provided, they default to NULL. 
 

modules/drivers/lpm013m126a/manifest.json

@@ -0,0 +1,49 @@
+{
+	"defines": {
+		"lpm013m126a": {
+			"width": 176,
+			"height": 176,
+			"dither": false
+		}
+	},
+	"preload": [
+		"lpm013m126a",
+		"commodetto/Bitmap",
+	],
+	"platforms": {
+		"esp": {
+			"include": [
+				"$(MODULES)/pins/digital/manifest.json",
+				"$(MODULES)/pins/spi/manifest.json",
+			],
+			"modules": {
+				"*": "$(MODULES)/drivers/lpm013m126a/*",
+				"commodetto/Bitmap": "$(COMMODETTO)/commodettoBitmap",
+			},
+			"defines": {
+				"lpm013m126a": {
+					"cs_pin": 4,
+					"dc_pin": 2,
+					"spi_port": "#HSPI"
+				}
+			}
+		},
+		"esp32": {
+			"include": [
+				"$(MODULES)/pins/digital/manifest.json",
+				"$(MODULES)/pins/spi/manifest.json",
+			],
+			"modules": {
+				"*": "$(MODULES)/drivers/lpm013m126a/*",
+				"commodetto/Bitmap": "$(COMMODETTO)/commodettoBitmap",
+			},
+			"defines": {
+				"lpm013m126a": {
+					"cs_pin": 4,
+					"dc_pin": 2,
+					"spi_port": "#HSPI"
+				}
+			}
+		}
+	}
+}