mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00

History

gengyuchao f1ac73f496 example/ble_hid_device_demo fix the wrong mask value according to HID protocol		2020-03-21 13:55:43 +08:00
..
bluetooth	example/ble_hid_device_demo fix the wrong mask value according to HID protocol	2020-03-21 13:55:43 +08:00
ethernet	ethernet: add kconfig help for GPIO0 output mode	2019-10-17 08:10:06 +00:00
get-started	cmake: make main a component again	2018-09-13 11:13:27 +08:00
mesh	mesh: bugfix	2018-09-25 13:43:55 +08:00
peripherals	VFS: select() on UART should return immediately when data is buffered	2018-11-29 10:12:25 +01:00
protocols	mdns example: fix print result for IPv6 addresses	2019-03-06 06:28:55 +00:00
storage	cmake: make main a component again	2018-09-13 11:13:27 +08:00
system	examples: don't enable buffering on stdout in console examples	2019-06-20 16:27:42 +08:00
wifi	esp_wifi: Additional code snippets in esp_wifi_scan_example (backport v3.1)	2020-02-25 14:22:08 +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.