You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-7Lines changed: 20 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# NimBLE-Arduino
2
2
A fork of the NimBLE stack restructured for compilation in the Ardruino IDE with a CPP library for use with ESP32.
3
3
4
-
**Note for IDF users: An ESP-IDF component version of this library can be [found here](https://github.com/h2zero/esp-nimble-cpp), this will not compile correctly in ESP-IDF**.
4
+
**Note for IDF users: This repo will not compile correctly in ESP-IDF. An ESP-IDF component version of this library can be [found here.](https://github.com/h2zero/esp-nimble-cpp)**
5
5
6
6
This library **significantly** reduces resource usage and improves performance for ESP32 BLE applications as compared
7
7
with the bluedroid based library. The goal is to maintain, as much as reasonable, compatibility with the original
@@ -53,10 +53,25 @@ More advanced examples highlighting many available features are in examples/ Nim
53
53
Beacon examples provided by @beegee-tokyo are in examples/ BLE_Beacon_Scanner, BLE_EddystoneTLM_Beacon, BLE_EddystoneURL_Beacon.
54
54
55
55
Change the settings in the `nimconfig.h` file to customize NimBLE to your project, such as increasing max connections, default is 3.
56
+
57
+
**Note To increase max connections in Arduino it is also required to change the controller max connections defined in sdkconfig.h.**
58
+
59
+
This is located in your Arduino/hardware/espressif/esp32/tools/sdk/include/config folder.
60
+
61
+
The values in `sdkconfig.h` you will need to change are:
62
+
```
63
+
#define CONFIG_BTDM_CONTROLLER_BLE_MAX_CONN 3
64
+
#define CONFIG_BTDM_CONTROLLER_BLE_MAX_CONN_EFF 3
65
+
```
66
+
In `nimconfig.h` the value is:
67
+
```
68
+
#define CONFIG_BT_NIMBLE_MAX_CONNECTIONS 3
69
+
```
70
+
Espressif has stated the hard maximum connections is 9.
56
71
<br/>
57
72
58
73
# Continuing development
59
-
This Library is tracking the esp-nimble repo, nimble-1.2.0-idf master branch, currently [@46c1d9f.](https://github.com/espressif/esp-nimble)
74
+
This Library is tracking the esp-nimble repo, nimble-1.2.0-idf master branch, currently [@95bd864.](https://github.com/espressif/esp-nimble)
60
75
61
76
Also tracking the NimBLE related changes in ESP-IDF, master branch, currently [@2ef4890.](https://github.com/espressif/esp-idf/tree/master/components/bt/host/nimble)
62
77
<br/>
@@ -68,9 +83,7 @@ Also tracking the NimBLE related changes in ESP-IDF, master branch, currently [@
68
83
<br/>
69
84
70
85
# Todo
71
-
1. Implement random addresses.
72
-
2. Implement NimBLEServer::removeService
73
-
3. Implement extra fields in NimBLEAdvertisedDevice.
Copy file name to clipboardExpand all lines: docs/index.md
+20-5Lines changed: 20 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,14 +48,29 @@ See: [Breaking API Changes vs Original](docs/BREAKING_API_CHANGES.md) for detail
48
48
49
49
Also see [Improvements_and_updates](docs/Improvements_and_updates.md) for information about non-breaking changes.
50
50
51
-
### Arduino
52
-
See the Refactored_original_examples in the examples folder for highlights of the differences with the original library.
51
+
### Arduino specific:
52
+
See the Refactored_original_examples in the examples folder for highlights of the differences with the original library.
53
53
54
-
More advanced examples highlighting many available features are in examples/NimBLE_Server, NimBLE_Client.
54
+
More advanced examples highlighting many available features are in examples/NimBLE_Server, NimBLE_Client.
55
55
56
-
Beacon examples provided by [beegee-tokyo](https://github.com/beegee-tokyo) are in examples/BLE_Beacon_Scanner, BLE_EddystoneTLM_Beacon, BLE_EddystoneURL_Beacon.
56
+
Beacon examples provided by [beegee-tokyo](https://github.com/beegee-tokyo) are in examples/BLE_Beacon_Scanner, BLE_EddystoneTLM_Beacon, BLE_EddystoneURL_Beacon.
57
57
58
-
Change the settings in the nimconfig.h file to customize NimBLE to your project, such as increasing max connections (default == 3).
58
+
Change the settings in the nimconfig.h file to customize NimBLE to your project, such as increasing max connections (default == 3).
59
+
60
+
**Note To increase max connections in Arduino it is also required to change the controller max connections defined in sdkconfig.h.**
61
+
62
+
This is located in your Arduino/hardware/espressif/esp32/tools/sdk/include/config folder.
63
+
64
+
The values in `sdkconfig.h` you will need to change are:
65
+
```
66
+
#define CONFIG_BTDM_CONTROLLER_BLE_MAX_CONN 3
67
+
#define CONFIG_BTDM_CONTROLLER_BLE_MAX_CONN_EFF 3
68
+
```
69
+
In `nimconfig.h` the value is:
70
+
```
71
+
#define CONFIG_BT_NIMBLE_MAX_CONNECTIONS 3
72
+
```
73
+
Espressif has stated the hard maximum connections is 9.
0 commit comments