Skip to content

Siryll/wg_display_embedded

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WG Display Embedded

Rust CI Pages Deploy Latest Release License

A hackable information display for the ESP32-S3-Box-3, based on wg_display.

Installation Guide

Differences to the Original

  • Fully rebuilt backend in no_std Rust using esp-rs and embassy
  • Frontend fixes and optimizations
  • Easy installation process using esp-web-tools
  • New Widget Template

Quick Start

If you just want to install and run the latest version on your ESP32-S3-Box-3, follow the hosted setup guide. No toolchain installation required!

Create your own Widget

Use the Embedded Widget Template to create your own widget. Complete with an automatic build pipeline to create the installable widget.

Check out these existing Widgets for inspiration:

Build From Source

Requirements

When using WSL, complete the required ESP packages first by following the WSL instructions for ESP.

Toolchain Setup

For picoserve, use the 1.93.0 pre-release toolchain via espup:

espup install --toolchain-version 1.93.0

Install Trunk for the frontend build:

cargo install trunk

Build And Run

git clone https://github.com/Siryll/wg_display_embedded.git
cd wg_display_embedded
make install-deps
make build
make run

Use larger font mode:

make run-large-font

After flashing, continue with the setup:

Command Reference

make install-deps      # install project dependencies
make build             # build firmware + frontend
make run               # flash and run firmware
make run-large-font    # flash and run with larger font

About

Embedded port the WG-Display, a Hackable information display fully built in Rust

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages