General examples updates (espressif#7727)

* Remove inline code comments for the struct description * Renamed ESPNow examples * Changed example from C++ class to C struct * Updated MultiHomedServers * Updated BT Serial examples * Added short overview of exaples - missing Enterprise * Added draft of Enterprise header note * Fixed note in README * Fixed compilation error * Changed FunctionalInterrupt example * Fixes * Returned FunctionalInterrupts to original state + added modified version as new example

Author: PilnyTomas

libraries/BLE/examples/BLE5_extended_scan/BLE5_extended_scan.ino

@@ -18,26 +18,6 @@
 uint32_t scanTime = 100; //In 10ms (1000ms)
 BLEScan* pBLEScan;
 
-/**
-* @brief extend adv report parameters
-*/
-//typedef struct {
-// esp_ble_gap_adv_type_t event_type; /*!< extend advertising type */
-// uint8_t addr_type; /*!< extend advertising address type */
-// esp_bd_addr_t addr; /*!< extend advertising address */
-// esp_ble_gap_pri_phy_t primary_phy; /*!< extend advertising primary phy */
-// esp_ble_gap_phy_t secondly_phy; /*!< extend advertising secondary phy */
-// uint8_t sid; /*!< extend advertising sid */
-// uint8_t tx_power; /*!< extend advertising tx power */
-// int8_t rssi; /*!< extend advertising rssi */
-// uint16_t per_adv_interval; /*!< periodic advertising interval */
-// uint8_t dir_addr_type; /*!< direct address type */
-// esp_bd_addr_t dir_addr; /*!< direct address */
-// esp_ble_gap_ext_adv_data_status_t data_status; /*!< data type */
-// uint8_t adv_data_len; /*!< extend advertising data length */
-// uint8_t adv_data[251]; /*!< extend advertising data */
-//} esp_ble_gap_ext_adv_reprot_t;
-
 class MyBLEExtAdvertisingCallbacks: public BLEExtAdvertisingCallbacks {
  void onResult(esp_ble_gap_ext_adv_reprot_t report) {
  if(report.event_type & ESP_BLE_GAP_SET_EXT_ADV_PROP_LEGACY){

libraries/BLE/examples/BLE5_periodic_sync/BLE5_periodic_sync.ino

@@ -25,26 +25,6 @@ static esp_ble_gap_periodic_adv_sync_params_t periodic_adv_sync_params = {
  .sync_timeout = 1000, // timeout: 1000 * 10ms
 };
 
-/**
-* @brief extend adv report parameters
-*/
-//typedef struct {
-// esp_ble_gap_adv_type_t event_type; /*!< extend advertising type */
-// uint8_t addr_type; /*!< extend advertising address type */
-// esp_bd_addr_t addr; /*!< extend advertising address */
-// esp_ble_gap_pri_phy_t primary_phy; /*!< extend advertising primary phy */
-// esp_ble_gap_phy_t secondly_phy; /*!< extend advertising secondary phy */
-// uint8_t sid; /*!< extend advertising sid */
-// uint8_t tx_power; /*!< extend advertising tx power */
-// int8_t rssi; /*!< extend advertising rssi */
-// uint16_t per_adv_interval; /*!< periodic advertising interval */
-// uint8_t dir_addr_type; /*!< direct address type */
-// esp_bd_addr_t dir_addr; /*!< direct address */
-// esp_ble_gap_ext_adv_data_status_t data_status; /*!< data type */
-// uint8_t adv_data_len; /*!< extend advertising data length */
-// uint8_t adv_data[251]; /*!< extend advertising data */
-//} esp_ble_gap_ext_adv_reprot_t;
-
 class MyBLEExtAdvertisingCallbacks : public BLEExtAdvertisingCallbacks
 {
  void onResult(esp_ble_gap_ext_adv_reprot_t params)

libraries/BluetoothSerial/examples/SerialToSerialBT/SerialToSerialBT.ino

@@ -6,6 +6,11 @@
 
 #include "BluetoothSerial.h"
 
+//#define USE_PIN // Uncomment this to use PIN during pairing. The pin is specified on the line below
+const char *pin = "1234"; // Change this to more secure PIN.
+
+String device_name = "ESP32-BT-Slave";
+
 #if !defined(CONFIG_BT_ENABLED) || !defined(CONFIG_BLUEDROID_ENABLED)
 #error Bluetooth is not enabled! Please run `make menuconfig` to and enable it
 #endif
@@ -18,8 +23,13 @@ BluetoothSerial SerialBT;
 
 void setup() {
  Serial.begin(115200);
- SerialBT.begin("ESP32test"); //Bluetooth device name
- Serial.println("The device started, now you can pair it with bluetooth!");
+ SerialBT.begin(device_name); //Bluetooth device name
+ Serial.printf("The device with name \"%s\" is started.\nNow you can pair it with Bluetooth!\n", device_name.c_str());
+ //Serial.printf("The device with name \"%s\" and MAC address %s is started.\nNow you can pair it with Bluetooth!\n", device_name.c_str(), SerialBT.getMacString()); // Use this after the MAC method is implemented
+ #ifdef USE_PIN
+ SerialBT.setPin(pin);
+ Serial.println("Using PIN");
+ #endif
 }
 
 void loop() {

libraries/BluetoothSerial/examples/SerialToSerialBTM/SerialToSerialBTM.ino

@@ -1,52 +1,81 @@
-//This example code is in the Public Domain (or CC0 licensed, at your option.)
-//By Victor Tchistiak - 2019
+// This example code is in the Public Domain (or CC0 licensed, at your option.)
+// By Victor Tchistiak - 2019
 //
-//This example demostrates master mode bluetooth connection and pin 
-//it creates a bridge between Serial and Classical Bluetooth (SPP)
-//this is an extention of the SerialToSerialBT example by Evandro Copercini - 2018
+// This example demonstrates master mode Bluetooth connection to a slave BT device using PIN (password)
+// defined either by String "slaveName" by default "OBDII" or by MAC address
 //
+// This example creates a bridge between Serial and Classical Bluetooth (SPP)
+// This is an extension of the SerialToSerialBT example by Evandro Copercini - 2018
+//
+// DO NOT try to connect to phone or laptop - they are master
+// devices, same as the ESP using this code - it will NOT work!
+//
+// You can try to flash a second ESP32 with the example SerialToSerialBT - it should
+// automatically pair with ESP32 running this code
 
 #include "BluetoothSerial.h"
 
+#define USE_NAME // Comment this to use MAC address instead of a slaveName
+const char *pin = "1234"; // Change this to reflect the pin expected by the real slave BT device
+
 #if !defined(CONFIG_BT_SPP_ENABLED)
 #error Serial Bluetooth not available or not enabled. It is only available for the ESP32 chip.
 #endif
 
 BluetoothSerial SerialBT;
 
-String MACadd = "AA:BB:CC:11:22:33";
-uint8_t address[6] = {0xAA, 0xBB, 0xCC, 0x11, 0x22, 0x33};
-//uint8_t address[6] = {0x00, 0x1D, 0xA5, 0x02, 0xC3, 0x22};
-String name = "OBDII";
-const char *pin = "1234"; //<- standard pin would be provided by default
-bool connected;
+#ifdef USE_NAME
+ String slaveName = "ESP32-BT-Slave"; // Change this to reflect the real name of your slave BT device
+#else
+ String MACadd = "AA:BB:CC:11:22:33"; // This only for printing
+ uint8_t address[6] = {0xAA, 0xBB, 0xCC, 0x11, 0x22, 0x33}; // Change this to reflect real MAC address of your slave BT device
+#endif
+
+String myName = "ESP32-BT-Master";
 
 void setup() {
+ bool connected;
  Serial.begin(115200);
- //SerialBT.setPin(pin);
- SerialBT.begin("ESP32test", true); 
- //SerialBT.setPin(pin);
- Serial.println("The device started in master mode, make sure remote BT device is on!");
- 
- // connect(address) is fast (upto 10 secs max), connect(name) is slow (upto 30 secs max) as it needs
- // to resolve name to address first, but it allows to connect to different devices with the same name.
- // Set CoreDebugLevel to Info to view devices bluetooth address and device names
- connected = SerialBT.connect(name);
- //connected = SerialBT.connect(address);
- 
+
+ SerialBT.begin(myName, true);
+ Serial.printf("The device \"%s\" started in master mode, make sure slave BT device is on!\n", myName.c_str());
+
+ #ifndef USE_NAME
+ SerialBT.setPin(pin);
+ Serial.println("Using PIN");
+ #endif
+
+ // connect(address) is fast (up to 10 secs max), connect(slaveName) is slow (up to 30 secs max) as it needs
+ // to resolve slaveName to address first, but it allows to connect to different devices with the same name.
+ // Set CoreDebugLevel to Info to view devices Bluetooth address and device names
+ #ifdef USE_NAME
+ connected = SerialBT.connect(slaveName);
+ Serial.printf("Connecting to slave BT device named \"%s\"\n", slaveName.c_str());
+ #else
+ connected = SerialBT.connect(address);
+ Serial.print("Connecting to slave BT device with MAC "); Serial.println(MACadd);
+ #endif
+
  if(connected) {
- Serial.println("Connected Succesfully!");
+ Serial.println("Connected Successfully!");
  } else {
  while(!SerialBT.connected(10000)) {
- Serial.println("Failed to connect. Make sure remote device is available and in range, then restart app."); 
+ Serial.println("Failed to connect. Make sure remote device is available and in range, then restart app.");
  }
  }
- // disconnect() may take upto 10 secs max
+ // Disconnect() may take up to 10 secs max
  if (SerialBT.disconnect()) {
- Serial.println("Disconnected Succesfully!");
+ Serial.println("Disconnected Successfully!");
  }
- // this would reconnect to the name(will use address, if resolved) or address used with connect(name/address).
+ // This would reconnect to the slaveName(will use address, if resolved) or address used with connect(slaveName/address).
  SerialBT.connect();
+ if(connected) {
+ Serial.println("Reconnected Successfully!");
+ } else {
+ while(!SerialBT.connected(10000)) {
+ Serial.println("Failed to reconnect. Make sure remote device is available and in range, then restart app.");
+ }
+ }
 }
 
 void loop() {

libraries/ESP32/examples/ESPNow/Basic/Master/Master.ino renamed to libraries/ESP32/examples/ESPNow/ESPNow_Basic_Master/ESPNow_Basic_Master.ino

@@ -7,28 +7,28 @@
 class Button
 {
 public:
-Button(uint8_t reqPin) : PIN(reqPin){
-pinMode(PIN, INPUT_PULLUP);
-attachInterrupt(PIN, std::bind(&Button::isr,this), FALLING);
-};
-~Button() {
-detachInterrupt(PIN);
-}
-
-void ARDUINO_ISR_ATTR isr() {
-numberKeyPresses += 1;
-pressed = true;
-}
-
-void checkPressed() {
-if (pressed) {
-Serial.printf("Button on pin %u has been pressed %u times\n", PIN, numberKeyPresses);
-pressed = false;
-}
-}
+ Button(uint8_t reqPin) : PIN(reqPin){
+ pinMode(PIN, INPUT_PULLUP);
+ attachInterrupt(PIN, std::bind(&Button::isr,this), FALLING);
+ };
+ ~Button() {
+ detachInterrupt(PIN);
+ }
+
+ void ARDUINO_ISR_ATTR isr() {
+ numberKeyPresses += 1;
+ pressed = true;
+ }
+
+ void checkPressed() {
+ if (pressed) {
+ Serial.printf("Button on pin %u has been pressed %u times\n", PIN, numberKeyPresses);
+ pressed = false;
+ }
+ }
 
 private:
-const uint8_t PIN;
+ const uint8_t PIN;
  volatile uint32_t numberKeyPresses;
  volatile bool pressed;
 };
@@ -42,6 +42,6 @@ void setup() {
 }
 
 void loop() {
-button1.checkPressed();
-button2.checkPressed();
+ button1.checkPressed();
+ button2.checkPressed();
 }

libraries/ESP32/examples/ESPNow/Basic/Slave/Slave.ino renamed to libraries/ESP32/examples/ESPNow/ESPNow_Basic_Slave/ESPNow_Basic_Slave.ino

@@ -0,0 +1,39 @@
+#include <Arduino.h>
+
+#define BUTTON1 16
+#define BUTTON2 17
+
+struct Button {
+ uint8_t PIN;
+ volatile uint32_t numberKeyPresses;
+ volatile int pressed;
+};
+
+void isr(void* param) {
+ struct Button *button = (struct Button*) param;
+ button->numberKeyPresses += 1;
+ button->pressed = 1;
+}
+
+void checkPressed(struct Button* button) {
+ if(button->pressed) {
+ Serial.printf("Button on pin %u has been pressed %u times\n", button->PIN, button->numberKeyPresses);
+ button->pressed = 0;
+ }
+}
+
+struct Button button1 = {BUTTON1, 0, 0};
+struct Button button2 = {BUTTON2, 0, 0};
+
+void setup() {
+ Serial.begin(115200);
+ pinMode(button1.PIN, INPUT_PULLUP);
+ pinMode(button2.PIN, INPUT_PULLUP);
+ attachInterruptArg(button1.PIN, isr, (void*)&button1, FALLING);
+ attachInterruptArg(button2.PIN, isr, (void*)&button2, FALLING);
+}
+
+void loop() {
+ checkPressed(&button1);
+ checkPressed(&button2);
+}