bd20288b81
Feature/btdm bluedroid This branch contain the bluedroid host code. Currently, Only GAP/GATT SERVER/GATT CLIENT release to users. Actually, the content of the codes is further more than GAP/GATT and etc. In this release version, users only need to concern about the APIs which are in "api/include/". Now, suggestions in comment have been resolved are following: 1. The APIs use callback function. Ivan , Jeroen and me have discussed it. Currently the code will not be changed. 2. The APIs use OPEN/CLOSE. I have ask Ivan, besides bluedroid do this, we will keep the name. 3. Coding style. I have run format.sh to handle the style. And some spell error have been fixed. 4. APIs doxygen. I have clean the warning by doxygen. But bt.rst is still need to be completed. 5. Other comment without resolved face to face that I have to add response in the comment and fix them in the code 6. Fix some incorrect things. See the git log for details. This 1st version of bluedroid release still have lots of things to do. But it can be done after this merge. 1. Compelete the BLUFI(Bluetooth config wifi connection) documents, security, application protocol and other. 2. Add SPP-LIKE profile. 3. Do more examples codes to cover most of the APIs. 4. Test and fix bug. Another thing： 1. Do the document of APIs.(xml->bt.rst->html) (I will do this before merge as Ivan's suggestion) This is already done. Besides, the union type in doxygen have something error. Ivan will fix it. See merge request !239 |
||
|---|---|---|
| .. | ||
| 01_hello_world | ||
| 02_blink | ||
| 03_http_request | ||
| 04_https_request | ||
| 05_ble_adv | ||
| 06_sntp | ||
| 07_nvs_rw_value | ||
| 08_nvs_rw_blob | ||
| 09_openssl_client | ||
| 10_openssl_server | ||
| 11_rmt_nec_tx_rx | ||
| 12_blufi | ||
| 13_timer_group | ||
| 14_ethernet | ||
| 14_gatt_server | ||
| 15_gatt_client | ||
| 16_pcnt | ||
| 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_PATHenvironment 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 menuconfigto configure the example. Most examples require a simple WiFi SSID & password via this configuration. -
maketo 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.