上周合宙發布了一款1.54寸墨水屏開發板，售價僅為16.8元，又掀起一陣搶購熱旋風。

由于墨水屏的特性，無需背光，在光線照射下觀感和紙張印刷效果類似，很適合用來做電紙書。再配合可以使用Wi-Fi的合宙ESP32C3開發板，我們就可以用LuatOS驅動這塊墨水屏來做一個在線電紙書了。

- LuatOS在線電紙書 -

接下來，讓我們一起看看制作LuatOS在線電紙書的要點吧！

1

基礎準備工作

本文電紙書示例主要硬件采用合宙LuatOS墨水屏開發板+ESP32C3開發板，軟件建議使用合宙Luatools進行操作。

1.1 合宙LuatOS墨水屏開發板一塊：

1.54寸黑白雙色墨水屏，分辨率200*200，板載升壓電路，僅需正常3.3V供電即可驅動。使?LuatOS固件中的eink庫，可以?便快捷地驅動屏幕。

點擊圖片鏈接了解更多：

1.2 合宙ESP32C3開發板一塊：

目前合宙ESP32C3開發板分為兩版：經典款和簡約款。須注意的是簡約款無串口芯片，從Type-C口連接的話沒法用LuatIDE調試，需使用Luatools進行燒錄。

點擊圖片鏈接了解更多：

1.3 接線示意：

合宙LuatOS墨水屏開發板接口兼容合宙LuatOS全系列MCU開發板，對應接口對插即可。

2

編寫在線電紙書

2.1 解鎖GPIO11

由于墨水屏的BUSY引腳連接到了ESP32C3的GPIO11，但是ESP32C3的GPIO11(VDD_SPI)默認功能是給Flash供電，默認情況下無法當作GPIO使用，我們可以使用外部3.3V給Flash供電，把GPIO11釋放出來使用。

具體步驟詳見【ESP32C3解鎖使用IO11】：https://gitee.com/dreamcmi/LuatOS-ESP32/blob/master/doc/VDD_SPI_AS_GPIO.md

2.2 界面及交互設計

使用開發板上的BOOT鍵(GPIO9)作為功能按鍵：

單擊：下一個
雙擊：上一個
長按：進入/退出

選擇12號中文字體作為顯示字體；開機后顯示圖書列表界面，圖書列表一頁顯示11項，選中的圖書高亮顯示，長按功能鍵進入圖書閱讀界面，閱讀界面顯示內容為11行*12列，最下面一行顯示當前的閱讀進度，在閱讀界面長按功能鍵退回到圖書列表界面。

2.3 搭建在線電紙書后臺服務

后臺服務主要提供以下兩個HTTP接口供客戶端調用：

當前墨水屏使用12號中文字體的情況下，一頁顯示11行*12列，后臺會根據需求分頁返回給客戶端。

后臺源代碼詳見【電紙書后臺源碼】：

https://github.com/JeremyHash/EinkBook-LuatOS/blob/master/Server/main.go

2.4 封裝必要模塊

在線電紙書需要Wi-Fi連接和發起HTTP請求兩個基本需求，這部分代碼比較多，封裝成兩個函數：

創建Wi-Fi連接

手機橫屏/上下滑動查看完整代碼：

function wifiConnect.connect(ssid, passwd)

local waitRes, data

if wlan.init() ~= 0 then

log.error(tag .. ".init", "ERROR")

return false

end

if wlan.setMode(wlan.STATION) ~= 0 then

log.error(tag .. ".setMode", "ERROR")

return false

end

if USE_SMARTCONFIG == true then

if wlan.smartconfig() ~= 0 then

log.error(tag .. ".connect", "ERROR")

return false

end

waitRes, data = sys.waitUntil("WLAN_STA_CONNECTED", 180 * 10000)

log.info("WLAN_STA_CONNECTED", waitRes, data)

if waitRes ~= true then

log.error(tag .. ".wlan ERROR")

return false

end

waitRes, data = sys.waitUntil("IP_READY", 10000)

if waitRes ~= true then

log.error(tag .. ".wlan ERROR")

return false

end

log.info("IP_READY", waitRes, data)

return true

end

if wlan.connect(ssid, passwd) ~= 0 then

log.error(tag .. ".connect", "ERROR")

return false

end

waitRes, data = sys.waitUntil("WLAN_STA_CONNECTED", 10000)

if waitRes ~= true then

log.error(tag .. ".wlan ERROR")

return false

end

log.info("WLAN_STA_CONNECTED", waitRes, data)

waitRes, data = sys.waitUntil("IP_READY", 10000)

if waitRes ~= true then

log.error(tag .. ".wlan ERROR")

return false

end

log.info("IP_READY", waitRes, data)

return true

end

發起HTTP請求

手機橫屏/上下滑動查看完整代碼：

local methodTable = {

GET = esphttp.GET,

POST = esphttp.POST,

PUT = esphttp.PUT,

DELETE = esphttp.DELETE

}

function httpLib.request(method, url, head)

local responseCode = 0

local httpc = esphttp.init(methodTable[method], url)

if httpc == nil then

esphttp.cleanup(httpc)

return false, responseCode, "create httpClient error"

end

if head ~= nil then

for k, v in pairs(head) do

esphttp.set_header(httpc, k, v)

end

end

local ok, err = esphttp.perform(httpc, true)

if ok then

local response = ""

while 1 do

local result, c, ret, data = sys.waitUntil("ESPHTTP_EVT", 20000)

-- log.info("ESPHTTP_EVT", result, c, ret, data)

if result == false then

esphttp.cleanup(httpc)

return false, responseCode, "wait for http response timeout"

end

if c == httpc then

if esphttp.is_done(httpc, ret) then

esphttp.cleanup(httpc)

return true, esphttp.status_code(httpc), response

end

if ret == esphttp.EVENT_ON_DATA then

response = response .. data

end

end

end

else

esphttp.cleanup(httpc)

return false, responseCode, "perform httpClient error " .. err

end

end

2.5 封裝必要模塊編寫電紙書代碼

下面開始電紙書部分的邏輯代碼，主要分為初始化FDB、初始化墨水屏、文字函數、圖書列表及內容函數、網絡及按鍵功能等幾個部分：

初始化FDB

assert(fdb.kvdb_init("env", "onchip_flash") == true, tag .. ".kvdb_init ERROR")

初始化墨水屏

由于我們使用的是ESP32C3，連接的SPI通道id為2，初始化成功之后需要設置墨水屏的大小，然后將墨水屏完整的黑白刷新一次來清除之前顯示內容的殘留，再設置我們要使用的12號中文字體。

代碼如下：

-- 局刷模式

eink.setup(1, 2, 11, 10, 6, 7)

-- 設置分辨率200*200

eink.setWin(200, 200, 0)

-- 全刷一次屏幕防止之前的顯示內容殘留

eink.clear(0, true)

eink.show(0, 0)

eink.clear(1, true)

eink.show(0, 0)

eink.setFont(eink.font_opposansm12_chinese)

封裝墨水屏顯示文字函數

function einkShowStr(x, y, str, colored, clear, show)

-- 每20次刷屏就全刷一次防止顯示殘留

if einkPrintTime > 20 then

einkPrintTime = 0

eink.rect(0, 0, 200, 200, 0, 1)

eink.show(0, 0, true)

eink.rect(0, 0, 200, 200, 1, 1)

eink.show(0, 0, true)

end

if clear == true then

eink.clear()

end

eink.print(x, y, str, colored)

if show == true then

einkPrintTime = einkPrintTime + 1

eink.show(0, 0, true)

end

end

封裝渲染圖書列表和圖書內容函數

手機橫屏/上下滑動查看完整代碼：

function showBookList(index)

local firstIndex

for k, v in pairs(onlineBooksShowTableTmp[1]) do

firstIndex = v["index"]

end

-- 當要高亮的圖書索引超過了當前的列表，擴充當前列表

if index > firstIndex + 10 then

onlineBooksShowTableTmp = getTableSlice(onlineBooksShowTable, index - 10, index)

end

if index < firstIndex then

onlineBooksShowTableTmp = getTableSlice(onlineBooksShowTable, index, index + 10)

end

einkShowStr(0, 16, "圖書列表", 0, true)

local ifShow = false

local len = getTableLen(onlineBooksTable)

local showLen = getTableLen(onlineBooksShowTableTmp)

if len == 0 then

einkShowStr(0, 32, "暫無在線圖書", 0, false, true)

return

end

local i = 1

for k, v in pairs(onlineBooksShowTableTmp) do

for name, info in pairs(v) do

local bookName = string.split(name, ".")[1]

local bookSize = tonumber(info["size"]) / 1024 / 1024

if i == showLen then

ifShow = true

end

if info["index"] == index then

eink.rect(0, 16 * i, 200, 16 * (i + 1), 0, 1, nil, ifShow)

einkShowStr(0, 16 * (i + 1), bookName .. " " .. string.format("%.2f", bookSize) .. "MB", 1,

nil, ifShow)

else

einkShowStr(0, 16 * (i + 1), bookName .. " " .. string.format("%.2f", bookSize) .. "MB", 0,

nil, ifShow)

end

i = i + 1

end

end

end

function showBook(bookName, bookUrl, page)

sys.taskInit(function()

waitHttpTask = true

for i = 1, 3 do

local result, code, data = httpLib.request("GET", bookUrl .. "/" .. page)

log.info("SHOWBOOK", result, code)

if result == false or code == -1 or code == 0 then

log.error("SHOWBOOK", "獲取圖書內容失敗 ", data)

else

local bookLines = json.decode(data)

for k, v in pairs(bookLines) do

if k == 1 then

einkShowStr(0, 16 * k, v, 0, true, false)

elseif k == #bookLines then

einkShowStr(0, 16 * k, v, 0, false, false)

else

einkShowStr(0, 16 * k, v, 0, false, false)

end

end

-- 最后一行渲染讀書進度

einkShowStr(60, 16 * 12 + 2, page .. "/" .. onlineBooksTable[bookName]["pages"], 0, false, true)

break

end

end

waitHttpTask = false

end)

end

連接網絡并獲取圖書列表

需要提前創建幾個函數，用來處理下面獲取到的圖書列表數據。

手機橫屏/上下滑動查看完整代碼：

-- 獲取table的切片并作為一個新的table返回

function getTableSlice(intable, startIndex, endIndex)

local outTable = {}

for i = startIndex, endIndex do

table.insert(outTable, intable[i])

end

return outTable

end

-- 通過#獲取table長度不靠譜，所以需要這個函數

function getTableLen(t)

local count = 0

for _, _ in pairs(t) do

count = count + 1

end

return count

end

-- 需要將獲取到的圖書列表格式化符合我們下面的需求

function formatOnlineBooksTable(inTable)

local outTable = {}

local i = 1

for k, v in pairs(inTable) do

v["index"] = i

table.insert(outTable, {

[k] = v

})

i = i + 1

end

return outTable

end

```

調用之前封裝的WiFi連接函數，將獲取到的圖書列表解析并顯示

代碼如下:

for i = 1, 5 do

local result, code, data = httpLib.request("GET",serverAdress .. "getBooks")

if result == false or code == -1 or code == 0 then

log.error(tag, "獲取圖書列表失敗 ", data)

if i == 5 then

einkShowStr(0, 16, "連接圖書服務器失敗 正在重啟", 0,true, true)

rtos.reboot()

end

else

onlineBooksTable = json.decode(data)

onlineBooksTableLen = getTableLen(onlineBooksTable)

onlineBooksShowTable = formatOnlineBooksTable(onlineBooksTable)

onlineBooksShowTableTmp = getTableSlic(onlineBooksShowTable, 1, 11)

-- 渲染圖書列表，索引從1開始

showBookList(1)

btnSetup(9, 1000, btnShortHandle, btnLongHandle, btnDoublehandle)

break

end

sys.wait(1000)

end

初始化功能鍵并編寫對應的按鍵處理

初始化BOOT/GPIO9為功能鍵，在對應的按鍵事件處理函數中，調用之前封裝好的渲染圖書列表或渲染圖書內容的函數。

手機橫屏/上下滑動查看完整代碼：

-- 短按處理函數

function btnShortHandle()

-- 如果當前http請求未完成則直接返回

if waitHttpTask == true then

waitDoubleClick = false

return

end

-- 如果當前頁面在圖書列表，短按會高亮下一本書

if PAGE == "LIST" then

if einkBooksIndex == onlineBooksTableLen then

einkBooksIndex = 1

else

einkBooksIndex = einkBooksIndex + 1

end

showBookList(einkBooksIndex)

-- 如果當前頁面在圖書閱讀頁面，短按進入下一頁

else

local i = 1

local bookName = nil

for k, v in pairs(onlineBooksTable) do

if i == einkBooksIndex then

bookName = k

end

i = i + 1

end

local thisBookPages = tonumber(onlineBooksTable[bookName]["pages"])

-- 如果當前頁已是最后一頁，直接返回

if thisBookPages == gpage then

waitDoubleClick = false

return

end

gpage = gpage + 1

-- 渲染下一頁

showBook(bookName, serverAdress .. string.urlEncode(bookName), gpage)

log.info(bookName, gpage)

-- 把新的閱讀記錄存入fdb

fdb.kv_set(bookName, gpage)

end

waitDoubleClick = false

end

-- 長按處理函數

function btnLongHandle()

if waitHttpTask == true then

return

end

-- 如果當前在列表頁進入內容閱讀頁

if PAGE == "LIST" then

PAGE = "BOOK"

local i = 1

local bookName = nil

for k, v in pairs(onlineBooksTable) do

if i == einkBooksIndex then

bookName = k

end

i = i + 1

end

local pageCache = fdb.kv_get(bookName)

log.info(bookName, pageCache)

if pageCache == nil then

gpage = 1

showBook(bookName, serverAdress .. string.urlEncode(bookName), gpage)

else

gpage = pageCache

showBook(bookName, serverAdress .. string.urlEncode(bookName), pageCache)

end

-- 如果當前在內容頁進入列表頁

elseif PAGE == "BOOK" then

PAGE = "LIST"

showBookList(einkBooksIndex)

end

end

-- 雙擊處理函數

function btnDoublehandle()

if waitHttpTask == true then

return

end

-- 若果當前在列表頁，高亮上一項

if PAGE == "LIST" then

if einkBooksIndex == 1 then

einkBooksIndex = onlineBooksTableLen

else

einkBooksIndex = einkBooksIndex - 1

end

showBookList(einkBooksIndex)

-- 如果當前在內容頁，讀取上一頁內容

else

-- 如果已是第一頁直接返回

if gpage == 1 then

return

end

gpage = gpage - 1

local i = 1

local bookName = nil

for k, v in pairs(onlineBooksTable) do

if i == einkBooksIndex then

bookName = k

end

i = i + 1

end

log.info(bookName, gpage)

fdb.kv_set(bookName, gpage)

showBook(bookName, serverAdress .. string.urlEncode(bookName), gpage)

end

end

-- 按鍵中斷處理函數

function btnHandle(val)

if val == 0 then

-- 按下時在等待雙擊狀態時，停止短按事件函數的定時器，并觸發雙擊

if waitDoubleClick == true then

sys.timerStop(gShortCb)

gDoubleCb()

waitDoubleClick = false

return

end

-- 啟動一個定時器觸發長按處理函數

sys.timerStart(longTimerCb, gPressTime)

gBtnStatus = "PRESSED"

else

-- 停止長按處理函數的定時器

sys.timerStop(longTimerCb)

-- 如果當前狀態為短按下，開啟一個定時器來觸發短按處理函數

if gBtnStatus == "PRESSED" then

sys.timerStart(gShortCb, 500)

waitDoubleClick = true

gBtnStatus = "IDLE"

-- 如果當前狀態以為長按處理函數執行完成，改變狀態為IDLE并返回

elseif gBtnStatus == "LONGPRESSED" then

gBtnStatus = "IDLE"

end

end

end

-- 初始化按鍵函數

function btnSetup(gpioNumber, pressTime, shortCb, longCb, doubleCb)

gpio.setup(gpioNumber, btnHandle, gpio.PULLUP)

gPressTime = pressTime

gShortCb = shortCb

gLongCb = longCb

gDoubleCb = doubleCb

end

-- 初始化GPIO9為上拉中斷模式，并注冊短按/長按/雙擊的處理函數

btnSetup(9, 1000, btnShortHandle, btnLongHandle, btnDoublehandle)

2.6相關資料鏈接

完整項目代碼：

https://github.com/JeremyHash/EinkBook-LuatOS

燒錄教程：

https://wiki.luatos.com/boardGuide/flash.html

墨水屏開發板資料：
https://wiki.luatos.com/peripherals/eink_1.54/index.html

ESP32C3開發板資料：
https://wiki.luatos.com/chips/esp32c3/index.html

好了，今天就分享到這里
以上內容你學會了嗎
自己制作一款電紙書愉快玩耍吧