Skip to content

espressif/esp-jumpstart

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

ci: verify that examples build with all supported IDF versions

See merge request app-frameworks/esp-jumpstart!81
570641e

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

If you have already been using ESP Jumpstart, please have a look at some breaking Changes.

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 v4.4 from either the tagged release or the following command,

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

Documentation Build Status

Documentation Status