Skip to content

kedars/esp-jumpstart

 
 

Repository files navigation

ESP-Jumpstart

[中文]

Cover Page
ESP-Jumpstart: Build ESP32 Products Fast

Building production-ready firmware can be hard. It involves multiple questions and decisions about the best ways of doing things. It involves building phone applications, and integrating cloud agents to get all the features done. What if there was a ready reference, a known set of best steps, gathered from previous experience of others, that you could jumpstart with?

ESP-Jumpstart is focused on building ’products’ on ESP32. It is a quick-way to get started into your product development process. ESP-Jumpstart builds a fully functional, ready to deploy “Smart Power Outlet” in a sequence of incremental tutorial steps. Each step addresses either a user-workflow or a developer workflow. Each step is an application built with ESP-IDF, ESP32’s software development framework.

Smart Power Outlet

The ESP-Jumpstart’s Smart Power Outlet firmware assumes the device has one input push-button, and one GPIO output. It implements the following commonly required functionality.

  • Allows user’s home Wi-Fi network configuration through phone applications (iOS/Android)
  • Ability to switch on or off a single GPIO output
  • Use a push-button to physically toggle this output
  • Allow remote control of this output through a cloud
  • Implements over-the-air (OTA) firmware upgrade
  • Performs Reset to Factory settings on long-press of the push-button

Building your production firmware, is a matter of replacing the power-outlet’s device driver, with your device driver (bulb, washing machine).

Jumpstart Applicability

You will require the following to get started:

Please ensure to use ESP-IDF v3.2 from either the tagged release or the following command,

git clone https://github.com/espressif/esp-jumpstart.git
git clone --recursive https://github.com/espressif/esp-idf.git
cd esp-idf
git checkout -b release/v3.2 origin/release/v3.2
cd ../esp-jumpstart
export IDF_PATH=</path/to/esp-idf/>

About

Jumpstart from concept to production

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C 85.0%
  • C++ 9.6%
  • CMake 3.1%
  • Makefile 2.3%