Giter VIP home page Giter VIP logo

esp-jumpstart's Introduction

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

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

Documentation Build Status

Documentation Status

esp-jumpstart's People

Contributors

anurag-kar avatar chhajedji avatar dhrishi avatar jitin17 avatar kedars avatar krzychb avatar mahavirj avatar natashali-espressif avatar shahpiyushv avatar skywxfang avatar supreetd21 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.