https://github.com/simplyroba/pixoo-bridge

Small docker image to communicate with a network enabled pixoo LED dot matrix.
https://github.com/simplyroba/pixoo-bridge

divoom docker-image led-matrix led-matrix-displays pixel-art pixoo pixoo64

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/simplyroba/pixoo-bridge
• Owner: simplyRoba
• License: agpl-3.0
• Created: 2023-06-11T16:44:36.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2026-02-14T09:32:38.000Z (4 months ago)
• Last Synced: 2026-02-14T17:58:18.906Z (4 months ago)
• Topics: divoom, docker-image, led-matrix, led-matrix-displays, pixel-art, pixoo, pixoo64
• Language: Kotlin
• Homepage:
• Size: 2.29 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
> **pixoo-bridge has been superseded by [pixoo-bridge.rs](https://github.com/simplyRoba/pixoo-bridge.rs)** — a drop-in replacement written in Rust. Same HTTP API, ~2 MB RAM instead of ~200 MB. See the [migration guide](https://github.com/simplyRoba/pixoo-bridge.rs#migration) for details.   

# Pixoo Bridge

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

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

![GitHub License](https://img.shields.io/github/license/simplyRoba/pixoo-bridge?link=https%3A%2F%2Fgithub.com%2FsimplyRoba%2Fpixoo-bridge%2Fblob%2Fmain%2FLICENSE)

![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/simplyRoba/pixoo-bridge/run-tests.yaml?link=https%3A%2F%2Fgithub.com%2FsimplyRoba%2Fpixoo-bridge%2Factions%2Fworkflows%2Frun-tests.yaml%3Fquery%3Dbranch%253Amain)

[![GitHub release (with filter)](https://img.shields.io/github/v/release/simplyRoba/pixoo-bridge?link=https%3A%2F%2Fgithub.com%2FsimplyRoba%2Fpixoo-bridge%2Freleases)](https://github.com/simplyRoba/pixoo-bridge/releases)

[![GitHub issues](https://img.shields.io/github/issues/simplyRoba/pixoo-bridge?link=https%3A%2F%2Fgithub.com%2FsimplyRoba%2Fpixoo-bridge%2Fissues)](https://github.com/simplyRoba/pixoo-bridge/issues)

![GitHub Repo stars](https://img.shields.io/github/stars/simplyRoba/pixoo-bridge)

# Configuration

Pass key as environment variable the docker container.

| Key                          | Default value    | Description                                       |

|------------------------------|------------------|---------------------------------------------------|

| PIXOO_BASE_URL               | http://localhost | Protocol and IP of the pixoo in the network       |

| PIXOO_SIZE                   | 64               | screen size of the pixoo                          |

| PIXOO_ANIMATION_SPEED_FACTOR | 1.4              | Factor to adjust animation speed of uploaded gifs |

| PIXOO_BRIDGE_PORT            | 4000             | Port of the pixxo bridge in the container         |

| PIXOO_BRIDGE_HEALTH_FORWARD  | true             | Ping pixoo during image health check              |

| PIXOO_BRIDGE_DOCS_ENABLED    | true             | Enable API documentation (Swagger UI)             |

| PIXOO_BRIDGE_MAX_IMAGE_SIZE  | 5MB              | Image size for uploads. Format like 128KB or 5MB  |

| PIXOO_BRIDGE_LOG_LEVEL       | INFO             | Possible values OFF, DEBUG, INFO, WARN, ERROR     |

# Run the image

replace the ip of your pixoo and run

```shell

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

```

or use the [docker-compose.yaml](/docker-compose.yaml)

```shell

docker compose up -d

```

# Documentation

## API

Generated API documentation can be reached under 

```

http://localhost:4000

```

![Swagger Screenshot](/docs/swagger-screenshot.png)

## Migration Guides

### from 0.x to 1.x

Rename configuration parameter in your `compose.yaml`.

| old name   | new name       |

|------------|----------------|

| PIXOO_HOST | PIXOO_BASE_URL | 

### from 1.x to 2.x

Rename configuration parameter in your `compose.yaml:` 

| old name             | new name                    |

|----------------------|-----------------------------|

| PIXOO_HEALTH_FORWARD | PIXOO_BRIDGE_HEALTH_FORWARD |

| PIXOO_DOCS_ENABLED   | PIXOO_BRIDGE_DOCS_ENABLED   |

| PIXOO_MAX_IMAGE_SIZE | PIXOO_BRIDGE_MAX_IMAGE_SIZE |

| PIXOO_LOG_LEVEL      | PIXOO_BRIDGE_LOG_LEVEL      |

## Limitations

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

## Further resources

### Official product page

[Pixoo64](https://divoom.com/products/pixoo-64)

### Pixoo API

[Official Divoom API documentation](http://doc.divoom-gz.com/web/#/12?page_id=191)