History

Tian Hao db007fbb2e component/bt : clean up the demos 1. cleanup gatt client demo 2. cleanup gatt server demo 3. cleanup blufi demo 4. use correct log level		2016-11-22 20:32:45 +08:00
..
01_hello_world	nvs: Remove flash layout arguments from nvs_init()	2016-09-27 13:28:45 +10:00
02_blink	nvs: Remove flash layout arguments from nvs_init()	2016-09-27 13:28:45 +10:00
03_http_request	Merge remote-tracking branch 'origin/bugfix/modify_some_wifi_apis' into feature/initial_examples	2016-09-27 19:37:06 +10:00
04_https_request	Merge remote-tracking branch 'origin/bugfix/modify_some_wifi_apis' into feature/initial_examples	2016-09-27 19:37:06 +10:00
05_ble_adv	component/bt : cleanup the liscence header	2016-11-05 02:48:16 +08:00
06_bluedroid_demos	component bt: Added the client demo to the bt project	2016-11-17 06:37:56 -05:00
07_blufi	component/bt : clean up the demos	2016-11-22 20:32:45 +08:00
08_bt_sdp	component/bt: merge SDP client and SDP server example to a single demo	2016-11-01 11:54:01 +08:00
09_gatt_server	component/bt : clean up the demos	2016-11-22 20:32:45 +08:00
10_gatt_client	component/bt : clean up the demos	2016-11-22 20:32:45 +08:00
README.md	Documentation: Add contributor guide, expand README & add an examples README	2016-09-27 10:38:00 +10:00

README.md

Examples

This directory contains a growing number of simple example projects for esp-idf. These are intended to show basic esp-idf functionality, and to provide you can use for your own projects.

Using Examples

Building examples is the same as building any other project:

Follow the setup instructions in the top-level esp-idf README.
Set IDF_PATH environment variable to point to the path to the esp-idf top-level directory.
Change into the directory of the example you'd like to build.
make menuconfig to configure the example. Most examples require a simple WiFi SSID & password via this configuration.
make to build the example.
Follow the printed instructions to flash, or run make flash.

Copying Examples

Each example is a standalone project. The examples do not have to be inside the esp-idf directory. You can copy an example directory to anywhere on your computer in order to make a copy that you can modify and work with.

The IDF_PATH environment variable is the only thing that connects the example to the rest of the esp-idf system.

If you're looking for a more bare-bones project to start from, try esp-idf-template.

Contributing Examples

If you have a new example you think we'd like, please consider sending it to us as a Pull Request.

Please read the esp-idf CONTRIBUTING.md file which lays out general contribution rules.

In addition, here are some tips for creating good examples:

A good example is documented and the basic options can be configured.
A good example does not contain a lot of code. If there is a lot of generic code in the example, consider refactoring that code into a standalone component and then use the component's API in your example.
Examples must be licensed under the Apache License 2.0 or (preferably for examples) if possible you can declare the example to be Public Domain / Creative Commons Zero.