Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
Knifa committed Nov 29, 2024
1 parent d454018 commit 7967fc5
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 5 deletions.
36 changes: 33 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

A tool for interacting with [rpi-rgb-led-matrix](https://github.com/hzeller/rpi-rgb-led-matrix/) over ZeroMQ.

Looking for the ye olde version? Check out the [2019 tag](https://github.com/Knifa/led-matrix-zmq-server/tree/2019).

## Building

- Depends on `cppzmq` and friends.
Expand All @@ -17,6 +15,38 @@ Looking for the ye olde version? Check out the [2019 tag](https://github.com/Kni
make
```

## Docker

[A Docker image is available](https://github.com/Knifa/led-matrix-zmq-server/pkgs/container/led-matrix-zmq-server).

The server must be run with `--privileged` to allow GPIO access.

```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
Expand All @@ -27,7 +57,7 @@ See `led-matrix-zmq-server --help` for available options. These mostly passthrou
sudo ./led-matrix-zmq-server \
--cols 64 \
--rows 64 \
--chain-length 2 \
--chain-length 2
# ...etc
```

Expand Down
4 changes: 2 additions & 2 deletions src/consts.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace consts {
constexpr auto pixel_size = sizeof(std::uint32_t);
constexpr auto bpp = 8 * pixel_size;

const auto default_control_endpoint = "ipc:///run/led-matrix-zmq-control.sock";
const auto default_frame_endpoint = "ipc:///run/led-matrix-zmq-frame.sock";
const auto default_control_endpoint = "ipc:///run/lmz-control.sock";
const auto default_frame_endpoint = "ipc:///run/lmz-frame.sock";

} // namespace consts

0 comments on commit 7967fc5

Please sign in to comment.