Update documentation.

This commit is contained in:
h2zero committed 2021-01-15 21:51:49 -07:00
1 parent a4e085f71a
commit 559a6e6970
5 files changed
+108 -19

No files matched your search

+5 -16
View File
@@ -50,29 +50,18 @@ If you are familiar with the original library, see: [The migration guide](Migrat
Also see [Improvements_and_updates](Improvements_and_updates.md) for information about non-breaking changes.
### Arduino specific:
### Arduino specific
See the Refactored_original_examples in the examples folder for highlights of the differences with the original library.
More advanced examples highlighting many available features are in examples/NimBLE_Server, NimBLE_Client.
Beacon examples provided by [beegee-tokyo](https://github.com/beegee-tokyo) are in examples/BLE_Beacon_Scanner, BLE_EddystoneTLM_Beacon, BLE_EddystoneURL_Beacon.
Change the settings in the nimconfig.h file to customize NimBLE to your project, such as increasing max connections (default == 3).
Change the settings in the nimconfig.h file to customize NimBLE to your project, such as increasing max connections (default is 3).
<br/>
**Note To increase max connections in Arduino it is also required to change the controller max connections defined in sdkconfig.h.**
This is located in your Arduino/hardware/espressif/esp32/tools/sdk/include/config folder.
The values in `sdkconfig.h` you will need to change are:
```
#define CONFIG_BTDM_CONTROLLER_BLE_MAX_CONN 3
#define CONFIG_BTDM_CONTROLLER_BLE_MAX_CONN_EFF 3
```
In `nimconfig.h` the value is:
```
#define CONFIG_BT_NIMBLE_MAX_CONNECTIONS 3
```
Espressif has stated the hard maximum connections is 9.
### Command line and platformio
See the command line configuration options available in [Command_line_config](Command_line_config.md).
<br/>
# Acknowledgments