Skip to content

luc-github/ESP3D-Configurator

Repository files navigation

ESP3D-Configurator Version

All Contributors

Web configurator to build ESP3D 3.x firmware settings: wizard UI → configuration.h and platformio.ini.

Live demo: luc-github.github.io

Features (overview)

  • Step-by-step wizard (Features, Network, Filesystems, Devices, …)
  • Board presets and import of a previous configuration.h (JSON snapshot at end of file)
  • Pin conflict detection before download
  • Light / dark UI theme

Documentation

Doc Description
API.md Configuration schema, tabs, pins, export/import, presets, planned work
CONTRIBUTING.md Development setup, npm scripts, PR checklist, CI

Development

Requirements: Node.js 20+, npm.

npm ci
npm run dev      # local development
npm run build    # production bundle in build/

Quality checks (run before a PR):

npm run validate:config
npm run build

CI runs the same steps on GitHub Actions (see .github/workflows/ci.yml).

Stack

The UI reuses patterns from ESP3D-WebUI to keep maintenance aligned across projects.

Using the configurator (makers)

  1. Walk the wizard tabs and set your board (MCU, flash, WiFi, pins, …).
  2. On Download, resolve any pin conflicts, then download configuration.h and platformio.ini.
  3. To restore settings later: FeaturesImport configuration.h (file must have been generated by this tool so the JSON snapshot is present).

See API.md — Configuration snapshot for technical details.

Project history

GitHub issue forms were dropped in favour of a single static page (works hosted on GitHub Pages or offline), similar in spirit to Repetier’s firmware configurator.

Warning

Disclaimer

The software is provided "as is," without any warranty of any kind, expressed or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software. It is essential that you carefully read and understand this disclaimer before using this software and its components. If you do not agree with any part of this disclaimer, please refrain from using the software.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Tomasz Mateja
Tomasz Mateja

🐛 💻

This project follows the all-contributors specification. Contributions of any kind welcome — see CONTRIBUTING.md.

About

Configurator for ESP3D Firmware

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors