Adds BLE Characteristic User Description 0x2901 Descriptor #9883

SuGlider · 2024-06-17T20:44:20Z

Description of Change

This PR adds a new BLE Descriptor Class 0x2901: characteristic user description.

The value of this description is a user-readable string describing the characteristic.
The Characteristic User Description descriptor provides a textual user description for a characteristic value.
If the Writable Auxiliary bit of the Characteristics Properties is set then this descriptor is written.
Only one User Description descriptor exists in a characteristic definition.

Modifies the Notify.ino example to use this new descriptor. It will help on detecting issues with HIL CI.

Tests scenarios

Tested with ESP32 and ESP32-C6. It can be tested using the code below or by using the modified Notify.ino example from this PR.

#include <BLEDevice.h>
#include <BLEServer.h>
#include <BLEUtils.h>
#include <BLE2902.h>
#include <BLE2901.h>

BLEServer *pServer = NULL;
BLECharacteristic *pCharacteristic = NULL;
BLE2901 *descriptor_2901 = NULL;

bool deviceConnected = false;
bool oldDeviceConnected = false;
uint32_t value = 0;

// See the following for generating UUIDs:
// https://www.uuidgenerator.net/

#define SERVICE_UUID        "0000ff00-0000-1000-8000-00805f9b34fb"
#define CHARACTERISTIC_UUID "0000ff01-0000-1000-8000-00805f9b34fb"

class MyServerCallbacks : public BLEServerCallbacks {
  void onConnect(BLEServer *pServer) {
    deviceConnected = true;
  };

  void onDisconnect(BLEServer *pServer) {
    deviceConnected = false;
  }
};

void setup() {
  Serial.begin(115200);

  // 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,
    BLECharacteristic::PROPERTY_READ | BLECharacteristic::PROPERTY_WRITE | BLECharacteristic::PROPERTY_NOTIFY | BLECharacteristic::PROPERTY_INDICATE
  );

  // Create a BLE Descriptor: Client Characteristic Configuration" Descriptor (CCCD) 
  pCharacteristic->addDescriptor(new BLE2902());
  // Add also the Characteristic User Description - 0x2901 descriptor
  descriptor_2901 = new BLE2901();
  descriptor_2901->setDescription("My own description for this characteristic.");
  descriptor_2901->setAccessPermissions(ESP_GATT_PERM_READ); // enforce read only - default is Read|Write 
  pCharacteristic->addDescriptor(descriptor_2901);

  // Start the service
  pService->start();

  // Start advertising
  BLEAdvertising *pAdvertising = BLEDevice::getAdvertising();
  pAdvertising->addServiceUUID(SERVICE_UUID);
  pAdvertising->setScanResponse(false);
  pAdvertising->setMinPreferred(0x0);  // set value to 0x00 to not advertise this parameter
  BLEDevice::startAdvertising();
  Serial.println("Waiting a client connection to notify...");
}

void loop() {
  // notify changed value
  if (deviceConnected) {
    pCharacteristic->setValue((uint8_t *)&value, 4);
    pCharacteristic->notify();
    value++;
    delay(300);
  }
  // disconnecting
  if (!deviceConnected && oldDeviceConnected) {
    delay(500);                   // give the bluetooth stack the chance to get things ready
    pServer->startAdvertising();  // restart advertising
    Serial.println("start advertising");
    oldDeviceConnected = deviceConnected;
  }
  // connecting
  if (deviceConnected && !oldDeviceConnected) {
    // do stuff here on connecting
    oldDeviceConnected = deviceConnected;
  }
}

Related links

Used to simulate the issue described in #9768

Adds a class for 0x2901 - Characteristic User Descriptor. This Descriptor is usual in BLE and describes with text what each characteristic is about.

Adds Descriptor 0x2901 This is the Characteristic User Description, commomnly used in BLE. Adds the implementation for make it easier to be used.

Improve Notify.ino example by adding the 0x2901 descriptor This also prevents and helps to find issues when testing CI.

github-actions · 2024-06-17T20:44:58Z

	Warnings
⚠️	Some issues found for the commit messages in this PR: the commit message `"feat(BLE): Update Notify.ino"`: summary looks too short scope/component should be lowercase without whitespace, allowed special characters are `_` `/` `.` `,` `` `-` `.` the commit message `"feat(ble): Adds Characteristic User Description"`: body's lines must not be longer than 100 characters the commit message `"fix(BLE): adds library code to the CMakeLists.txt"`: scope/component* should be lowercase without whitespace, allowed special characters are `_` `/` `.` `,` `` `-` `.` the commit message `"fix(BLE): fixes the UUIDs used in the example"`: scope/component* should be lowercase without whitespace, allowed special characters are `_` `/` `.` `,` `` `-` `.` Please fix these commit messages* - here are some basic tips: follow Conventional Commits style correct format of commit message should be: `<type/action>(<scope/component>): <summary>`, for example `fix(esp32): Fixed startup timeout issue` allowed types are: `change,ci,docs,feat,fix,refactor,remove,revert,test` sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter avoid Jira references in commit messages (unavailable/irrelevant for our customers) `TIP:` Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).
⚠️	Please consider squashing your 8 commits (simplifying branch history).
⚠️	The source branch `"SuGlider-BLE-add_0x2901_descriptor"` incorrect format: contains uppercase letters. This can cause troubles on case-insensitive file systems (macOS). Please rename your branch.

👋 Hello SuGlider, we appreciate your contribution to this project!

Click to see more instructions ...

This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...

We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against f095335

Fixes the UUIDs to used the ame as in BLE Client example. Makes sure that all examples use the same UUIDs.

Adds the necessary new Library code to CMake. Solves CI issue.

github-actions · 2024-06-17T21:01:14Z

Test Results

56 files 56 suites 5m 15s ⏱️
21 tests 21 ✅ 0 💤 0 ❌
135 runs 135 ✅ 0 💤 0 ❌

Results for commit f095335.

♻️ This comment has been updated with latest results.

github-actions · 2024-06-17T21:16:49Z

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

Memory	FLASH [bytes]		FLASH [%]		RAM [bytes]		RAM [%]
Target	DEC	INC	DEC	INC	DEC	INC	DEC	INC
ESP32S3	0	⚠️ +680	0.00	⚠️ +0.07	0	0	0.00	0.00
ESP32C3	0	⚠️ +538	0.00	⚠️ +0.05	0	0	0.00	0.00
ESP32C6	0	⚠️ +540	0.00	⚠️ +0.05	0	0	0.00	0.00
ESP32H2	0	⚠️ +538	0.00	⚠️ +0.05	0	0	0.00	0.00
ESP32	0	⚠️ +684	0.00	⚠️ +0.06	0	0	0.00	0.00

Click to expand the detailed deltas report [usage change in BYTES]

Target	ESP32S3		ESP32C3		ESP32C6		ESP32H2		ESP32
Example	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM
BLE/examples/BLE5_extended_scan	⚠️ +84	0	0	0	0	0	0	0	-	-
BLE/examples/BLE5_multi_advertising	⚠️ +84	0	0	0	0	0	0	0	-	-
BLE/examples/BLE5_periodic_advertising	⚠️ +84	0	0	0	0	0	0	0	-	-
BLE/examples/BLE5_periodic_sync	⚠️ +84	0	0	0	0	0	0	0	-	-
BLE/examples/Beacon_Scanner	⚠️ +84	0	0	0	0	0	0	0	⚠️ +84	0
BLE/examples/Client	⚠️ +84	0	0	0	0	0	0	0	⚠️ +84	0
BLE/examples/EddystoneTLM_Beacon	⚠️ +84	0	0	0	0	0	-	-	⚠️ +84	0
BLE/examples/EddystoneURL_Beacon	⚠️ +84	0	0	0	0	0	-	-	⚠️ +84	0
BLE/examples/Notify	⚠️ +680	0	⚠️ +538	0	⚠️ +540	0	⚠️ +538	0	⚠️ +684	0
BLE/examples/Scan	⚠️ +84	0	0	0	0	0	0	0	⚠️ +84	0
BLE/examples/Server	⚠️ +84	0	0	0	0	0	0	0	⚠️ +84	0
BLE/examples/Server_multiconnect	⚠️ +84	0	0	0	0	0	0	0	⚠️ +84	0
BLE/examples/UART	⚠️ +84	0	0	0	0	0	0	0	⚠️ +84	0
BLE/examples/Write	⚠️ +84	0	0	0	0	0	0	0	⚠️ +84	0
BLE/examples/iBeacon	⚠️ +84	0	0	0	0	0	0	0	⚠️ +84	0

SuGlider added 3 commits June 17, 2024 17:06

feat(ble): Adds Characteristic User Descriptor

2ce5075

Adds a class for 0x2901 - Characteristic User Descriptor. This Descriptor is usual in BLE and describes with text what each characteristic is about.

feat(ble): Adds Characteristic User Description

d66ca4c

Adds Descriptor 0x2901 This is the Characteristic User Description, commomnly used in BLE. Adds the implementation for make it easier to be used.

feat(BLE): Update Notify.ino

cdca672

Improve Notify.ino example by adding the 0x2901 descriptor This also prevents and helps to find issues when testing CI.

SuGlider added the Area: BLE Issues related to BLE label Jun 17, 2024

SuGlider added this to the 3.0.2 milestone Jun 17, 2024

SuGlider self-assigned this Jun 17, 2024

fix(BLE): fixes the UUIDs used in the example

80b2a6f

Fixes the UUIDs to used the ame as in BLE Client example. Makes sure that all examples use the same UUIDs.

SuGlider requested review from lucasssvaz and removed request for lucasssvaz June 17, 2024 20:49

SuGlider marked this pull request as draft June 17, 2024 20:50

SuGlider marked this pull request as ready for review June 17, 2024 20:51

SuGlider marked this pull request as draft June 17, 2024 20:51

fix(BLE): adds library code to the CMakeLists.txt

651b941

Adds the necessary new Library code to CMake. Solves CI issue.

SuGlider marked this pull request as ready for review June 17, 2024 21:36

SuGlider requested review from lucasssvaz, me-no-dev and P-R-O-C-H-Y June 17, 2024 21:36

Merge branch 'master' into SuGlider-BLE-add_0x2901_descriptor

673ba34

me-no-dev approved these changes Jun 18, 2024

View reviewed changes

P-R-O-C-H-Y approved these changes Jun 18, 2024

View reviewed changes

lucasssvaz approved these changes Jun 18, 2024

View reviewed changes

lucasssvaz added the Status: Pending Merge Pull Request is ready to be merged label Jun 18, 2024

pre-commit-ci-lite bot and others added 2 commits June 18, 2024 15:02

ci(pre-commit): Apply automatic fixes

1a5b276

Merge branch 'master' into SuGlider-BLE-add_0x2901_descriptor

f095335

SuGlider merged commit 99750cd into master Jun 18, 2024
56 checks passed

SuGlider deleted the SuGlider-BLE-add_0x2901_descriptor branch June 18, 2024 17:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds BLE Characteristic User Description 0x2901 Descriptor #9883

Adds BLE Characteristic User Description 0x2901 Descriptor #9883

SuGlider commented Jun 17, 2024 •

edited

Loading

github-actions bot commented Jun 17, 2024 •

edited

Loading

github-actions bot commented Jun 17, 2024 •

edited

Loading

github-actions bot commented Jun 17, 2024 •

edited

Loading

Adds BLE Characteristic User Description 0x2901 Descriptor #9883

Adds BLE Characteristic User Description 0x2901 Descriptor #9883

Conversation

SuGlider commented Jun 17, 2024 • edited Loading

Description of Change

Tests scenarios

Related links

github-actions bot commented Jun 17, 2024 • edited Loading

github-actions bot commented Jun 17, 2024 • edited Loading

Test Results

github-actions bot commented Jun 17, 2024 • edited Loading

Memory usage test (comparing PR against master branch)

SuGlider commented Jun 17, 2024 •

edited

Loading

github-actions bot commented Jun 17, 2024 •

edited

Loading

github-actions bot commented Jun 17, 2024 •

edited

Loading

github-actions bot commented Jun 17, 2024 •

edited

Loading