ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-12-25 20:20:47 +01:00
Code Issues Projects Releases Packages Wiki Activity
Mirror of https://github.com/h2zero/esp-nimble-cpp
178 commits 12 branches 14 tags 11 MiB
C++ 93.7%
C 6%
CMake 0.3%
Find a file
h2zero 9961c5605c Update docs version.
2021-08-02 21:25:17 -06:00
docs Update docs version. 2021-08-02 21:25:17 -06:00
examples [Server] Add callback for MTU change. (#55) 2021-07-19 21:47:59 -06:00
src Add missing return documentation in NimBLEAdvertising. 2021-08-02 19:51:04 -06:00
.travis.yml Update doxygen version. 2020-12-28 21:35:26 -07:00
CHANGELOG.md Release 1.3.0 2021-08-02 21:14:12 -06:00
CMakeLists.txt Remove FreeRTOS from CmakeLists. 2021-07-14 10:30:41 -06:00
CMakeLists.txt_idf3 Remove FreeRTOS from CmakeLists. 2021-07-14 10:30:41 -06:00
component.mk Add missing component.mk file. 2020-03-29 19:13:59 -06:00
Kconfig Conditionally compile code for specific roles. 2020-05-13 22:03:56 -06:00
LICENSE Initial commit. 2020-03-29 17:44:20 -06:00
README.md Update documentation. 2021-07-12 13:33:56 -06:00

README.md

Latest release Release Version Release Date

Need help? Have questions or suggestions? Join the Gitter

esp-nimble-cpp

NimBLE CPP library for use with ESP32 that attempts to maintain compatibility with the nkolban cpp_uitls BLE API.

An Arduino version of this library, including NimBLE, can be found here.

This library significantly reduces resource usage and improves performance for ESP32 BLE applications as compared
with the bluedroid based library. The goal is to maintain, as much as reasonable, compatibility with the original
library but refactored to use the NimBLE stack. In addition, this library will be more actively developed and maintained
to provide improved capabilites and stability over the original.

Testing shows a nearly 50% reduction in flash use and approx. 100kB less ram consumed vs the original!
Your results may vary

What is NimBLE?

NimBLE is a completely open source Bluetooth Low Energy stack produced by Apache.
It is more suited to resource constrained devices than bluedroid and has now been ported to the ESP32 by Espressif.

Installation

ESP-IDF v4.0+

Download as .zip and extract or clone into the components folder in your esp-idf project.

Run menuconfig, go to Component config->Bluetooth enable Bluetooth and in Bluetooth host NimBLE.
Configure settings in NimBLE Options.
#include "NimBLEDevice.h" in main.cpp.
Call NimBLEDevice::init(""); in app_main.

ESP-IDF v3.2 & v3.3

The NimBLE component does not come with these versions of IDF (now included in 3.3.2 and above).
A backport that works in these versions has been created and is available here.
Download or clone that repo into your project/components folder and run menuconfig. Configure settings in main menu -> NimBLE Options.

#include "NimBLEDevice.h" in main.cpp.
Call NimBLEDevice::init(""); in app_main.

Using

This library is intended to be compatible with the original ESP32 BLE functions and types with minor changes.

If you have not used the original Bluedroid library please refer to the New user guide.

If you are familiar with the original library, see: The migration guide for details about breaking changes and migration.

Also see Improvements_and_updates for information about non-breaking changes.

Full API documentation and class list can be found here.

Using with Arduino as an IDF component and CMake

When using this library along with Arduino and compiling with CMake you must add add_compile_definitions(ARDUINO_ARCH_ESP32=1)
in your project/CMakeLists.txt after the line include($ENV{IDF_PATH}/tools/cmake/project.cmake) to prevent Arduino from releasing BLE memory.

Acknowledgments