https://github.com/kubesail/pibox-framebuffer

The PiBox's LCD display server. Lightweight Go binary to draw images to the framebuffer
https://github.com/kubesail/pibox-framebuffer

Last synced: 8 months ago
JSON representation

The PiBox's LCD display server. Lightweight Go binary to draw images to the framebuffer

• Host: GitHub
• URL: https://github.com/kubesail/pibox-framebuffer
• Owner: kubesail
• Created: 2022-03-26T01:37:07.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-02-06T03:57:26.000Z (over 2 years ago)
• Last Synced: 2025-04-14T14:18:04.012Z (about 1 year ago)
• Language: Go
• Homepage:
• Size: 3.63 MB
• Stars: 19
• Watchers: 3
• Forks: 10
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# pibox-framebuffer

The PiBox's display server. Lightweight Go binary to draw images to the framebuffer

## Installation

* Enable SPI using `raspi-config` -> `Interfacing Options` -> `SPI`

* Reboot to enable SPI, `sudo reboot now`

* Download the latest [release](https://github.com/kubesail/pibox-framebuffer/releases)

* Set permissions, `chmod +x pibox-framebuffer`

* Run the binary using `./pibox-framebuffer`

Alternatively, install it as a service:

    mkdir /opt/kubesail

    mv pibox-framebuffer /opt/kubesail/pibox-framebuffer

    # Download the .service file from this repo:

    curl -L https://raw.githubusercontent.com/kubesail/pibox-framebuffer/main/pibox-framebuffer.service -o /etc/systemd/system/pibox-framebuffer.service

    systemctl daemon-reload

    systemctl enable pibox-framebuffer

## Usage

### Drawing an image

`curl --unix-socket /var/run/pibox/framebuffer.sock -X POST --data-binary @image.png http://localhost/image`

NOTE: Other text and graphics endpoints were supported in old versions, but for the sake of this code's simplicity, we now recommend updating to this version, creating an image using something like the NodeJS [Canvas](https://www.npmjs.com/package/canvas) package, and then then flushing it to the screen using the above endpoint. This new version uses SPI and is far more stable than the framebuffer kernel modules, which can inadvertently redirect console output to the LCD.

## Installing for development

    # Pack an image into the binary for splash screen

    go install github.com/rakyll/statik@latest

    statik -src=img/pibox-splash.png

    # Build the binary

    ./go-build.sh