https://github.com/knifa/led-matrix-zmq-server
A tool for streaming frames to rpi-rgb-led-matrix over ZeroMQ.
https://github.com/knifa/led-matrix-zmq-server
docker-image led-matrix raspberry-pi rgb-led-matrix zeromq zmq
Last synced: 5 months ago
JSON representation
A tool for streaming frames to rpi-rgb-led-matrix over ZeroMQ.
- Host: GitHub
- URL: https://github.com/knifa/led-matrix-zmq-server
- Owner: Knifa
- License: gpl-3.0
- Created: 2019-09-04T14:48:35.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-12-17T23:17:57.000Z (10 months ago)
- Last Synced: 2025-03-30T03:51:10.620Z (6 months ago)
- Topics: docker-image, led-matrix, raspberry-pi, rgb-led-matrix, zeromq, zmq
- Language: C++
- Homepage:
- Size: 81.1 KB
- Stars: 28
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# led-matrix-zmq-server
A tool for interacting with [rpi-rgb-led-matrix](https://github.com/hzeller/rpi-rgb-led-matrix/) over ZeroMQ.
## Building
- Depends on `cppzmq` and friends.
- Requires a built [rpi-rgb-led-matrix](https://github.com/hzeller/rpi-rgb-led-matrix/). Tell CMake where it is with `-DRPI_RGB_LED_MATRIX_DIR`.
- Build with `cmake`, e.g.:
```shell
mkdir build
cd build
cmake -DRPI_RGB_LED_MATRIX_DIR=/path/to/rpi-rgb-led-matrix ..
make
```
## Docker
A [Docker image](https://github.com/Knifa/led-matrix-zmq-server/pkgs/container/led-matrix-zmq-server) is available for `amd64` and `arm64`.
The server must be run with `--privileged` to allow GPIO access. This binary is only included in the `arm64` image.
```shell
docker run \
--privileged \
--rm \
-v /run/lmz:/run/lmz \
ghcr.io/knifa/led-matrix-zmq-server:latest \
led-matrix-zmq-server \
--frame-endpoint ipc:///run/lmz/frame.sock \
--control-endpoint ipc:///run/lmz/control.sock \
--cols 64 \
--rows 64
# ...etc
```
`led-matrix-zmq-control` and `led-matrix-zmq-pipe` are also available in the image.
```shell
docker run \
--rm \
-v /var/run/lmz:/run/lmz \
ghcr.io/knifa/led-matrix-zmq-server:latest \
led-matrix-zmq-control \
--control-endpoint ipc:///run/lmz/control.sock \
set-brightness 128
```
## Usage
### Running the Server
See `led-matrix-zmq-server --help` for available options. These mostly passthrough to the `rpi-rgb-led-matrix` library.
```shell
sudo ./led-matrix-zmq-server \
--cols 64 \
--rows 64 \
--chain-length 2
# ...etc
```
#### Endpoints
The `--xyz-endpoint` options pass directly through to ZeroMQ, so you can use any valid transport string. For example, you could specify `tcp://0.0.0.0:42069` to listen on the network.
### Sending Frames
The server is a simple ZMQ REQ-REP loop. All you need to do is send your frame as a big ol' byte chunk then wait for an empty message back. Each frame should be in a RGBA32 format.
#### Just Pipe It
[led-matrix-zmq-pipe](src/pipe_main.cpp) is both a bit of an example and a handy tool. It reads raw RGBA32 frames from stdin and sends them to the server.
```shell
# Use ffmpeg to convert a video to raw data.
ffmpeg -re -i input.mp4 -vf scale=128:64 -f rawvideo -pix_fmt rgba - \
| sudo ./led-matrix-zmq-pipe -w 128 -h 64
# Use imagemagick to resize and convert an image to raw data.
convert input.png -resize 128x64^ rgba:- \
| sudo ./led-matrix-zmq-pipe -w 128 -h 64
# Play a YouTube video.
yt-dlp -f "bv*[height<=480]" "https://www.youtube.com/watch?v=FtutLA63Cp8" -o - \
| ffmpeg -re -i pipe: -vf scale=128:64 -f rawvideo -pix_fmt rgba - \
| sudo ./led-matrix-zmq-pipe -w 128 -h 64
```
### Control Messages
Brightness, color temperature, etc. can be get/set through another simple REQ-REP loop.
See `led-matrix-zmq-control --help` for available options, or see [the source](src/control_main.cpp) to dig deeper.