16x2-lcd-menu 中文文档教程

Question

16x2-lcd-menu

抽象 Adafruit 16x2 字符 LCD 菜单的库，有利于配置而不是用于创建菜单和屏幕导航的代码。

Menu params

{
  id: String, // -- identifier
  name: String, // -- Name of template
  enabled: Bool,
  actions: {
    up: func || string || null || undefined, // Action to perform on button up, function, or a string (string name of menu)
    down: func || string || null || undefined, // if null, go up or down a line if template.length > 2
    left: func || string || undefined, // undefined does nothing
    right: func || string || undefined,
    select: func || string || undefined
  },
  template: [String], // array of template string, line by line, since this is an x2 display we join 0 and 1 by \n
  data: func // function to retrieve data

}

Usage

const LCDMENU = require('16x2-lcd-menu');
const lcdMenu = new LCDMENU(60, true); // timeout backlight after 60 seconds, debug on

lcdMenu.addMenu({
  id: 'testMenu',
  name: 'Test Menu',
  enabled: true,
  actions: {
    right: 'testMenu2',
  },
  template: [
    'This is a',
    'Test Menu',
    'Welcome',
    'To the Demo',
  ],
});

lcdMenu.addMenu({
  id: 'testMenu2',
  name: 'Test Menu',
  enabled: true,
  template: [
    'Test Menu 2'
  ],
  actions: {
    left: 'testMenu',
  },
});

lcdMenu.init();
process.on('exit', lcdMenu.close); // Cleanup

LCDMENU Methods

lcd

对实例化的液晶板库的原始访问

addMenu(Menu Object)

添加新菜单

• if actions are not set, set it to an empty object (if it is truthy but not an object this could cause a crash)
• Defaults the id to match the name if an id is not set
• sets the first menu as the currentMenu (WIP)

removeMenu(String id)

删除由 id

• Does nothing if id not provided or menu with that id doesn't exist.
• fails if there are no more menus registered

enableMenu(String id)

指定的菜单 启用指定的菜单

disableMenu(String id)

禁用指定的菜单

setBacklight(Boolean state)

根据状态（真实）打开或关闭背光

timeoutDisplay()

• Times out the display backlight after the configured # of seconds has passed
• does nothing if timeoutMs is set to 0

displayTimeout set/get

• Set the display timeout in seconds.
• Doesn't auto-clear previous timer

activeMenu set/get

• Set re-renders the display if valid, if not valid, does nothing.

init()

初始化显示

• If no menu is configured, add a default one
• Turn on backlight
• Clears the screen
• Runs render menu

renderMenu(String id)

呈现提供的或活动的菜单，或 0 索引菜单，如果 未提供

clearDisplayTimeout()

清除超时，使屏幕背光保持打开状态。

close()

• Shuts down screen
• Clears screen, turns off backlight, stops polling button presses