FlashAir-SlibILI9341

Lua library for TFT display modules with ILI9341 for FlashAir.

2019/6/1 Japanese font support. Inter-character space and line interval support by locate command.

Tested equipment

Tested on the following TFT display module and FlashAir W-04 v4.00.03.

240x320 2.4inch SPI Module ILI9341(SKU:MSP2402)

front	back

FlashAir to TFT module connections

Please choose your favorite TYPE.

Rename table

this text	module pin
CLK	CLK or SCK or SCL
SDI	SDI or SDA
DC	RS or A0 or DC
CS or CS2	CS
RESET	RST or RESET or RES
LED	LED or LEDA or BLK
GND	GND
VCC	VCC

TYPE list

FlashAir	TYPE1	TYPE2	TYPE3	TYPE4	TYPE21	TYPE22	TYPE23
---	w/Reset	w/PIO	w/LED	w/SPI	primaly	secondary	twin
CMD	SDI	SDI	SDI	SDI/DO	SDI	SDI	SDI
DAT0	CLK	CLK	CLK	CLK/CLK	CLK	CLK	CLK
DAT1	DC	DC	DC	DC /--	DC	DC	DC
DAT2	CS	CS	CS	CS /DI	CS	(CS )	CS
DAT3	RESET	PIO	LED	-- /CS	(CS2 )	CS2	CS2

TYPE21,TYPE22,TYPE23 for two display

TYPE1

Module Reset is hardwere reset.

FlashAir(Pin#)	ILI9341 TFT	Power	comment
CLK (5)	---	Pull-down(10korm) to GND
CMD (2)	SDI
DAT0(7)	CLK
DAT1(8)	DC
DAT2(9)	CS
DAT3(1)	RESET
---	LED	3.3V
VCC (4)	VCC	3.3V
VSS(3,6)	GND	GND

TYPE2

DAT3 of FlashAir can be used for PIO.

FlashAir(Pin#)	ILI9341 TFT	Power	comment
CLK (5)	---	Pull-down(10korm) to GND
CMD (2)	SDI
DAT0(7)	CLK
DAT1(8)	DC
DAT2(9)	CS
DAT3(1)	PIO
---	RESET	Pull-up(10korm) to 3.3V
---	LED	3.3V
VCC (4)	VCC	3.3V
VSS(3,6)	GND	GND

TYPE3

DAT3 of FlashAir for LED backlight on/off control.

FlashAir(Pin#)	ILI9341 TFT	Power	comment
CLK (5)	---	Pull-down(10korm) to GND
CMD (2)	SDI
DAT0(7)	CLK
DAT1(8)	DC
DAT2(9)	CS
DAT3(1)	LED		connect through 10kohm
---	RESET	Pull-up(10korm) to 3.3V
VCC (4)	VCC	3.3V
VSS(3,6)	GND	GND

TYPE4

CMD,DAT0,DAT2,DAT3 can be used for SPI.

FlashAir(Pin#)	ILI9341 TFT	SPI device	Power	comment
CLK (5)	---	---	Pull-down(10korm) to GND
CMD (2)	SDI	DO
DAT0(7)	CLK	CLK
DAT1(8)	DC	---
DAT2(9)	CS	DI	Pull-up(10korm) to 3.3V
DAT3(1)	---	CS
---	RESET	---	Pull-up(10korm) to 3.3V
---	LED	---	3.3V
VCC (4)	VCC	VCC	3.3V
VSS(3,6)	GND	GND	GND

TYPE21

If you connect two displays, use this for primaly display.

FlashAir(Pin#)	ILI9341 TFT	Power	comment
CLK (5)	---	Pull-down(10korm) to GND
CMD (2)	SDI
DAT0(7)	CLK
DAT1(8)	DC
DAT2(9)	CS	Pull-up(10korm) to 3.3V
DAT3(1)	(CS2 )
---	RESET	Pull-up(10korm) to 3.3V
---	LED	3.3V
VCC (4)	VCC	3.3V
VSS(3,6)	GND	GND

TYPE22

If you connect two displays, use this for secondaly display.

FlashAir(Pin#)	ILI9341 TFT	Power	comment
CLK (5)	---	Pull-down(10korm) to GND
CMD (2)	SDI
DAT0(7)	CLK
DAT1(8)	DC
DAT2(9)	(CS )	Pull-up(10korm) to 3.3V
DAT3(1)	CS2
---	RESET	Pull-up(10korm) to 3.3V
---	LED	3.3V
VCC (4)	VCC	3.3V
VSS(3,6)	GND	GND

TYPE23

If you connect two identical displays, use this for twin display. You can draw each or both.

FlashAir(Pin#)	ILI9341 TFT1	ILI9341 TFT2	Power	comment
CLK (5)	---	---	Pull-down(10korm) to GND
CMD (2)	SDI	SDI
DAT0(7)	CLK	CLK
DAT1(8)	DC	DC
DAT2(9)	CS	---	Pull-up(10korm) to 3.3V
DAT3(1)	---	CS2
---	RESET	RESET	Pull-up(10korm) to 3.3V
---	LED	LED	3.3V
VCC (4)	VCC	VCC	3.3V
VSS(3,6)	GND	GND	GND

Install

SlibILI9341.lua -- Copy to somewhere in Lua's search path.

Color format of functions

color : BBBBB_GGGGGG_RRRRR (64K(16bpp) color)
bgcolor : BBBBB_GGGGGG_RRRRR (64K(16bpp) back ground color)

Internal bitmap data format

-- same as FlashAir-SlibBMP.lua
bitmap  = {}  
bitmap.header -- copyed from BMP header  
bitmap.width  -- bitmap width  
bitmap.height -- bitmap height  
bitmap.bit    -- bpp, 16(BBBBB_GGGGGG_RRRRR format)
bitmap.flat   -- 1:Flat(Stuffing without leaving spaces for small image), 0:Stored in an array for each line.  
bitmap.data   -- bitmap data  

Internal font data format

-- example --
font74 = {
height= 7;
width = 4;
[' '] ={0x00,0x00,0x00,0x00};
['!'] ={0x00,0x2F,0x00,0x00};
['"'] ={0x03,0x00,0x03,0x00};
--
['~'] ={0x0C,0x04,0x06,0x00};
}

Usage

Sample of init()

240x320 2.4inch SPI Module ILI9341(SKU:MSP2402)

Description of the command

command	description
ILI9341:init(type,rotate,xSize,ySize,rOffset,dOffset,gm)	Parameter initialization and reset LCD module. type: 1:D3=RST, 2:D3=PIO, 3:D3=LED, 4:with SPI, 21:primaly, 22:secondaly, 23:twin See module connections information. rotate: 0:Vertical default, 1:Horizontal default, 2:Vertical reverse, 3:Horizontal reverse xSize,ySize: LCD x size, y size rOffset,dOffset: RAM address offset gm: module GM pad
ILI9341:flip(rFlip,dFlip)	Filp x-axis or y-axis for graphic writing. rFlip,dFlip: 0:normal, 1:flip
tbl=ILI9341:duplicate()	Duplicate ILI9341 library, if you use two deferent TFT module of ILI9341 or rotation. return: duplicated table of library.
ILI9341:writeStart([flag])	Enable control. flag: 1:primaly, 2:secondly, 3:both default is 2 at TYPE22, 3 at TYPE23, 1 at others.
ILI9341:writeEnd()	Disable control.
ILI9341:cls()	Clear screen.
ILI9341:dspOn()	Display contents of RAM.
ILI9341:dspOff()	Do not display contents of RAM.
ILI9341:pset(x,y,color)	Plot point at (x,y). If color is omitted, fgcolor is used.
ILI9341:line(x1,y1,x2,y2,color)	Plot line (x1,y1)-(x2,y2). If color is omitted, fgcolor is used.
ILI9341:box(x1,y1,x2,y2,color)	Plot box (x1,y1)-(x2,y2). If color is omitted, fgcolor is used.
ILI9341:boxFill(x1,y1,x2,y2,color)	Plot filled box (x1,y1)-(x2,y2). If color is omitted, fgcolor is used.
ILI9341:circle(x,y,xr,yr,color)	Plot circle of center(x,y), radius(xr,yr). If color is omitted, fgcolor is used.
ILI9341:circleFill(x,y,xr,yr,color)	Plot filled circle of center(x,y), radius(xr,yr). If color is omitted, fgcolor is used.
ILI9341:put(x,y,bitmap)	Put 16bpp bitmap at upper left coordinates with (x,y).
ILI9341:put2(x,y,bitmap)	Put 16bpp flat bitmap faster at upper left coordinates with (x,y).
ILI9341:color(fgcolor,bgcolor)	Default color setting.
ILI9341:locate(x,y,mag,xsapce,yspace)	Locate cursor, set print area(x,y)-(xSize-1,ySize-1).mag: Text magnification. default is 1. xspace: Inter-character space. default is 0. yspace: line interval. default is 0. If you do not want to change any arguments you can substitute nil.
ILI9341:setFont(font)	Set font table or return value of SlibJfont.lua.
x,y,n,rows=ILI9341:print(str)	Print alphabets and return next cursor position. Output will be stopped if the drawing range is exceeded. n: Number of characters output. rows: Number of lines output.
x,y,n,rows=ILI9341:println(str)	Print alphabets, creates a new line and return next cursor position. Output will be stopped if the drawing range is exceeded. n: Number of characters output. rows: Number of lines output.
ILI9341:ledOn()	LED backlight ON at TYPE3.
ILI9341:ledOff()	LED backlight OFF at TYPE3.
ret=ILI9341:pio(ctrl,data)	PIO control of DAT3 at TYPE2. PIO default is input. ctrl: 0:input, 1:output. data: value for output return: input value or nil at TYPE1
ILI9341:spiInit(period,mode,bit,cstype)	SPI init for TYPE4. period,mode,bit: same as fa.spi(...) cstype: 0:low enable, 1:high enable, 2:always High-Z
res = ILI9341:spiWrite(data_num) res = ILI9341:spiWrite(data_str,xfer_num)	SPI write for TYPE4. data_num,data_str,xfer_num,res: same as fa.spi("write", ...)
res_num = ILI9341:spiRead() res_tbl = ILI9341:spiRead(xfer_num,data_num)	SPI read for TYPE4. xfer_num,data_num,res_num,res_tbl: same as fa.spi("read", ...)

Sample program

sample.lua -- draw graphics demo
sample_kanji.lua -- Kanji character support demo
lib/SlibILI9341.lua
lib/SlibBMP.lua -- Copy from FlashAir-SlibBMP repository
img/balloon01.bmp
img/balloon02.bmp
font/font74.lua

These files copy to somewhere in FlashAir.

If you want to run "sample_kanji.lua", please prepare the following.

日本語フォントを使う方法

日本語フォントを使う場合は、下記のレポジトリをご参照ください。
https://github.com/AoiSaya/FlashAir_SlibJfont

例として、"sample_kanji.lua"を実行する手順を以下に示します。
上記レポジトリから以下のファイルを入手してFlashAirに保存します。

lib/SlibJfont.lua  -- ライブラリ  
lib/Utf8Euc_jp.tbl -- UTF-8をEUC-JPに変換する際の変換テーブル  
font/bdf2sef.lua   -- ファイル形式変換プログラム  

サンプル用フォントの入手

文字情報サービス環境 CHISEから
jiskan24-2003-1.bdf.gz をダウンロードして解凍し、下記ファイルをfont/ の下に置きます。
jiskan24-2003-1.bdf
12x24rk.bdf

次に bdf2sef.lua を編集して、末尾に

convBdf2Bin("jiskan24-2003-1.bdf")  
convBdf2Bin("k12x24rk.bdf")  

を追加してください。
bdf2sef.lua を実行すると、font/ の下に"jiskan24-2003-1.sef" と "k12x24rk.sef" が生成されます。
この状態で "sample_kanji.lua" を実行すると、LCD上に日本語が表示されます。

Licence

MIT

Author

GitHub/AoiSaya
Twitter ID @La_zlo