simplyroba / pixoo-bridge Goto Github PK

View Code? Open in Web Editor NEW

3.0 4.0 0.0 2.06 MB

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

License: GNU General Public License v3.0

Kotlin 98.81% Dockerfile 1.19%

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

pixoo-bridge's Introduction

Pixoo Bridge

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

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

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

pixoo-bridge's People

Contributors

Stargazers

Watchers

pixoo-bridge's Issues

run image not as root

RUN addgroup -S demo && adduser -S demo -G demo
USER demo

https://www.baeldung.com/linux/docker-alpine-add-user
https://stackoverflow.com/questions/44683119/dockerfile-replicate-the-host-user-uid-and-gid-to-the-image

add ktfmt for formatting

https://github.com/diffplug/spotless

plugins { id("com.diffplug.spotless") }

repositories { mavenCentral() }

spotless {
  format("misc") {
    target("**/*.yml", "**/*.yaml", ".gitignore",)
    targetExclude("**/build/**/*", "**/.idea/**")
    trimTrailingWhitespace()
    endWithNewline()
    indentWithSpaces(2)
  }

  kotlin {
    target("**/src/**/*.kt", "**/src/**/*.kts", "**/buildSrc/**/*.kts")
    targetExclude("**/build/**/*.kts", "**/build/**/*.kt")
    ktfmt().googleStyle()
    indentWithSpaces(2)
  }

  kotlinGradle {
    target("**/*.gradle.kts")
    targetExclude("**/build/**/*.gradle.kts")
    ktfmt().googleStyle()
  }

  freshmark { target("*.md") }
}

export test report

for example with https://github.com/mikepenz/action-junit-report

add memory usage options to dockerfile

Evaluate scrimmage for image manipulation

https://github.com/sksamuel/scrimage

Upload image function with url

Is your feature request related to a problem? Please describe.
Uploading an image needs always to download the image to the client first.

Describe the solution you'd like
Pass a url to the bridge, so the image can be downloaded there get resized and uploaded to the pixoo.

Evaluate jib for container creation

https://github.com/GoogleContainerTools/jib

create tag when gradle version changes

tag can be used to make release

fix gradle dependency submission action

https://github.com/mikepenz/gradle-dependency-submission

Retry request when connection reset exception is thrown

This can happen if the pixxo was restarted or lost connection to the wifi.
The bridge should handle such case and reconnect to the pixoo and execute the command again.

publish image to github packages

https://gist.github.com/mihkels/f19ea45e4d05b7741569d7575f5f7026

https://github.com/docker/setup-qemu-action
https://github.com/docker/setup-buildx-action
https://github.com/docker/metadata-action
https://github.com/docker/login-action
https://github.com/docker/build-push-action

https://docs.github.com/en/actions/publishing-packages/publishing-docker-images#publishing-images-to-github-packages

https://docs.docker.com/build/ci/github-actions/multi-platform/

https://spring.io/guides/topicals/spring-boot-docker/

# platforms: linux/amd64,linux/arm64,linux/riscv64,linux/ppc64le,linux/s390x,linux/386,linux/mips64le,linux/mips64,linux/arm/v7,linux/arm/v6
platforms: linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6

FROM eclipse-temurin:17-jre as builder
WORKDIR application
ARG JAR_FILE=target/*.jar
COPY ${JAR_FILE} application.jar
RUN java -Djarmode=layertools -jar application.jar extract

FROM eclipse-temurin:17-jre
WORKDIR application
COPY --from=builder application/dependencies/ ./
COPY --from=builder application/spring-boot-loader/ ./
COPY --from=builder application/snapshot-dependencies/ ./
COPY --from=builder application/application/ ./
ENTRYPOINT ["java", "org.springframework.boot.loader.JarLauncher"]

make project public

TODOs before

add CODEOWNERS ✅ #42
improve readme.md
badges (package downloads, stars, release version)
check branch protection
check rights on repo (pushing other branches than main, ..)
add contributing.md
add issue template