dot-matrix-lcd
v1.0.0
A simple Dot Matrix LCD emulator for JavaScript.
0/weekUpdated 3 years agoISCUnpacked: 916.6 KB
Published by Uday Hiwarale
npm install dot-matrix-lcddot-matrix-lcd
A JavaScript plugin to emulate Dot Matrix LCD display.
Install
``
bash
npm i -S dot-matrix-lcd
`Import in HTML
html
`> This script exposes
class on window object.Import in Node.js
`js
const LCD = require('dot-matrix-lcd');
`Plugin API
js
var lcd = new LCD({
elem: document.getElementById("lcd-container"),
rows: 2, // number of character rows on the LCD screen
columns: 16, // number of character columns on the LCD screen
pixelSize: 4, // size of each pixel
pixelColor: "#000", // color of the pixel
});// Write a character on LCD screen.
// charCode => decimal number or hexadecimal string ASCII code point
// blockIndex => index of the character block (default: 0)
lcd.writeCharacter( { charCode, blockIndex } );
// Write string (text) on LCD screen.
// string => text (default: "")
// offset => offset index from the start of the screen.
lcd.writeString({ string, offset });
// Clear a character at a given index on the LCD screen.
// blockIndex => Index of the character block (default: 0)
lcd.clearCharacter({ blockIndex });
// Toggle cursor blink at the given character block.
// blockIndex => index of the character block (default: 0)
// stop => stop cursor blink (default: false)
lcd.blinkCursor({ blockIndex, stop });
// Clear entire LCD screen.
lcd.clearScreen();
``