esp-nimble-cpp/examples/Advanced/NimBLE_Server/main/main.cpp

243 lines
9.8 KiB
C++
Raw Normal View History

2020-08-22 17:56:19 +02:00
/** NimBLE_Server Demo:
*
* Demonstrates many of the available features of the NimBLE server library.
2023-05-24 23:47:14 +02:00
*
2020-08-22 17:56:19 +02:00
* Created: on March 22 2020
* Author: H2zero
2023-05-24 23:47:14 +02:00
*
2020-08-22 17:56:19 +02:00
*/
#include "NimBLEDevice.h"
#include "NimBLELog.h"
#include <stdio.h>
extern "C" {void app_main(void);}
static NimBLEServer* pServer;
/** None of these are required as they will be handled by the library with defaults. **
2023-05-24 23:47:14 +02:00
** Remove as you see fit for your needs */
2020-08-22 17:56:19 +02:00
class ServerCallbacks: public NimBLEServerCallbacks {
void onConnect(NimBLEServer* pServer, NimBLEConnInfo& connInfo) {
printf("Client address: %s\n", connInfo.getAddress().toString().c_str());
2023-05-24 23:47:14 +02:00
2020-08-22 17:56:19 +02:00
/** We can use the connection handle here to ask for different connection parameters.
* Args: connection handle, min connection interval, max connection interval
* latency, supervision timeout.
* Units; Min/Max Intervals: 1.25 millisecond increments.
* Latency: number of intervals allowed to skip.
2023-05-24 23:47:14 +02:00
* Timeout: 10 millisecond increments, try for 3x interval time for best results.
2020-08-22 17:56:19 +02:00
*/
pServer->updateConnParams(connInfo.getConnHandle(), 24, 48, 0, 18);
2020-08-22 17:56:19 +02:00
};
2023-05-24 23:47:14 +02:00
void onDisconnect(NimBLEServer* pServer, NimBLEConnInfo& connInfo, int reason) {
2020-08-22 17:56:19 +02:00
printf("Client disconnected - start advertising\n");
NimBLEDevice::startAdvertising();
};
void onMTUChange(uint16_t MTU, NimBLEConnInfo& connInfo) {
printf("MTU updated: %u for connection ID: %u\n", MTU, connInfo.getConnHandle());
pServer->updateConnParams(connInfo.getConnHandle(), 24, 48, 0, 60);
};
2023-05-24 23:47:14 +02:00
2020-08-22 17:56:19 +02:00
/********************* Security handled here **********************
****** Note: these are the same return values as defaults ********/
uint32_t onPassKeyRequest(){
printf("Server Passkey Request\n");
2023-05-24 23:47:14 +02:00
/** This should return a random 6 digit number for security
2020-08-22 17:56:19 +02:00
* or make your own static passkey as done here.
*/
2023-05-24 23:47:14 +02:00
return 123456;
2020-08-22 17:56:19 +02:00
};
bool onConfirmPIN(uint32_t pass_key){
2023-05-24 23:47:14 +02:00
printf("The passkey YES/NO number: %" PRIu32"\n", pass_key);
2020-08-22 17:56:19 +02:00
/** Return false if passkeys don't match. */
2023-05-24 23:47:14 +02:00
return true;
2020-08-22 17:56:19 +02:00
};
void onAuthenticationComplete(NimBLEConnInfo& connInfo){
2023-05-24 23:47:14 +02:00
/** Check that encryption was successful, if not we disconnect the client */
if(!connInfo.isEncrypted()) {
NimBLEDevice::getServer()->disconnect(connInfo.getConnHandle());
2020-08-22 17:56:19 +02:00
printf("Encrypt connection failed - disconnecting client\n");
return;
}
printf("Starting BLE work!");
};
};
/** Handler class for characteristic actions */
class CharacteristicCallbacks: public NimBLECharacteristicCallbacks {
void onRead(NimBLECharacteristic* pCharacteristic, NimBLEConnInfo& connInfo) {
2023-05-24 23:47:14 +02:00
printf("%s : onRead(), value: %s\n",
pCharacteristic->getUUID().toString().c_str(),
pCharacteristic->getValue().c_str());
}
2020-08-22 17:56:19 +02:00
void onWrite(NimBLECharacteristic* pCharacteristic, NimBLEConnInfo& connInfo) {
2023-05-24 23:47:14 +02:00
printf("%s : onWrite(), value: %s\n",
pCharacteristic->getUUID().toString().c_str(),
pCharacteristic->getValue().c_str());
}
2023-05-24 23:47:14 +02:00
/** Called before notification or indication is sent,
2020-08-22 17:56:19 +02:00
* the value can be changed here before sending if desired.
*/
void onNotify(NimBLECharacteristic* pCharacteristic) {
printf("Sending notification to clients\n");
}
2020-08-22 17:56:19 +02:00
/**
2020-08-22 17:56:19 +02:00
* The value returned in code is the NimBLE host return code.
*/
void onStatus(NimBLECharacteristic* pCharacteristic, int code) {
printf("Notification/Indication return code: %d, %s\n",
code, NimBLEUtils::returnCodeToString(code));
}
void onSubscribe(NimBLECharacteristic* pCharacteristic, NimBLEConnInfo& connInfo, uint16_t subValue) {
std::string str = "Client ID: ";
str += connInfo.getConnHandle();
str += " Address: ";
str += connInfo.getAddress().toString();
if(subValue == 0) {
str += " Unsubscribed to ";
}else if(subValue == 1) {
str += " Subscribed to notfications for ";
} else if(subValue == 2) {
str += " Subscribed to indications for ";
} else if(subValue == 3) {
str += " Subscribed to notifications and indications for ";
}
str += std::string(pCharacteristic->getUUID());
printf("%s\n", str.c_str());
}
2020-08-22 17:56:19 +02:00
};
2023-05-24 23:47:14 +02:00
/** Handler class for descriptor actions */
2020-08-22 17:56:19 +02:00
class DescriptorCallbacks : public NimBLEDescriptorCallbacks {
void onWrite(NimBLEDescriptor* pDescriptor, NimBLEConnInfo& connInfo) {
std::string dscVal = pDescriptor->getValue();
2020-08-22 17:56:19 +02:00
printf("Descriptor witten value: %s\n", dscVal.c_str());
};
void onRead(NimBLEDescriptor* pDescriptor, NimBLEConnInfo& connInfo) {
2020-08-22 17:56:19 +02:00
printf("%s Descriptor read\n", pDescriptor->getUUID().toString().c_str());
};;
};
2023-05-24 23:47:14 +02:00
/** Define callback instances globally to use for multiple Charateristics \ Descriptors */
2020-08-22 17:56:19 +02:00
static DescriptorCallbacks dscCallbacks;
static CharacteristicCallbacks chrCallbacks;
void notifyTask(void * parameter){
for(;;) {
if(pServer->getConnectedCount()) {
NimBLEService* pSvc = pServer->getServiceByUUID("BAAD");
if(pSvc) {
NimBLECharacteristic* pChr = pSvc->getCharacteristic("F00D");
if(pChr) {
pChr->notify(true);
}
}
}
vTaskDelay(2000/portTICK_PERIOD_MS);
}
2023-05-24 23:47:14 +02:00
2020-08-22 17:56:19 +02:00
vTaskDelete(NULL);
}
void app_main(void) {
printf("Starting NimBLE Server\n");
/** sets device name */
NimBLEDevice::init("NimBLE");
/** Set the IO capabilities of the device, each option will trigger a different pairing method.
* BLE_HS_IO_DISPLAY_ONLY - Passkey pairing
* BLE_HS_IO_DISPLAY_YESNO - Numeric comparison pairing
* BLE_HS_IO_NO_INPUT_OUTPUT - DEFAULT setting - just works pairing
*/
//NimBLEDevice::setSecurityIOCap(BLE_HS_IO_DISPLAY_ONLY); // use passkey
//NimBLEDevice::setSecurityIOCap(BLE_HS_IO_DISPLAY_YESNO); //use numeric comparison
/** 2 different ways to set security - both calls achieve the same result.
* no bonding, no man in the middle protection, secure connections.
2023-05-24 23:47:14 +02:00
*
* These are the default values, only shown here for demonstration.
*/
//NimBLEDevice::setSecurityAuth(false, false, true);
2020-08-22 17:56:19 +02:00
NimBLEDevice::setSecurityAuth(/*BLE_SM_PAIR_AUTHREQ_BOND | BLE_SM_PAIR_AUTHREQ_MITM |*/ BLE_SM_PAIR_AUTHREQ_SC);
pServer = NimBLEDevice::createServer();
pServer->setCallbacks(new ServerCallbacks());
NimBLEService* pDeadService = pServer->createService("DEAD");
NimBLECharacteristic* pBeefCharacteristic = pDeadService->createCharacteristic(
"BEEF",
NIMBLE_PROPERTY::READ |
NIMBLE_PROPERTY::WRITE |
/** Require a secure connection for read and write access */
NIMBLE_PROPERTY::READ_ENC | // only allow reading if paired / encrypted
NIMBLE_PROPERTY::WRITE_ENC // only allow writing if paired / encrypted
);
2023-05-24 23:47:14 +02:00
2020-08-22 17:56:19 +02:00
pBeefCharacteristic->setValue("Burger");
pBeefCharacteristic->setCallbacks(&chrCallbacks);
/** 2902 and 2904 descriptors are a special case, when createDescriptor is called with
* either of those uuid's it will create the associated class with the correct properties
* and sizes. However we must cast the returned reference to the correct type as the method
* only returns a pointer to the base NimBLEDescriptor class.
*/
2023-05-24 23:47:14 +02:00
NimBLE2904* pBeef2904 = (NimBLE2904*)pBeefCharacteristic->createDescriptor("2904");
2020-08-22 17:56:19 +02:00
pBeef2904->setFormat(NimBLE2904::FORMAT_UTF8);
pBeef2904->setCallbacks(&dscCallbacks);
2023-05-24 23:47:14 +02:00
2020-08-22 17:56:19 +02:00
NimBLEService* pBaadService = pServer->createService("BAAD");
NimBLECharacteristic* pFoodCharacteristic = pBaadService->createCharacteristic(
"F00D",
NIMBLE_PROPERTY::READ |
NIMBLE_PROPERTY::WRITE |
NIMBLE_PROPERTY::NOTIFY
);
pFoodCharacteristic->setValue("Fries");
pFoodCharacteristic->setCallbacks(&chrCallbacks);
/** Custom descriptor: Arguments are UUID, Properties, max length in bytes of the value */
NimBLEDescriptor* pC01Ddsc = pFoodCharacteristic->createDescriptor(
"C01D",
2023-05-24 23:47:14 +02:00
NIMBLE_PROPERTY::READ |
2020-08-22 17:56:19 +02:00
NIMBLE_PROPERTY::WRITE|
NIMBLE_PROPERTY::WRITE_ENC, // only allow writing if paired / encrypted
20
);
pC01Ddsc->setValue("Send it back!");
pC01Ddsc->setCallbacks(&dscCallbacks);
2023-05-24 23:47:14 +02:00
/** Start the services when finished creating all Characteristics and Descriptors */
2020-08-22 17:56:19 +02:00
pDeadService->start();
pBaadService->start();
NimBLEAdvertising* pAdvertising = NimBLEDevice::getAdvertising();
/** Add the services to the advertisment data **/
pAdvertising->addServiceUUID(pDeadService->getUUID());
pAdvertising->addServiceUUID(pBaadService->getUUID());
/** If your device is battery powered you may consider setting scan response
* to false as it will extend battery life at the expense of less data sent.
*/
pAdvertising->setScanResponse(true);
pAdvertising->start();
printf("Advertising Started\n");
2023-05-24 23:47:14 +02:00
2020-08-22 17:56:19 +02:00
xTaskCreate(notifyTask, "notifyTask", 5000, NULL, 1, NULL);
}