README.md

rpi-led-matrix-fire

A fire for the RGB LED Matrix built on oclif and rpi-rgb-led-matrix.
The fire is based on the »Doom Fire algorithm« and the code is heavily inspired by that random gist I found somewhere in the web.

• Usage
• Options
• About this Project
• License

Usage

$ yarn install
$ sudo su
# ./bin/run

Options

  -b, --brightness=brightness            [default: 100] set the led brightness
  -c, --led-cols=led-cols                [default: 64] Columns of your LED panel in default hardware orientation
  -h, --help                             show CLI help
  -r, --led-rows=led-rows                [default: 32] Rows of your LED panel in default hardware orientation
  -t, --rotation=rotation                rotate the fire 0, 90, 180 or 270 degrees
  -v, --version                          show CLI version
  --led-slowdown-gpio=led-slowdown-gpio  [default: 4] Slowdown GPIO. Needed for faster Pis and/or slower panels

About this project

After I finally bought an RGB LED Matrix I wanted to create something awesome with it.
After it became clear that we needed a medieval lantern for our amateur theatre, which was supposed to go out by magic, I had found my project.

The whole process of creating that lantern is documented here: tbd

LICENSE

MIT