https://github.com/polyfloyd/ledcat
Control lots of LED's over lots of protocols
https://github.com/polyfloyd/ledcat
art-net artnet dmx hub75 led led-controller led-display led-strips
Last synced: 21 days ago
JSON representation
Control lots of LED's over lots of protocols
- Host: GitHub
- URL: https://github.com/polyfloyd/ledcat
- Owner: polyfloyd
- License: gpl-3.0
- Created: 2016-12-11T22:21:08.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2025-05-01T16:06:52.000Z (about 1 month ago)
- Last Synced: 2025-05-01T17:25:14.016Z (about 1 month ago)
- Topics: art-net, artnet, dmx, hub75, led, led-controller, led-display, led-strips
- Language: Rust
- Homepage:
- Size: 6.19 MB
- Stars: 110
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
ledcat
======
[](https://crates.io/crates/ledcat)
Ledcat is simple utility that aims to provide a standard interface for driving
LED-devices and such.
Simply create a program that outputs 3 bytes of RGB for each pixel in your setup.
**Note** Prior to v0.3.0, Ledcat supported driving LED-strips such as the WS28xx, APA102, etc. via
the spidev interface of Linux. This functionality has been removed as it required too much effort to
maintain and using an ESP32 with something like [WLED](https://github.com/Aircoookie/WLED) will
result in a much better experience.
## Documentation
* [Usage](doc/usage.md)
* [Transposition and display geometry](doc/transposition.md)
## Install
The easiest way to install Ledcat is to [download a binary from
Github](https://github.com/polyfloyd/ledcat/releases).
*Note: Hzeller's LED Matrix driver is not available from CI builds.*
### Installing from Cargo
Install the [Rust Language](https://www.rust-lang.org/) if you have not already.
Then, you can install ledcat directly using Cargo.
```sh
cargo install ledcat
```
### Building Manually
Alternatively, you can build and install Ledcat manually:
```sh
git clone https://github.com/polyfloyd/ledcat.git
cd ledcat
cargo build --release
cp target/release/ledcat /usr/local/bin/ledcat
```
## Usage Examples
```sh
# Make a strip of 30 leds all red.
perl -e 'print "\xff\x00\x00" x 30' | ledcat --geometry 30 show
```
```sh
# Receive frames over UDP.
nc -ul 1337 | ledcat --geometry 30 show
```
```sh
# Load an image named "image.png", resize it to fit the size of the display and
# send it to a ledstrip zigzagged over the Y-axis.
convert image.png -resize 75x8! -depth 8 RGB:- | \
ledcat --geometry 75x8 --transpose zigzag_y show
```
```sh
# A clock on a zigzagged two dimensional display of 75x8 pixels
while true; do
convert -background black -fill cyan -font Courier -pointsize 8 \
-size 75x8 -gravity center -depth 8 caption:"$(date +%T)" RGB:-
sleep 1;
done | ledcat --geometry 75x16 --transpose zigzag_y show
```
```sh
# Show random noise as ambient lighting or priority messages if there are any.
mkfifo /tmp/ambient
mkfifo /tmp/messages
cat /dev/urandom > /tmp/ambient &
./my_messages > /tmp/messages &
ledcat --input /tmp/ambient /tmp/messages --exit never --geometry 30 show
```
### Supported Devices:
* show (emulates a LED bar in the terminal)
* Artnet DMX
* [HexWS2811](https://github.com/brainsmoke/hex2811-penta)
* [hub75](doc/hub75.md)
* [LED Matrices on Raspberry Pi's](https://github.com/hzeller/rpi-rgb-led-matrix) (ARM+Linux only)