OVMS3-idf/examples
Piyush Shah affde01b4c wifi_scan_example: Comments improved for readability
Rephrased the example's description to make it easier to understand
and made other grammatical fixes.

Signed-off-by: Piyush Shah <piyush@espressif.com>
2017-11-15 15:02:31 +05:30
..
bluetooth Merge branch 'bugfix/btdm_modify_logs' into 'master' 2017-11-14 21:13:00 +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
performance example: optimize the robust of TCP connect 2017-08-10 18:19:50 +08:00
peripherals Fix markdown and format of GPIO example README 2017-11-07 20:27:10 +01:00
protocols Merge branch 'features/http2_demo' into 'master' 2017-11-15 14:51:51 +08:00
storage examples/sdmmc: enable internal pull-ups in SD mode 2017-10-13 08:21:06 +08:00
system Merge branch 'bugfix/examples_ulp_gpio15' into 'master' 2017-11-13 17:34:12 +08:00
wifi wifi_scan_example: Comments improved for readability 2017-11-15 15:02:31 +05:30
README.md examples: Standardise naming of files, symbols, etc. in examples 2017-03-27 17:42:05 +11:00

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.