mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-11-22 05:00:55 +01:00
41 lines
No EOL
1.3 KiB
Markdown
41 lines
No EOL
1.3 KiB
Markdown
# *** UPDATE ***
|
|
Client long read/write characteristics/descriptors now working.
|
|
We are now nearing 100% replacement of the original cpp_utils BLE library :smile:
|
|
|
|
|
|
# esp-nimble-cpp
|
|
NimBLE CPP library for use with ESP32 that attempts to maintain compatibility with the @nkolban cpp_uitls API.
|
|
|
|
Why? Because the Bluedroid library is too bulky.
|
|
|
|
Initial client code testing has resulted in code size reduction of ~115k and reduced ram consumption of ~37k.
|
|
|
|
|
|
# Installation:
|
|
|
|
Download as .zip and extract to components folder in your esp-idf project.
|
|
|
|
Run menuconfig, go to `Component config->Bluetooth->` enable Bluetooth and select NimBLE host.
|
|
|
|
`#include "NimBLEDevice.h"` in main.cpp.
|
|
|
|
|
|
# Usage:
|
|
|
|
This library is intended to be compatible with the original ESP32 BLE functions and types with minor changes.
|
|
|
|
Check [API_DIFFERENCES](https://github.com/h2zero/esp-nimble-cpp/blob/master/API_DIFFERENCES.md) for details.
|
|
|
|
|
|
# Acknowledgments:
|
|
|
|
* @nkolban and @chegewara for the [original esp32 BLE library](https://github.com/nkolban/esp32-snippets) this project was derived from.
|
|
* @beegee-tokyo for contributing your time to test/debug and contributing the beacon examples.
|
|
|
|
|
|
# Todo:
|
|
|
|
1. Code cleanup.
|
|
2. Create documentation.
|
|
3. Expose more NimBLE features.
|
|
4. Add BLE Mesh code. |