Skip to content

Small docker image to communicate with a network enabled pixoo LED dot matrix.

License

Notifications You must be signed in to change notification settings

simplyRoba/pixoo-bridge

Repository files navigation

Pixoo Bridge

Small docker image to communicate with a network enabled pixoo LED dot matrix.

Conventional Commits GitHub License GitHub Workflow Status (with event) GitHub release (with filter) GitHub issues GitHub Repo stars

Configuration

Pass key as environment variable the docker container.

Key Default value Description
PIXOO_HOST localhost IP of the pixoo in the network
PIXOO_SIZE 64 screen size of the pixoo
PIXOO_HEALTH_FORWARD true Ping pixoo during image health check
PIXOO_DOCS_ENABLED true Enable API documentation
PIXOO_ANIMATION_SPEED_FACTOR 1.4 Factor to adjust animation speed of uploaded gifs
PIXOO_MAX_IMAGE_SIZE 2MB Image size for uploads and remote images. Format like 128KB or 5MB
PIXOO_LOG_LEVEL INFO Possible values OFF, DEBUG, INFO, WARN, ERROR

Run the image

replace the ip of your pixoo and run

docker run -p 4000:4000 -e "PIXOO_HOST=xxx.xxx.xxx.xxx" ghcr.io/simplyroba/pixoo-bridge:latest

or use the docker-compose.yaml

docker compose up -d

API

Documentation

Generated API documentation can be reached under

http://localhost:4000/swagger-ui/index.html

Swagger Screenshot

Limitations

The Channel control API of the Pixoo will not be implemented. Use the App for these functionality.

Further resources

Official product page

Pixoo64

Pixoo API

Official Divoom API documentation