Skip to content

jcdc404/embedded-interface-demo

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Embedded Interface Demo

MIT/Apache-2.0 licensed

A simple demonstration of a self-hosted web interface running on an ESP32-C3, in Rust. Starts a soft access point and a web server running on-device, and serves the bundled single-page app.

This example is intended to be run on the ESP32-C3-DevKitM-1 development board, however should work with any board based on the ESP32-C3 with some minor modifications.

Quickstart

A number of tools are required in order to build and flash this project. Please ensure that each dependency listed below has been properly installed on your system.

Tool Download
cargo https://rustup.rs/
npm https://nodejs.org/en/
cargo espflash https://github.com/esp-rs/espflash

Commands for building and flashing the firmware have been included following the workflow defined by cargo-xtask. Please see the cargo-xtask README for more information.

Build the Interface and Firmware

In order to build the web interface, place the bundled single-page application in the correct location, and subsequently build the firmware, from the root of the repository run:

$ cargo xtask build

Flash the Firmware

With your development board plugged in to your computer via a USB cable, you can then flash the firmware to the board and open a serial monitor when the process has completed:

$ cargo xtask flash

License

Licensed under either of:

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

About

No description, website, or topics provided.

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 64.5%
  • JavaScript 27.6%
  • CSS 6.1%
  • HTML 1.8%