# esp-jumpstart

**Repository Path**: espressif-systems/esp-jumpstart

## Basic Information

- **Project Name**: esp-jumpstart
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-12
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ESP-Jumpstart

[[English]](./README.md)

| [![Cover Page]](https://docs.espressif.com/projects/esp-jumpstart/zh_CN/latest/index.html) |
|:--------------------------:|
| **ESP-Jumpstart：快速构建基于 ESP32 的产品** |

有时，固件开发并非易事，特别是用于量产的固件。开发人员不但需要面临各种决策上的问题并权衡多种选择，而且还需开发手机 app，并接入各家云服务商。现在，我们盛情推出 ESP-Jumpstart 示例项目，内含产品开发的完整步骤、最佳做法，并融合其他同僚的经验之谈，助您快速启动基于 ESP32 的产品开发！

ESP-Jumpstart 项目专注于在 ESP32 上构建“产品”，展示了基于 ESP32 的完整产品开发流程。该项目分步介绍了一款真实产品的完整开发流程，即一款功能齐全、随时可推广的“智能电源插座”。其中，每个步骤均为用户/开发人员的工作流提供指南/参考，且使用了乐鑫专为 ESP32 打造的软件开发框架 ESP-IDF。

![Smart Power Outlet]

本项目中的“智能电源插座”硬件拥有一个实体按钮和一个 GPIO 输出端，可实现以下常见功能：

- 允许用户在家庭 Wi-Fi 网络环境中，通过手机 app（苹果/安卓）进行配置；
- 允许通过手机 app，打开/关闭 GPIO 输出端；
- 允许通过实体按钮，打开/关闭 GPIO 输出端；
- 允许通过云端，远程打开/关闭 GPIO 输出端；
- 支持 OTA 固件升级；
- 长按实体按钮，恢复出厂设置。

在实际开发中，您仅需将本项目中的“智能电源插座”替换为您的设备驱动程序（灯泡、洗衣机）即可。

![Jumpstart Applicability]

准备工作：

- ESP32 开发板：ESP32-DevKitC（[DigiKey](https://www.digikey.com.cn/products/zh?WT.z_header=search_go&keywords=esp32-devkitc)、[Mouser](https://www.mouser.cn/_/?Keyword=ESP32-DevKitC)、[亚马逊](https://www.amazon.cn/s/ref=nb_sb_noss?__mk_zh_CN=亚马逊网站&url=search-alias%3Daps&field-keywords=esp32-devkitc)、[淘宝](https://item.taobao.com/item.htm?spm=a1z38n.10677092.0.0.11891debEFopAX&id=542143157571)、[微店](https://detail.youzan.com/show/goods?alias=2fwmug42fe41s&activity_alias=undefined) 均有售。您也可以使用其他 ESP32 开发板。)
- 按照 [ESP-Jumpstart 快速入门指南](https://docs.espressif.com/projects/esp-jumpstart/zh_CN/latest/index.html)，搭建开发环境。 

注意，请使用 ESP-IDF v4.0 版本。您可以直接使用以下命令，获得 ESP-IDF v4.0。

```
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](https://readthedocs.com/projects/espressif-esp-jumpstart-zh-cn/badge/?version=latest)](https://docs.espressif.com/projects/esp-jumpstart/zh_CN/latest/)

[Smart Power Outlet]: docs/_static/jumpstart-outlet.png
[Jumpstart Applicability]: docs/_static/jumpstart-outlet-blocks.png
[Cover Page]: docs/_static/cover_page.svg