https://github.com/knifa/led-matrix-zmq-http-bridge
HTTP JSON API for sending control messages to led-matrix-zmq-server.
https://github.com/knifa/led-matrix-zmq-http-bridge
Last synced: 2 months ago
JSON representation
HTTP JSON API for sending control messages to led-matrix-zmq-server.
- Host: GitHub
- URL: https://github.com/knifa/led-matrix-zmq-http-bridge
- Owner: Knifa
- License: gpl-3.0
- Created: 2024-11-17T18:57:53.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-05T01:08:35.000Z (6 months ago)
- Last Synced: 2025-02-02T14:37:09.926Z (4 months ago)
- Language: Python
- Homepage:
- Size: 189 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# led-matrix-zmq-http-bridge
This is an HTTP bridge for [led-matrix-zmq-server](https://github.com/knifa/led-matrix-zmq-server).
You can set brightness, color temperature, and get the configuration via a JSON API. You can also send frames via form data.
Zeroconf is used to publish the bridge as a service so it can be discovered by e.g. Home Assistant.
## Docker
A [Docker image](https://github.com/knifa/led-matrix-zmq-http-bridge/pkgs/container/led-matrix-zmq-http-bridge) is available for `amd64` and `arm64`.
The container must be run with `--network host` for Zeroconf to work.
```shell
docker run \
--rm \
--network host \
-e "LMZ_CONTROL_ENDPOINT=ipc:///run/lmz/control.sock" \
-e "LMZ_FRAME_ENDPOINT=ipc:///run/lmz/frame.sock" \
-e "LMZ_ZEROCONF_NAME=My Matrix" \
-v /run/lmz:/run/lmz \
ghcr.io/knifa/led-matrix-zmq-http-bridge:latest
```
## Usage
See [lmz/settings.py](lmz/settings.py) for possible environment variables.
```bash
uv sync
uv run python -m lmz
```
### Control API
#### GET `/brightness`
Get the current brightness of the display (0-100%).
```bash
curl http://localhost:4200/brightness
# {"brightness": 50}
```
#### POST `/brightness`
Set the brightness of the display (0-100%)
```bash
curl \
-X POST \
-H "Content-Type: application/json" \
-d '{"brightness": 50}' \
http://localhost:4200/brightness
# {"status": "ok"}
```
#### GET `/configuration`
Get the configuration of the display, i.e., resolution.
```bash
curl http://localhost:4200/configuration
# {"width": 64, "height": 32}
```
#### GET `/temperature`
```bash
curl http://localhost:4200/temperature
# {"temperature": 2500}
```
#### POST `/temperature`
Set the color temperature of the display (2000-6500K).
```bash
curl \
-X POST \
-H "Content-Type: application/json" \
-d '{"temperature": 2500}' \
http://localhost:4200/temperature
# {"status": "ok"}
```
### Frame API
#### POST `/frame`
Send a frame to the display. No error response is sent if the frame is invalid (e.g., wrong size).
```bash
curl \
-F frame="@frame.raw" \
http://localhost:4200/frame
# {"status": "ok"}
```
## Zeroconf
The bridge is published as a Zeroconf service under the type `_lmz-http-bridge._tcp.local.`.