https://github.com/jazz-soft/char-lcd

Character LCD display emulator
https://github.com/jazz-soft/char-lcd

character-lcd hd44780 lcd

Last synced: about 2 months ago
JSON representation

Character LCD display emulator

• Host: GitHub
• URL: https://github.com/jazz-soft/char-lcd
• Owner: jazz-soft
• Created: 2018-10-26T05:49:15.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-10T02:07:25.000Z (8 months ago)
• Last Synced: 2024-11-11T14:13:05.156Z (about 2 months ago)
• Topics: character-lcd, hd44780, lcd
• Language: JavaScript
• Homepage:
• Size: 41 KB
• Stars: 28
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# char-lcd

[![npm](https://img.shields.io/npm/v/char-lcd.svg)](https://www.npmjs.com/package/char-lcd)

## Character LCD display emulator

Emulate **Hitachi HD44780** and compatible devices in HTML

##### HD44780-A00 (Japanese standard font)  

![polymer-char-lcd](https://jazz-soft.github.io/img/char-lcd-jp.png)

##### HD44780-A02 (European standard font)  

![polymer-char-lcd](https://jazz-soft.github.io/img/char-lcd-eu.png)

## Install

`npm install char-lcd --save`  

or `yarn add char-lcd`  

or clone the whole project from [**GitHub**](https://github.com/jazz-soft/char-lcd)

## Usage

##### Web Component (Polymer)

https://github.com/jazz-soft/polymer-char-lcd

##### Plain HTML

```html

//...

```

##### CDN (jsdelivr)

```html

//...

```

##### CDN (unpkg)

```html

//...

```

##### CommonJS

```js

var CharLCD = require('char-lcd');

//...

```

##### TypeScript / ES6

```js

import { CharLCD } from 'char-lcd';

//...

```

##### AMD

```js

require(['char-lcd'], function(CharLCD) {

  // ...

});

```

## Example

```html



...

var lcd = new CharLCD({ at: 'lcd', rows: 2, cols: 16, rom: 'eu' });

// Map UNICODE string to the internal character set:

lcd.text(0, 0, "ЁЛКИ-ПАЛКИ!");

```


## API

##### constructor

`var lcd = new CharLCD(params);`  

`params` is an object with the following keys:  

- `at`: a DOM element in which to place the object, or its `id`;

default: at the bottom of the page;  

- `rom`: `jp` (default) for Japanese standard font, or `eu` for European standard font.  

- `rows`: - number of rows;

default: 2;  

- `cols`: - number of columns;

default: 16;

Unlike the real hardware where only certain combinations of `rows`/`cols` exist, there are no restrictions in the simulator;

##### char(r, c, h)

`lcd.char(r, c, h);` - set the character at row `r`, column `c` to byte `h`.

##### text(r, c, s)

`lcd.text(r, c, s);` - print string `s` at row `r`, column `c`.  

This function treats `\n` as new line and maps UNICODE characters to the internal character set.

##### font(n, data)

`lcd.font(n, data);` - define the pixels for the `n`-th character; `data` is an array of up to 10 bytes.  

In real hardware, only first 8 characters can be changed, but there is no such limitation in the simulator.