0.12.1 • Published 10 months ago

@bigdots-io/display-engine v0.12.1

Weekly downloads
-
License
ISC
Repository
-
Last release
10 months ago

Bigdots Display Engine

Interested in just rendering a display? Checkout the Web Client!

Install & Usage

npm install --save @bigdots-io/display-engine
import { createDisplayEngine } from "@bigdots-io/display-engine";
import { MacroName } from "@bigdots-io/display-engine/lib/types";

createDisplayEngine({
  macroName: MacroName.Twinkle,
  onPixelChange: ({ y, x, hex }) => {
    // Update the frontend of your display
  },
});

Fonts

The following fonts are available to use when displaying text on your bigdots.io LED board.

System 6

System 6

The smallest possible font, 6 dots high.

  • Identifer: system-6
  • Monospace: Yes
  • Uppercase supported: Yes
  • Lowercase supported: No
  • Numbers supported: Yes
  • Punction supported: Yes

System 16

System 16

Designed for at least 16 dots high, though top and bottom padding is builtin.

  • Identifer: system-16
  • Monospace: No
  • Uppercase supported: Yes
  • Lowercase supported: Yes
  • Numbers supported: Yes
  • Punction supported: Yes

Macros

These are all the available display macros for BigDots.io LED displays.

Twinkle

Twinkle macro

{
  color: "#FFFFFF";
}

Marquee

The classic LED panel usecase...

Marquee macro

{
  color: '#FFFFFF',
  backgroundColor: '#000000',
  font: 'system-16',
  text: 'Replace with marquee text!',
  speed: 50
}

Programmable

It's all on you. Use the the Node API to do whatever you want!

Programmable macro

Counter

Display a sum of an item or items via json from a url. The url should return json in the following structure...

[{ "count": 12540 }]

Counter macro

{
  loadingBarColor: '#333333',
  iconColor: '#FFFFFF',
  countColor: '#FFFFFF',
  icon: null,
  url: '',
  refreshInterval: 60
}

Solid Color

Solid color macro

{
  color: "#FFFFFF";
}

Image

Image macro Image macro

{
  url: '',
  speed: 10 // for GIFs
}
0.11.0

10 months ago

0.12.0

10 months ago

0.12.1

10 months ago

0.10.3

11 months ago

0.10.4

11 months ago

0.10.2

11 months ago

0.10.0

12 months ago

0.10.1

12 months ago

0.9.0

1 year ago

0.9.1

1 year ago

0.8.0

1 year ago

0.6.8

1 year ago