History

Angus Gratton 7db85a386a Merge branch 'bugfix/i2s_driver' into 'master' I2S driver - fixed support for 24 and 32-bits, fixed tx/rx at the same time - Modify sample can test with 24, 32-bits audio - Add i2s sample README - simply i2s_push function - change sample rates, bits per sample, channel on fly See merge request !483		2017-04-28 08:00:07 +08:00
..
bluetooth	Merge branch 'feature/ci_minor_fixes' into 'master'	2017-04-28 00:25:13 +08:00
ethernet	Ethernet example: Add README, use menuconfig for all example pin assignments	2017-04-20 18:03:00 +10:00
get-started	examples: remove nvs_flash_init from examples which do not use NVS	2017-03-14 22:03:40 +08:00
performance	tcp_udp_perf: add license and modify some details	2017-04-18 15:23:28 +08:00
peripherals	Merge branch 'bugfix/i2s_driver' into 'master'	2017-04-28 08:00:07 +08:00
protocols	PPPoS example: Move pin configuration to menuconfig, add log statement	2017-04-21 14:29:16 +10:00
storage	add wear_levelling component and example	2017-04-17 11:01:17 +08:00
system	Add support for 32k XTAL as RTC_SLOW_CLK source	2017-04-26 12:43:22 +08:00
wifi	wps_ps: add license	2017-04-13 11:43:01 +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.