History

Anuj Deshpande 6238459dd7 docs: Fix broken link in nvs and jtag example - Closes https://github.com/espressif/esp-idf/issues/1922		2018-05-07 12:38:20 +05:30
..
bluetooth	component/bt: Add APIs of get and remove bond device	2018-05-03 19:05:57 +08:00
ethernet	feat(emac): add support for emac to use internal (APLL) clock outputs.	2017-11-13 14:18:58 +08:00
get-started	sdkconfig: Remove rest of the references to WIFI_ENABLED	2017-08-16 15:55:42 +05:30
mesh/internal_transceiver	mesh: add fix root function	2018-04-26 21:15:35 +08:00
peripherals	example(spi_master): add descriptions about LCD example	2018-05-03 11:48:26 +08:00
protocols	Fix potential NULL pointer dereference crash.	2018-04-30 08:03:35 +01:00
storage	docs: Fix broken link in nvs and jtag example	2018-05-07 12:38:20 +05:30
system	docs: Fix broken link in nvs and jtag example	2018-05-07 12:38:20 +05:30
wifi	example: set default SPI flash mode to 40Mhz for iperf example	2018-05-03 10:42:34 +08:00
README.md	examples: Standardise naming of files, symbols, etc. in examples	2017-03-27 17:42:05 +11: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.rst 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.
Names (of files, functions, variables, etc.) inside examples should be distinguishable from names of other parts of IDF (ideally, use example in names.)
Functions and variables used inside examples should be declared static where possible.
Examples should demonstrate one distinct thing each. Avoid multi-purposed "demo" examples, split these into multiple examples instead.
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.