OVMS3-idf/examples
Wangjialin ade7ee2092 gpio_driver: add per-pin interrupt handlers
1. add ISR handler apis so that users of different layers can hook their own isr handler on different GPIO.
    Audio project has different software layers, they need different gpio isr handler for layer instead of processing all GPIO interrupts in one handler.
    If this kind of calling a handler from isr is not proper, please kindly point out.
2. add gpio example code.
3. improve gpio.rst
4. add readme for gpio example

Squashed commits:
[278e50f] update: GPIO
1. coding style, add a space between conditional or loop keyword and an opening paren.
2. modify some return value and doc
3. use printf in example code
Squashed commits:
[efb23bb] minor change of comment
2016-12-29 11:16:32 +08:00
..
01_hello_world Replace backwards-compatible portTICK_RATE_MS with FreeRTOS v8+ portTICK_PERIOD_MS 2016-12-28 10:23:13 +11:00
02_blink Replace backwards-compatible portTICK_RATE_MS with FreeRTOS v8+ portTICK_PERIOD_MS 2016-12-28 10:23:13 +11:00
03_http_request Replace backwards-compatible portTICK_RATE_MS with FreeRTOS v8+ portTICK_PERIOD_MS 2016-12-28 10:23:13 +11:00
04_https_request Replace backwards-compatible portTICK_RATE_MS with FreeRTOS v8+ portTICK_PERIOD_MS 2016-12-28 10:23:13 +11:00
05_ble_adv component/bt : run astyle handle the code files 2016-11-25 02:10:15 +08:00
06_sntp deep sleep: rename header file 2016-12-16 14:30:27 +08:00
07_nvs_rw_value Replace backwards-compatible portTICK_RATE_MS with FreeRTOS v8+ portTICK_PERIOD_MS 2016-12-28 10:23:13 +11:00
08_nvs_rw_blob Replace backwards-compatible portTICK_RATE_MS with FreeRTOS v8+ portTICK_PERIOD_MS 2016-12-28 10:23:13 +11:00
09_openssl_client example/09_openssl_client: change default port to be 443 2016-12-08 20:28:45 +08:00
10_openssl_server ethernet: add first version of ethernet driver 2016-12-01 19:17:48 +08:00
11_rmt_nec_tx_rx Merge branch 'bugfix/minor_issues' into 'master' 2016-12-28 13:18:34 +08:00
12_blufi Replace backwards-compatible portTICK_RATE_MS with FreeRTOS v8+ portTICK_PERIOD_MS 2016-12-28 10:23:13 +11:00
13_timer_group Examples: Add READMEs for examples which did not have them 2016-12-22 15:07:02 +11:00
14_ethernet/main feature/ethernet_driver: update ethernet driver 2016-12-26 14:50:49 +08:00
14_gatt_server component/bt : cleanup the un-necessary include in api.h 2016-12-09 14:38:21 +08:00
15_gatt_client component/bt : remove sdp demo and add default sdkconfig of bt demos 2016-11-30 11:26:30 +08:00
16_pcnt Merge branch 'bugfix/minor_issues' into 'master' 2016-12-28 13:18:34 +08:00
17_ethernet Replace backwards-compatible portTICK_RATE_MS with FreeRTOS v8+ portTICK_PERIOD_MS 2016-12-28 10:23:13 +11:00
19_sigmadelta Merge branch 'bugfix/minor_issues' into 'master' 2016-12-28 13:18:34 +08:00
20_uart driver: uart 2016-12-21 11:55:53 +08:00
21_gpio gpio_driver: add per-pin interrupt handlers 2016-12-29 11:16:32 +08:00
README.md Fixed broken links 2016-11-05 17:04:35 +01: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.
  • 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.