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
3f4e917ad6
esp-idf/examples
History
Jiang Jiang Jian 3f4e917ad6 Merge branch 'feature/ppp_over_serial' into 'master' 
Enable experimental/unsupported PPP over Serial driver

From PR #272 https://github.com/espressif/esp-idf/pull/272

See merge request !690
2017-04-25 14:02:55 +08:00
..
bluetooth Replace to strncmp from strcmp to check device_name on examples/bluetooth/gatt_client 2017-04-18 10:29:36 +10: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 examples: Standardise naming of files, symbols, etc. in examples 2017-03-27 17:42:05 +11:00
protocols PPPoS example: Move pin configuration to menuconfig, add log statement 2017-04-21 14:29:16 +10:00
storage examples: Standardise naming of files, symbols, etc. in examples 2017-03-27 17:42:05 +11:00
system OTA example readme: [typo]: Worflow to Workflow 2017-04-21 11:03:07 +10: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.