fd3162d831
component/bt: optimiz the code component/bt: optimiz the code. component/bt: added the l2c change. component/bt: Added the modified. component/bt: change the indicate callback function. component/bt: added the BLE throughput test gattc & gatts example. component/bt: Change the sdkconfig.default CONFIG_GATTS_NOTIFY_THROUGHPUT setting. component/bt: Change the throughput_client_task delay method. component/bt: change the btu task size from 4096 to 5096 comonent/bt: close the print when congest. component/bt: Added the CPU frequency set method to the readme file. component/bt: Change the gatts_demo_char1_val to gl_profile_tab[PROFILE_A_APP_ID].char_handle to avoid make error. example/ble_throughput: Added the Readme explanation. component/bt: Added the bt lib change. component/bt: Update the bt lib & Change the LOG level from ERROR to DEBUG when congest. component/bt: Fixed the bug of timer start assign error. component/bt: Change back the gattc & gatts demo with same as the master. example/ble_throughput: Fixed the bug when prepare write of the ble throughput. component/bt: Update the check_sum algorithm. component/bt: Change Added the path when used the include file of "l2cdefs.h" & "l2c_api.h". example/throughput_client: Added the Freertos related header files to ble throughput client demo to avoid compile error. |
||
---|---|---|
.. | ||
bluetooth | ||
ethernet | ||
get-started | ||
mesh/internal_transceiver | ||
peripherals | ||
protocols | ||
storage | ||
system | ||
wifi | ||
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.