Add Juergen Skrotzky's module

espruino · May 12, 2020 · fb50e12 · fb50e12
1 parent 416f4c2
commit fb50e12
Show file tree

Hide file tree

Showing 3 changed files with 188 additions and 0 deletions.
diff --git a/devices/ST7735.js b/devices/ST7735.js
@@ -0,0 +1,111 @@
+/* Copyright (c) 2015 Gordon Williams, Pur3 Ltd. See the file LICENSE for copying permission.
+Modified by Juergen Skrotzky alias Jorgen (JorgenVikingGod@gmail.com) */
+/*
+Module for the ST7735 LCD controller, based on the ILI9163 controller
+
+Just:
+```
+var colorPalette = new Uint16Array([0, 0xFF8C, 0x008F, 0xFFFF]);
+var g = require("ST7735").connect({
+  palette:colorPalette,
+  spi:spi,
+  dc:B1,
+  cs:B13,
+  rst:B10
+}, function() {
+  g.clear();
+  g.setRotation(2);
+  g.setColor(3);
+  g.drawString("Hello",0,0);
+  g.setColor(1);
+  g.setFontVector(20);
+  g.drawString("Espruino",0,10);
+  g.flip();
+});
+
+```
+*/
+/* ST7735 128x128
+| VCC   | B15 | 3.3v
+| GND   | B14 | GND
+| CS/CE | B13 |
+| RST   | B10 | 3.3v
+| A0/DC | B1  |
+| SDA   | A7  |
+| SCL   | A6  |
+| LED   | A5  |
+*/
+
+var LCD_WIDTH = 128;
+var LCD_HEIGHT = 128;
+
+function init(spi, dc, ce, rst, callback) {
+  function cmd(c,d) {
+    dc.reset();
+    spi.write(c, ce);
+    if (d!==undefined) {
+      dc.set();
+      spi.write(d, ce);
+    }
+  }
+
+  if (rst) {
+    digitalPulse(rst,0,10);
+  } else {
+    cmd(0x01); //ST7735_SWRESET: Software reset, 0 args, w/delay: 150 ms delay
+  }
+  setTimeout(function() {
+    cmd(0x11); //ST7735_SLPOUT: Out of sleep mode, 0 args, w/delay: 500 ms delay
+    setTimeout(function() {
+      cmd(0xB1,[0x01,0x2C,0x2D]); //ST7735_FRMCTR1: Set Frame rate ctrl - normal mode, 3 args: (Rate = fosc/(1x2+40) * (LINE+2C+2D))
+      cmd(0xB2,[0x01,0x2C,0x2D]); //ST7735_FRMCTR2: Set Frame rate control - idle mode, 3 args: Rate = fosc/(1x2+40) * (LINE+2C+2D)
+      cmd(0xB3,[0x01,0x2C,0x2D,0x01,0x2C,0x2D]); //ST7735_FRMCTR3: Set Frame rate ctrl - partial mode, 6 args: Dot inversion mode + Line inversion mode
+      cmd(0xB4,0x07); // ST7735_INVCTR: Set Display inversion ctrl, 1 arg, no delay: No inversion
+      cmd(0xC0,[0xA2,0x02,0x84]); //ST7735_PWCTR1: Set Power control, 3 args, no delay: init + -4.6V + AUTO mode
+      cmd(0xC1,0xC5); //ST7735_PWCTR2: Set Power control, 1 arg, no delay: VGH25 = 2.4C VGSEL = -10 VGH = 3 * AVDD
+      cmd(0xC2,[0x0A,0x00]); //ST7735_PWCTR3: Set Power control, 2 args, no delay: Opamp current small + Boost frequency
+      cmd(0xC3,[0x8A,0x2A]); //ST7735_PWCTR4: Set Power control, 2 args, no delay: BCLK/2, Opamp current small & Medium low
+      cmd(0xC4,[0x8A,0xEE]); //ST7735_PWCTR5: Set Power control, 2 args, no delay:
+      cmd(0xC5,0x0E); //ST7735_VMCTR1: Set Power control, 1 arg, no delay:
+      cmd(0x20,0x00); //ST7735_INVOFF: Don't invert display, no args, no delay
+      cmd(0x36,0xC8); //ST7735_MADCTL: Set Memory access control (directions), 1 arg: row addr/col addr, bottom to top refresh
+      cmd(0x3A,0x05); //ST7735_COLMOD: Set color mode, 1 arg, no delay: 16-bit color
+      cmd(0x2A,[0x00,0x00,0x00,LCD_WIDTH-1]); //ST7735_CASET: Set Column addr set, 4 args, no delay: XSTART = 0 + XEND = 127
+      cmd(0x2B,[0x00,0x00,0x00,LCD_HEIGHT-1]); //ST7735_RASET: Set Row addr set, 4 args, no delay: XSTART = 0 + XEND = 127
+      cmd(0xE0,[0x02,0x1c,0x07,0x12,0x37,0x32,0x29,0x2d,0x29,0x25,0x2B,0x39,0x00,0x01,0x03,0x10]); //ST7735_GMCTRP1: color and gamma correction
+      cmd(0xE1,[0x03,0x1d,0x07,0x06,0x2E,0x2C,0x29,0x2D,0x2E,0x2E,0x37,0x3F,0x00,0x00,0x02,0x10]); //ST7735_GMCTRN1: color and gamma correction
+      cmd(0x13); //ST7735_NORON: Set Normal display on, no args, w/delay: 10 ms delay
+      cmd(0x29); //ST7735_DISPON: Set Main screen turn on, no args w/delay: 100 ms delay
+
+      if (callback) callback();
+    },10);
+  } ,100);
+}
+
+exports.connect = function(options, callback) {
+  var palette = options.palette, spi=options.spi, dc=options.dc, ce=options.cs, rst=options.rst;
+  if (options.height) LCD_HEIGHT=options.height;
+  var bits;
+  if (palette.length>16) bits=8;
+  else if (palette.length>4) bits=4;
+  else if (palette.length>2) bits=2;
+  else bits=1;
+  var g = Graphics.createArrayBuffer(LCD_WIDTH, LCD_HEIGHT, bits, { msb:true });
+  g.flip = function() {
+    ce.reset();
+    spi.write(0x2A,dc);
+    spi.write(0,2,0,LCD_WIDTH+1);
+    spi.write(0x2B,dc);
+    spi.write(0,3,0,LCD_HEIGHT+2);
+    spi.write(0x2C,dc);
+    var lines = 16; // size of buffer to use for un-paletting
+    var a = new Uint16Array(LCD_WIDTH*lines);
+    for (var y=0;y<LCD_HEIGHT;y+=lines) {
+      E.mapInPlace(new Uint8Array(g.buffer, y*LCD_WIDTH*bits/8, a.length), a, palette, bits);
+      spi.write(a.buffer);
+    }
+    ce.set();
+  };
+  init(spi, dc, ce, rst, callback);
+  return g;
+};
diff --git a/devices/ST7735.md b/devices/ST7735.md
@@ -0,0 +1,77 @@
+<!--- Copyright (c) 2013 Gordon Williams, Pur3 Ltd. See the file LICENSE for copying permission. -->
+ST7735 LCD controller
+===================
+
+<span style="color:red">:warning: **Please view the correctly rendered version of this page at https://www.espruino.com/ST7735. Links, lists, videos, search, and other features will not work correctly when viewed on GitHub** :warning:</span>
+
+* KEYWORDS: Module,SPI,ST7735,ST7735R,Graphics,Graphics Driver,LCD,Color,Colour,128x128,128x160
+
+![ST7735 LCD module](ST7735/module.jpg)
+
+This is an extremely common LCD controller for 128x128 and 128x160 LCDs. These are available cheaply from various suppliers online.
+
+Support is included in the [[ST7735.js]] module, using the [[Graphics]] library.
+
+Just wire up as follows:
+
+| LCD pin | Example pin |
+|---------|----------|
+| VCC   | 3.3 |
+| GND   | GND |
+| CS/CE | D15 |
+| RST   | D2 |
+| A0/DC | D21 |
+| SDA   | D19  |
+| SCL   | D18  |
+| LED   | D5 |
+
+**Note:** In the example, software SPI is used - you can wire up to *any*
+data pins on Espruino that you want to as long as you update the pins
+in the code below.
+
+**Note:** The display takes around 200ms to initialise after calling 'connect'. There's an optional callback that is called after this time (shown in the examples). Sending data to it before initialisation may cause it not to initialise correctly.
+
+
+Paletted Mode
+-------------
+
+```JS
+D5.set(); // Backlight On
+var colorPalette = new Uint16Array([0, 0xF80F, 0x001F, 0xFFFF]);
+var spi = new SPI();
+spi.setup({mosi:D19 /* sda */, sck:D18 /* scl */});
+var g = require("ST7735").connectPaletted({
+  palette:colorPalette,
+  spi:spi,
+  dc:D21,
+  cs:D15,
+  rst:D2,
+  // height : 160 // optional, default=128
+}, function() {
+  g.clear();
+  g.setColor(3);
+  g.drawString("Hello",0,0);
+  g.setFontVector(20);
+  g.setColor(1);
+  g.drawString("Espruino",0,10);
+  g.setColor(2);
+  g.drawString("Espruino",0,40);
+  g.flip(); //<--- Send to the display
+});
+```
+
+As there isn't enough RAM to store full 16 bit pixels of the LCD display in Espruino's RAM, this module stores a paletted version of the data. For instance if you only need 4 colours, these can be stored as 2 bits per pixel rather than 16. The buffer then takes `128 * 128 / 4 = 4096 bytes` which will fit into the available RAM.
+
+This means that all drawing functions can be done much more quickly offscreen, and then the LCD can be updated in one go (removing flicker).
+
+The palette can be either 1, 2, 4 or 8 bits - so the array should be either 2, 4, 16 or 256 elements. Then, when you use `setColor`, the number you supply corresponds to that array element in the palette array,
+
+Using
+-----
+
+* APPEND_USES: ST7735
+
+Buying
+-----
+
+* [eBay](http://www.ebay.com/sch/i.html?_nkw=ST7735)
diff --git a/devices/ST7735/module.jpg b/devices/ST7735/module.jpg