alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
5a9801aca7
esp-idf/examples
History
Tian Hao 5a9801aca7 Merge branch 'master' into feature/btdm_bluedroid 
# Conflicts:
#	components/esp32/cpu_freq.c
#	components/esp32/lib
2016-11-29 18:38:37 +08:00
..
01_hello_world implement esp_deep_sleep, fix build issues 2016-11-22 21:54:49 +08:00
02_blink examples: Update component.mk for new conventions 2016-11-16 14:20:47 +11:00
03_http_request examples: Update component.mk for new conventions 2016-11-16 14:20:47 +11:00
04_https_request Fixes for stdlib.h inclusion 2016-11-24 08:20:21 +11:00
05_ble_adv component/bt : run astyle handle the code files 2016-11-25 02:10:15 +08:00
06_sntp implement esp_deep_sleep, fix build issues 2016-11-22 21:54:49 +08:00
07_nvs_rw_value implement esp_deep_sleep, fix build issues 2016-11-22 21:54:49 +08:00
08_nvs_rw_blob implement esp_deep_sleep, fix build issues 2016-11-22 21:54:49 +08:00
09_openssl_client components/openssl_demo: remove the apache license header and add cc license head 2016-11-18 10:07:34 +08:00
10_openssl_server components/openssl_demo: remove the apache license header and add cc license head 2016-11-18 10:07:34 +08:00
11_rmt_nec_tx_rx add RMT driver and example 2016-11-22 00:57:19 +08:00
12_blufi Merge branch 'master' into feature/btdm_bluedroid 2016-11-29 18:38:37 +08:00
13_bt_sdp component/bt : add license header 2016-11-25 01:58:26 +08:00
13_timer_group driver: add hardware timer code. 2016-11-23 02:15:27 +08:00
14_gatt_server component/bt : cleanup status and spell check 2016-11-28 22:40:30 +08:00
15_gatt_client component/bt : add comment for doxygen 2016-11-28 21:59:04 +08:00
16_pcnt Merge branch 'master' into feature/btdm_bluedroid 2016-11-29 18:38:37 +08:00
README.md Fixed broken links 2016-11-05 17:04:35 +01: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.
  • 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.