Skip to content

MathieuAndrade/Esp-flasher

Repository files navigation


Logo

Esp Flasher

An app for beginner user to flash firmware and image on esp devices without installing an ide and some complicated software.
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Download
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project


Logo

There are many methods to upload firmware to esp devices, but every developer has at least once encountered a frustrated user who tried to use their program and failed it. Why ? The response is very simple, because user has not installed all necessary libraries or he has installed bad version of libraries or he has not configured his IDE correctly. And for this user, the fault lies to the developer.

This case is all the more present when the project is destined to be distributed in an open source way.

So this is goals of this project to solve this problem:

  • End user not need to install anything instead of this software
  • End user only needs minimal and simple configuration
  • Developers build a bin file (bin file that works) and send it to user
  • End user upload his bin file and it works, nothing else

(back to top)

Getting Started

Prerequisites

This app required Rust and Yarn installation. Keep in mind that this section is only needed for developing purpose. If you are simple user, you not required to do any of this, instead go to download section.

Installation

  1. Clone the repo
    git clone https://github.com/MathieuAndrade/Esp-flasher.git esp-flasher
  2. Go into the repository
    cd esp-flasher
  3. Install NPM packages
    yarn install
  4. Run the app
    yarn tauri dev

(back to top)

Download

You can download the latest installable version of Esp-Flasher for Windows, macOS and Linux.

Roadmap

  • Allow Arduino boards
  • Allow developers to create a configuration file imported by users
  • Multi-language Support
  • Make a portable version for Windows platform (check this issue)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Mathieu Andrade - @MathieuAndrade - [email protected]

Project Link: https://github.com/MathieuAndrade/Esp-flasher

(back to top)

Acknowledgments

(back to top)