mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-12-18 17:20:47 +01:00
4980e6a10a
* General code cleanup. * `NimBLEAdvertisementData` moved to it's own .h and .cpp files. * Added new method, `NimBLEAdvertising::setPreferredParams` that takes the min and max preferred connection parameters as an alternative for `setMinPreferred` and `setMaxPreferred`. * Added new method, `NimBLEAdvertising::setAdvertisingInterval` Sets the advertisement interval for min and max to the same value instead of calling `setMinInterval` and `setMaxInterval` separately if there is not value difference. * `NimBLEAdvertisementData` payload is now stored in `std::vector<uint8_t>` instead of `std::string`. * `NimBLEAdvertisementData::getPayload` now returns `std::vector<uint8_t>` instead of `std::string`. * `NimBLEAdvertisementData::addData` now takes either a `std::vector<uint8_t>` or `uint8_t* + length` instead of `std::string` or `char + length`. * `NimBLEAdvertisementData::setName` now takes an optional `bool` parameter to indicate if the name is complete or incomplete, default = complete. * `NimBLEAdvertising::start` No longer takes a callback pointer parameter, instead the new method `NimBLEAdvertising::setAdvertisingCompleteCallback` should be used. * `NimBLEAdvertising::setAdvertisementType` has been renamed to `NimBLEAdvertising::setConnectableMode` to better reflect it's function. * `NimBLEAdvertising::setScanResponse` has been renamed to `NimBLEAdvertising::enableScanResponse` to better reflect it's function. * Scan response is no longer enabled by default. * Added new method, `NimBLEAdvertising::setDiscoverableMode` to allow applications to control the discoverability of the advertiser. * Advertising the name and TX power of the device will no longer happen by default and should be set manually by the application. * Added overload for `NimBLEAdvertising::setManufacturerData` that takes a `const uint8_t*` and , size_t` paramter. * Added overload for `NimBLEAdvertising::setServiceData` that takes `const NimBLEUUID& uuid`, ` const uint8_t* data`, ` size_t length` as parameters. * Added overload for `NimBLEAdvertising::setServiceData` that takes `const NimBLEUUID& uuid`, `const std::vector<uint8_t>&` as parameters. * All `NimBLEAdvertisementData` functions that change data values now return `bool`, true = success. * All `NimBLEAdvertising` functions that change data values now return `bool`, true = success. * `NimBLEAdvertising::setMinPreferred` and `NimBLEAdvertising::setMaxPreferred` have been removed, use `NimBLEAdvertising::setPreferredParams` instead. * All advertising data is now stored in instances of `NimBLEAdvertisingData` and vectors removed from `NimBLEAdvertising`. * `NimBLEAdvertising::setAdvertisementData` and `NimBLEAdvertising::setScanResponseData` now return `bool`, true = success. * Added new method, `NimBLEAdvertisementData::removeData`, which takes a parameter `uint8_t type`, the data type to remove. * Added new method, `NimBLEAdvertisementData::toString`, which will print the data in hex. * Added new method, `NimBLEAdvertising::getAdvertisementData`, which returns a reference to the currently set advertisement data. * Added new method, `NimBLEAdvertising::getScanData`, which returns a reference to the currently set scan response data. * Added overloads for `NimBLEAdvertising::removeServiceUUID` and `NimBLEAdvertisementData::removeServiceUUID` to accept a `const char*` * Added new method, `NimBLEAdvertising::clearData`, which will clear the advertisement and scan response data.
164 lines
5.9 KiB
C++
164 lines
5.9 KiB
C++
/*
|
|
Video: https://www.youtube.com/watch?v=oCMOYS71NIU
|
|
Based on Neil Kolban example for IDF: https://github.com/nkolban/esp32-snippets/blob/master/cpp_utils/tests/BLE%20Tests/SampleNotify.cpp
|
|
Ported to Arduino ESP32 by Evandro Copercini
|
|
updated by chegewara
|
|
Refactored back to IDF by H2zero
|
|
|
|
Create a BLE server that, once we receive a connection, will send periodic notifications.
|
|
The service advertises itself as: 4fafc201-1fb5-459e-8fcc-c5c9c331914b
|
|
And has a characteristic of: beb5483e-36e1-4688-b7f5-ea07361b26a8
|
|
|
|
The design of creating the BLE server is:
|
|
1. Create a BLE Server
|
|
2. Create a BLE Service
|
|
3. Create a BLE Characteristic on the Service
|
|
4. Create a BLE Descriptor on the characteristic
|
|
5. Start the service.
|
|
6. Start advertising.
|
|
|
|
A connect hander associated with the server starts a background task that performs notification
|
|
every couple of seconds.
|
|
*/
|
|
|
|
/** NimBLE differences highlighted in comment blocks **/
|
|
|
|
/*******original********
|
|
#include <BLEDevice.h>
|
|
#include <BLEServer.h>
|
|
#include <BLEUtils.h>
|
|
#include <BLE2902.h>
|
|
***********************/
|
|
#include <NimBLEDevice.h>
|
|
|
|
extern "C" {void app_main(void);}
|
|
|
|
BLEServer* pServer = NULL;
|
|
BLECharacteristic* pCharacteristic = NULL;
|
|
bool deviceConnected = false;
|
|
bool oldDeviceConnected = false;
|
|
uint32_t value = 0;
|
|
|
|
// See the following for generating UUIDs:
|
|
// https://www.uuidgenerator.net/
|
|
|
|
#define SERVICE_UUID "4fafc201-1fb5-459e-8fcc-c5c9c331914b"
|
|
#define CHARACTERISTIC_UUID "beb5483e-36e1-4688-b7f5-ea07361b26a8"
|
|
|
|
/** None of these are required as they will be handled by the library with defaults. **
|
|
** Remove as you see fit for your needs */
|
|
class MyServerCallbacks: public BLEServerCallbacks {
|
|
void onConnect(BLEServer* pServer, BLEConnInfo& connInfo) {
|
|
deviceConnected = true;
|
|
};
|
|
|
|
void onDisconnect(BLEServer* pServer, BLEConnInfo& connInfo, int reason) {
|
|
deviceConnected = false;
|
|
}
|
|
/***************** New - Security handled here ********************
|
|
****** Note: these are the same return values as defaults ********/
|
|
uint32_t onPassKeyDisplay(){
|
|
printf("Server Passkey Display\n");
|
|
/** This should return a random 6 digit number for security
|
|
* or make your own static passkey as done here.
|
|
*/
|
|
return 123456;
|
|
};
|
|
|
|
void onConfirmPasskey(NimBLEConnInfo& connInfo, uint32_t pass_key){
|
|
printf("The passkey YES/NO number: %" PRIu32 "\n", pass_key);
|
|
/** Inject false if passkeys don't match. */
|
|
NimBLEDevice::injectConfirmPasskey(connInfo, true);
|
|
};
|
|
|
|
void onAuthenticationComplete(NimBLEConnInfo& connInfo){
|
|
/** Check that encryption was successful, if not we disconnect the client */
|
|
if(!connInfo.isEncrypted()) {
|
|
NimBLEDevice::getServer()->disconnect(connInfo.getConnHandle());
|
|
printf("Encrypt connection failed - disconnecting client\n");
|
|
return;
|
|
}
|
|
printf("Starting BLE work!");
|
|
};
|
|
/*******************************************************************/
|
|
};
|
|
|
|
void connectedTask (void * parameter){
|
|
for(;;) {
|
|
// notify changed value
|
|
if (deviceConnected) {
|
|
pCharacteristic->setValue((uint8_t*)&value, 4);
|
|
pCharacteristic->notify();
|
|
value++;
|
|
vTaskDelay(100/portTICK_PERIOD_MS); // bluetooth stack will go into congestion, if too many packets are sent
|
|
}
|
|
// disconnecting
|
|
if (!deviceConnected && oldDeviceConnected) {
|
|
vTaskDelay(500/portTICK_PERIOD_MS); // give the bluetooth stack the chance to get things ready
|
|
pServer->startAdvertising(); // restart advertising
|
|
printf("start advertising\n");
|
|
oldDeviceConnected = deviceConnected;
|
|
}
|
|
// connecting
|
|
if (deviceConnected && !oldDeviceConnected) {
|
|
// do stuff here on connecting
|
|
oldDeviceConnected = deviceConnected;
|
|
}
|
|
|
|
vTaskDelay(10/portTICK_PERIOD_MS); // Delay between loops to reset watchdog timer
|
|
}
|
|
|
|
vTaskDelete(NULL);
|
|
}
|
|
|
|
void app_main(void) {
|
|
// Create the BLE Device
|
|
BLEDevice::init("ESP32");
|
|
|
|
// Create the BLE Server
|
|
pServer = BLEDevice::createServer();
|
|
pServer->setCallbacks(new MyServerCallbacks());
|
|
|
|
// Create the BLE Service
|
|
BLEService *pService = pServer->createService(SERVICE_UUID);
|
|
|
|
// Create a BLE Characteristic
|
|
pCharacteristic = pService->createCharacteristic(
|
|
CHARACTERISTIC_UUID,
|
|
/******* Enum Type NIMBLE_PROPERTY now *******
|
|
BLECharacteristic::PROPERTY_READ |
|
|
BLECharacteristic::PROPERTY_WRITE |
|
|
BLECharacteristic::PROPERTY_NOTIFY |
|
|
BLECharacteristic::PROPERTY_INDICATE
|
|
);
|
|
**********************************************/
|
|
NIMBLE_PROPERTY::READ |
|
|
NIMBLE_PROPERTY::WRITE |
|
|
NIMBLE_PROPERTY::NOTIFY |
|
|
NIMBLE_PROPERTY::INDICATE
|
|
);
|
|
|
|
// Create a BLE Descriptor
|
|
/***************************************************
|
|
NOTE: DO NOT create a 2902 descriptor.
|
|
it will be created automatically if notifications
|
|
or indications are enabled on a characteristic.
|
|
|
|
pCharacteristic->addDescriptor(new BLE2902());
|
|
****************************************************/
|
|
// Start the service
|
|
pService->start();
|
|
|
|
// Start advertising
|
|
BLEAdvertising *pAdvertising = BLEDevice::getAdvertising();
|
|
pAdvertising->addServiceUUID(SERVICE_UUID);
|
|
pAdvertising->enableScanResponse(false);
|
|
/** This method had been removed **
|
|
pAdvertising->setMinPreferred(0x0); // set value to 0x00 to not advertise this parameter
|
|
**/
|
|
|
|
xTaskCreate(connectedTask, "connectedTask", 5000, NULL, 1, NULL);
|
|
|
|
BLEDevice::startAdvertising();
|
|
printf("Waiting a client connection to notify...\n");
|
|
}
|