Feature: BLE GATT Server Extended Advertising Support (#184)

* feat(ble_gatt_server): update API
* Update advertising parameters API to take in interval milliseconds instead of units, and warn if the specific value had to be rounded
* Update advertising parameters API to take in directed address and connectable flag for setting up directed, undirected, and non-connectable advertisements
* Added advertising API to allow reuse of previously configured data / parameters
* Added APIs to server for easily getting the paired and connected devices, and quickly disconnecting from all clients
* Added some logging utilities and debug logs
* Refactored the ble gatt server menu to be a class (for better docs and to allow subclassing) and extended its functionality
* Updated example to use partitions file and run the menu first before going into demo

* feat(ble_gatt_server): wip support for extended advertisements
* Updated APIs to take in actual NimBLEAdvertisement data (ext and legacy) and make the apis consistent between legacy and ext as much as possible

* update and rebuild docs

* doc: update

* update gfps example to throw an error if extended advertisements are enabled

* rebuild docs

Author: finger563

components/ble_gatt_server/example/main/ble_gatt_server_example.cpp

@@ -43,7 +43,11 @@ extern "C" void app_main(void) {
           },
   });
   ble_gatt_server.init(device_name);
+#if !CONFIG_BT_NIMBLE_EXT_ADV
+  // extended advertisement does not support automatically advertising on
+  // disconnect
   ble_gatt_server.set_advertise_on_disconnect(true);
+#endif
 
   // let's configure the security
   bool bonding = true;
@@ -87,16 +91,38 @@ extern "C" void app_main(void) {
   device_info_service.set_firmware_version("1.0.0");
   device_info_service.set_hardware_version("1.0.0");
 
+  // set the advertising data
+  espp::BleGattServer::AdvertisedData adv_data;
+  // uint8_t flags = BLE_HS_ADV_F_DISC_LTD;
+  uint8_t flags = BLE_HS_ADV_F_DISC_GEN;
+  adv_data.setFlags(flags);
+  adv_data.setName(device_name);
+  adv_data.setAppearance((uint16_t)espp::BleAppearance::GENERIC_COMPUTER);
+  adv_data.addTxPower();
+  ble_gatt_server.set_advertisement_data(adv_data);
+
+#if CONFIG_COMPILER_CXX_EXCEPTIONS
+  // let's test and use the BLE menu (CLI)
+  // turn off some of the logs so that it doesn't clutter up the CLI
+  ble_gatt_server.set_log_level(espp::Logger::Verbosity::WARN);
+  // and make the CLI
+  auto ble_menu = espp::BleGattServerMenu(ble_gatt_server);
+  cli::SetColor();
+  cli::Cli cli(ble_menu.get());
+  cli.ExitAction([](auto &out) { out << "Goodbye and thanks for all the fish.\n"; });
+
+  espp::Cli input(cli);
+  input.SetInputHistorySize(10);
+  input.Start(); // this will not return until the user enters the `exit` command.
+#endif
+
+  // The menu has finished, so let's go into a loop to keep the device running
   // now lets start advertising
-  espp::BleGattServer::AdvertisingData adv_data = {
-      .name = device_name,
-  };
-  espp::BleGattServer::AdvertisingParameters adv_params = {};
-  ble_gatt_server.start_advertising(adv_data, adv_params);
+  ble_gatt_server.start_advertising();
 
   // now lets update the battery level every second for a little while
   uint8_t battery_level = 99;
-  for (int i = 0; i < 200; i++) {
+  while (true) {
     auto start = std::chrono::steady_clock::now();
 
     // update the battery level
@@ -106,18 +132,5 @@ extern "C" void app_main(void) {
     // sleep
     std::this_thread::sleep_until(start + 1s);
   }
-
-  // Now let's test and use the BLE menu (CLI)
-  // turn off some of the logs so that it doesn't clutter up the CLI
-  ble_gatt_server.set_log_level(espp::Logger::Verbosity::WARN);
-  // and make the CLI
-  auto ble_menu = espp::make_ble_gatt_server_menu(ble_gatt_server);
-  cli::SetColor();
-  cli::Cli cli(std::move(ble_menu));
-  cli.ExitAction([](auto &out) { out << "Goodbye and thanks for all the fish.\n"; });
-
-  espp::Cli input(cli);
-  input.SetInputHistorySize(10);
-  input.Start(); // this will not return until the user enters the `exit` command.
-                 //! [ble gatt server example]
+  //! [ble gatt server example]
 }

components/ble_gatt_server/example/partitions.csv

@@ -2,4 +2,3 @@
 nvs,      data, nvs,     0x9000,  0x6000
 phy_init, data, phy,     0xf000,  0x1000
 factory,  app,  factory, 0x10000, 2M
-littlefs, data, spiffs,         , 1M

components/ble_gatt_server/example/sdkconfig.defaults

@@ -13,6 +13,10 @@ CONFIG_FREERTOS_HZ=1000
 
 CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y
 
+# Partition Table
+CONFIG_PARTITION_TABLE_CUSTOM=y
+CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions.csv"
+
 #
 # BT config
 #

components/ble_gatt_server/include/ble_appearances.hpp

@@ -0,0 +1,43 @@
+#pragma once
+
+#include <cstdint>
+
+namespace espp {
+/// \brief The appearance of a BLE device
+/// \note This is a subset of the Bluetooth SIG Assigned Numbers
+/// \note See
+///       https://www.bluetooth.com/specifications/assigned-numbers/generic-access-profile/
+///       specifically, pages 29-30 of
+///       https://www.bluetooth.com/wp-content/uploads/Files/Specification/HTML/Assigned_Numbers/out/en/Assigned_Numbers.pdf?v=1710445481092
+enum class BleAppearance : uint16_t {
+  UNKNOWN = 0,
+  GENERIC_PHONE = 64,
+  GENERIC_COMPUTER = 128,
+  GENERIC_WATCH = 192,
+  WATCH_SPORTS_WATCH = 193,
+  GENERIC_CLOCK = 256,
+  GENERIC_DISPLAY = 320,
+  GENERIC_REMOTE_CONTROL = 384,
+  GENERIC_EYE_GLASSES = 448,
+  GENERIC_TAG = 512,
+  GENERIC_KEYRING = 576,
+  GENERIC_MEDIA_PLAYER = 640,
+  GENERIC_BARCODE_SCANNER = 704,
+  GENERIC_THERMOMETER = 768,
+  THERMOMETER_EAR = 769,
+  GENERIC_HEART_RATE_SENSOR = 832,
+  HEART_RATE_SENSOR_HEART_RATE_BELT = 833,
+  GENERIC_BLOOD_PRESSURE = 896,
+  BLOOD_PRESSURE_ARM = 897,
+  BLOOD_PRESSURE_WRIST = 898,
+  HUMAN_INTERFACE_DEVICE = 960,
+  KEYBOARD = 961,
+  MOUSE = 962,
+  JOYSTICK = 963,
+  GAMEPAD = 964,
+  DIGITIZER_TABLET = 965,
+  CARD_READER = 966,
+  DIGITAL_PEN = 967,
+  BARCODE_SCANNER = 968,
+};
+} // namespace espp