Startseite Erkunden Hilfe
Anmelden
RT-Thread-packages
/
esp-idf
Mirror von https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Dateien Issues 0 Wiki
Struktur: 0d00a1ba01
Branches Tags
esp-idf
/
examples
Angus Gratton ea19838d3a Build: Handle WiFi & BT enabled/disabled combos gracefully as possible vor 9 Jahren
..
01_hello_world 06e03ff52e Replace backwards-compatible portTICK_RATE_MS with FreeRTOS v8+ portTICK_PERIOD_MS vor 9 Jahren
02_blink ea19838d3a Build: Handle WiFi & BT enabled/disabled combos gracefully as possible vor 9 Jahren
03_http_request 06e03ff52e Replace backwards-compatible portTICK_RATE_MS with FreeRTOS v8+ portTICK_PERIOD_MS vor 9 Jahren
04_https_request 06e03ff52e Replace backwards-compatible portTICK_RATE_MS with FreeRTOS v8+ portTICK_PERIOD_MS vor 9 Jahren
05_ble_adv 2e78b397bc config: Simplify WiFi & Bluetooth config options vor 9 Jahren
06_sntp 88ddf5aefa deep sleep: rename header file vor 9 Jahren
07_nvs_rw_value 06e03ff52e Replace backwards-compatible portTICK_RATE_MS with FreeRTOS v8+ portTICK_PERIOD_MS vor 9 Jahren
08_nvs_rw_blob 06e03ff52e Replace backwards-compatible portTICK_RATE_MS with FreeRTOS v8+ portTICK_PERIOD_MS vor 9 Jahren
09_openssl_client d6ec6d1ae5 example/09_openssl_client: change default port to be 443 vor 9 Jahren
10_openssl_server 8c7dfef317 examples/10_openssl_server: fixup SSL server with method of specific version vor 9 Jahren
11_rmt_nec_tx_rx 3cfe738fcf Merge branch 'bugfix/minor_issues' into 'master' vor 9 Jahren
12_blufi 2e78b397bc config: Simplify WiFi & Bluetooth config options vor 9 Jahren
13_timer_group 2f9772860a Examples: Add READMEs for examples which did not have them vor 9 Jahren
14_gatt_server ea19838d3a Build: Handle WiFi & BT enabled/disabled combos gracefully as possible vor 9 Jahren
15_gatt_client ea19838d3a Build: Handle WiFi & BT enabled/disabled combos gracefully as possible vor 9 Jahren
16_pcnt 3cfe738fcf Merge branch 'bugfix/minor_issues' into 'master' vor 9 Jahren
17_ethernet 0e701e1cac ethernet: support flow control vor 9 Jahren
18_i2c 9c7cc86793 1. modify i2c_set_pin function vor 9 Jahren
19_sigmadelta 3cfe738fcf Merge branch 'bugfix/minor_issues' into 'master' vor 9 Jahren
20_uart 9dbdab5c9a driver: uart vor 9 Jahren
21_gpio ade7ee2092 gpio_driver: add per-pin interrupt handlers vor 9 Jahren
22_i2s 5462d98e5a Add i2s driver vor 9 Jahren
23_coap_client 6ca2934843 example: fix CI error of coap client demo vor 9 Jahren
24_coap_server 4491dd0e2a example: fix CI error of coap server demo vor 9 Jahren
25_ota 1b9f477b15 example: Reindex ota demo vor 9 Jahren
26_spi_master ee59fa75f4 Rename SPI Master IO pins to more common terminology, add better explanation to queue_length initialization value vor 9 Jahren
27_sd_card a2ace698ed sdmmc: fix explanation of flash voltage regulator configuration efuses vor 9 Jahren
29_ledc 6b5e734901 driver: ledc - update fading functions, add example and doc vor 9 Jahren
30_mdns_example dd3f18d2d8 Initial mDNS component and example vor 9 Jahren
31_wpa2_enterprise ff4a5a1406 wpa2 enterprise: add example for wpa2 enterprise vor 9 Jahren
33_gatt_server_service_table 142756615b component/bt : mv demo name vor 9 Jahren
README.md b981b195be Fixed broken links vor 9 Jahren

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.