Merge pull request #98 from lathoub/CustomSettings

Custom settings, thanks @RobertoHE et al

Author: lathoub

ci/build-arduino.sh

@@ -6,15 +6,16 @@ shopt -s globstar
 # Make sure we are inside the github workspace
 cd $GITHUB_WORKSPACE
 # Create directories
-mkdir $HOME/Arduino
-mkdir $HOME/Arduino/libraries
+mkdir $HOME/Arduino -p
+mkdir $HOME/Arduino/libraries -p
 # Install Arduino IDE
 export PATH=$PATH:$GITHUB_WORKSPACE/bin
 curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh
 arduino-cli config init
 arduino-cli config set library.enable_unsafe_install true
 # arduino-cli core update-index --additional-urls https://arduino.esp8266.com/stable/package_esp8266com_index.json
-arduino-cli core update-index --additional-urls https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
+#arduino-cli core update-index --additional-urls https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
+sed -i 's+\[\]+\[https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json\]+g' /home/runner/.arduino15/arduino-cli.yaml
 arduino-cli core update-index
 
 # Install Arduino AVR core
@@ -24,13 +25,13 @@ arduino-cli core install arduino:samd
 arduino-cli core install esp32:esp32
 
 # List the boards
-arduino-cli board list
+arduino-cli board listall
 
 # Link Arduino library
 ln -s $GITHUB_WORKSPACE $HOME/Arduino/libraries/CI_Test_Library
 
 arduino-cli lib install "MIDI library"
-arduino-cli lib install ArduinoBLE
+#arduino-cli lib install ArduinoBLE
 arduino-cli lib install NimBLE-Arduino
 
 # Compile all *.ino files for the Arduino Uno
@@ -48,7 +49,14 @@ arduino-cli lib install NimBLE-Arduino
 #     arduino-cli compile -b arduino:esp8266:??? $f
 # done
 
+dR=$(pwd)
+
 # Compile all *.ino files for the Arduino Uno
 for f in **/*.ino ; do
-     arduino-cli compile -b arduino:esp32:??? $f
+     echo "Project: $f"
+     d=$(dirname $(readlink -f $f))
+     echo $d
+     cd $d
+     arduino-cli compile -b esp32:esp32:esp32 *.ino --clean
+     cd $dR
 done

examples/CustomerBufferSize/CustomerBufferSize.ino

@@ -0,0 +1,118 @@
+#include <BLEMIDI_Transport.h>
+
+static uint32_t customPasskeyRequest()
+{
+    // FILL WITH YOUR CUSTOM AUTH METHOD CODE or PASSKEY
+    // FOR EXAMPLE:
+    uint32_t passkey = 123456;
+
+    // Serial.println("Client Passkey Request");
+
+    /** return the passkey to send to the server */
+    return passkey;
+};
+
+ struct CustomBufferSizeSettings : public BLEMIDI_NAMESPACE::DefaultSettings {
+  //See all options and them explanation in the library.
+  
+  /*
+  ##### BLE DEVICE NAME  #####
+  */
+  //static constexpr char *name = "BleMidiClient";
+  /*
+  ###### TX POWER #####
+  */
+  //static const esp_power_level_t clientTXPwr = ESP_PWR_LVL_P9;
+  /*
+  ###### SECURITY #####
+  */
+  //static const uint8_t clientSecurityCapabilities = BLE_HS_IO_NO_INPUT_OUTPUT;
+  //static const bool clientBond = true;
+  //static const bool clientMITM = false;
+  //static const bool clientPair = true;
+  //static constexpr PasskeyRequestCallback userOnPassKeyRequest = customPasskeyRequest;
+  /*
+  ###### BLE COMMUNICATION PARAMS ######
+  */
+  //static const uint16_t commMinInterval = 6;  // 7.5ms
+  //static const uint16_t commMaxInterval = 35; // 40ms
+  //static const uint16_t commLatency = 0;      //
+  //static const uint16_t commTimeOut = 200;    // 2000ms
+  /*
+  ###### BLE FORCE NEW CONNECTION ######
+  */
+  //static const bool forceNewConnection = false;
+  /*
+  ###### BLE SUBSCRIPTION: NOTIFICATION & RESPONSE ######
+  */
+  //static const bool notification = true;
+  //static const bool response = true;
+  /*
+  ###### AND THE OTHER SETTINGS OF MIDI LIBRARY ######
+  */
+  static const size_t MaxBufferSize = 16;
+  
+};
+
+#include <hardware/BLEMIDI_ESP32_NimBLE.h>
+//#include <hardware/BLEMIDI_ESP32.h>
+//#include <hardware/BLEMIDI_ArduinoBLE.h>
+
+#ifndef LED_BUILTIN
+#define LED_BUILTIN 2
+#endif
+
+BLEMIDI_CREATE_CUSTOM_INSTANCE("Esp32-NimBLE-MIDI", MIDI, CustomBufferSizeSettings);
+
+unsigned long t0 = millis();
+bool isConnected = false;
+
+
+// -----------------------------------------------------------------------------
+// When BLE connected, LED will turn on (indication that connection was successful)
+// When receiving a NoteOn, LED will go out, on NoteOff, light comes back on.
+// This is an easy and conveniant way to show that the connection is alive and working.
+// -----------------------------------------------------------------------------
+void setup()
+{
+  Serial.begin(115200);
+  while (!Serial) {}
+  Serial.println("booting");
+
+  MIDI.begin();
+
+  pinMode(LED_BUILTIN, OUTPUT);
+  digitalWrite(LED_BUILTIN, LOW);
+
+  BLEMIDI.setHandleConnected([]() {
+    isConnected = true;
+    digitalWrite(LED_BUILTIN, HIGH);
+  });
+
+  BLEMIDI.setHandleDisconnected([]() {
+    isConnected = false;
+    digitalWrite(LED_BUILTIN, LOW);
+  });
+
+  MIDI.setHandleNoteOn([](byte channel, byte note, byte velocity) {
+    digitalWrite(LED_BUILTIN, LOW);
+  });
+  MIDI.setHandleNoteOff([](byte channel, byte note, byte velocity) {
+    digitalWrite(LED_BUILTIN, HIGH);
+  });
+}
+
+// -----------------------------------------------------------------------------
+//
+// -----------------------------------------------------------------------------
+void loop()
+{
+  MIDI.read();
+
+  if (isConnected && (millis() - t0) > 1000)
+  {
+    t0 = millis();
+
+    MIDI.sendNoteOn (60, 100, 1); // note 60, velocity 100 on channel 1
+  }
+}

examples/MidiBle/MidiBle.ino

@@ -2,9 +2,12 @@
 
 //#include <hardware/BLEMIDI_ESP32_NimBLE.h>
 #include <hardware/BLEMIDI_ESP32.h>
-//#include <hardware/BLEMIDI_nRF52.h>
 //#include <hardware/BLEMIDI_ArduinoBLE.h>
 
+#ifndef LED_BUILTIN
+#define LED_BUILTIN 2
+#endif
+
 BLEMIDI_CREATE_DEFAULT_INSTANCE()
 
 unsigned long t0 = millis();

examples/MidiBle_Client/MidiBle_Client.ino

@@ -14,10 +14,10 @@
  * the name of the server or the BLE address of the server. If you want to connect 
  * to the first MIDI server BLE found by the device, you just have to set the name field empty ("").
  * 
- * FOR ADVANCED USERS: Other advanced BLE configurations can be changed in hardware/BLEMIDI_Client_ESP32.h
- * #defines in the head of the file (IMPORTANT: Only the first user defines must be modified). These configurations
- * are related to security (password, pairing and securityCallback()), communication params, the device name 
- * and other stuffs. Modify defines at your own risk.
+ * FOR ADVANCED USERS: Other advanced BLE configurations can be changed with a struct that heritate 
+ * from BLEMIDI_NAMESPACE::DefaultSettingsClient. These configurations are related to
+ * security (password, pairing and securityCallback()), communication params, the device name 
+ * and other stuffs. Modify those settings at your own risk.
  * 
  * 
  * 
@@ -29,17 +29,25 @@
 #include <BLEMIDI_Transport.h>
 
 #include <hardware/BLEMIDI_Client_ESP32.h>
-
 //#include <hardware/BLEMIDI_ESP32_NimBLE.h>
 //#include <hardware/BLEMIDI_ESP32.h>
-//#include <hardware/BLEMIDI_nRF52.h>
 //#include <hardware/BLEMIDI_ArduinoBLE.h>
 
-BLEMIDI_CREATE_DEFAULT_INSTANCE(); //Connect to first server found
+#ifndef LED_BUILTIN
+#define LED_BUILTIN 2
+#endif
+
+//See DefaultSettingsClient in hardware/BLEMIDI_Client_ESP32.h for more configurable settings
+// If you do not redefine a parameter, it will use the default value for these parameter
+struct CustomBufferSizeSettings : public BLEMIDI_NAMESPACE::DefaultSettingsClient {
+   static const size_t MaxBufferSize = 16;
+};
+
+BLEMIDI_CREATE_CUSTOM_INSTANCE("Esp32-BLE-MIDI", MIDI, CustomBufferSizeSettings); // Connect to a server named "Esp32-BLE-MIDI" and use CustomBufferSizeSettings as settings of client
 
-//BLEMIDI_CREATE_INSTANCE("",MIDI)                  //Connect to the first server found
-//BLEMIDI_CREATE_INSTANCE("f2:c1:d9:36:e7:6b",MIDI) //Connect to a specific BLE address server
-//BLEMIDI_CREATE_INSTANCE("MyBLEserver",MIDI)       //Connect to a specific name server
+//BLEMIDI_CREATE_INSTANCE("",MIDI)                  //Connect to the first server found, using default settings
+//BLEMIDI_CREATE_INSTANCE("f2:c1:d9:36:e7:6b",MIDI) //Connect to a specific BLE address server, using default settings
+//BLEMIDI_CREATE_INSTANCE("MyBLEserver",MIDI)       //Connect to a specific name server, using default settings
 
 #ifndef LED_BUILTIN
 #define LED_BUILTIN 2 //modify for match with yout board

examples/SysEx_Receive/SysEx_Receive.ino

@@ -2,9 +2,12 @@
 
 //#include <hardware/BLEMIDI_ESP32_NimBLE.h>
 #include <hardware/BLEMIDI_ESP32.h>
-//#include <hardware/BLEMIDI_nRF52.h>
 //#include <hardware/BLEMIDI_ArduinoBLE.h>
 
+#ifndef LED_BUILTIN
+#define LED_BUILTIN 2
+#endif
+
 BLEMIDI_CREATE_INSTANCE("CustomName", MIDI)
 
 bool isConnected = false;

examples/SysEx_Send/SysEx_Send.ino

@@ -2,9 +2,12 @@
 
 #include <hardware/BLEMIDI_ESP32_NimBLE.h>
 //#include <hardware/BLEMIDI_ESP32.h>
-//#include <hardware/BLEMIDI_nRF52.h>
 //#include <hardware/BLEMIDI_ArduinoBLE.h>
 
+#ifndef LED_BUILTIN
+#define LED_BUILTIN 2
+#endif
+
 byte sysex4[]  = { 0xF0, 0x43, 0x20, 0xF7 };
 byte sysex5[]  = { 0xF0, 0x43, 0x20, 0x7E, 0xF7 };
 byte sysex6[]  = { 0xF0, 0x43, 0x20, 0x7E, 0x4C, 0xF7 };

src/BLEMIDI_Settings.h

@@ -6,7 +6,7 @@ BEGIN_BLEMIDI_NAMESPACE
 
 struct DefaultSettings
 {
-    static const size_t MaxBufferSize = 64;
+    static const short MaxBufferSize = 64;
 };
 
 END_BLEMIDI_NAMESPACE

src/BLEMIDI_Transport.h

@@ -26,13 +26,11 @@ static const char *const CHARACTERISTIC_UUID = "7772e5db-3868-4112-a1a9-f2669d10
 template <class T, class _Settings = DefaultSettings>
 class BLEMIDI_Transport
 {
-    typedef _Settings Settings;
-
 private:
-    byte mRxBuffer[Settings::MaxBufferSize];
+    byte mRxBuffer[_Settings::MaxBufferSize];
     unsigned mRxIndex = 0;
 
-    byte mTxBuffer[Settings::MaxBufferSize]; // minimum 5 bytes
+    byte mTxBuffer[_Settings::MaxBufferSize]; // minimum 5 bytes
     unsigned mTxIndex = 0;
 
     char mDeviceName[24];
@@ -187,6 +185,7 @@ class BLEMIDI_Transport
     void (*_connectedCallback)() = nullptr;
     void (*_connectedCallbackDeviceName)(char *) = nullptr;
     void (*_disconnectedCallback)() = nullptr;
+    void (*_connectedCallbackDeviceName)(char *) = nullptr;
 
     BLEMIDI_Transport &setName(const char *deviceName)
     {
@@ -207,6 +206,12 @@ class BLEMIDI_Transport
         return *this;
     }
 
+    BLEMIDI_Transport &setHandleConnected(void (*fptr)(char*))
+    {
+        _connectedCallbackDeviceName= fptr;
+        return *this;
+    }
+    
     BLEMIDI_Transport &setHandleDisconnected(void (*fptr)())
     {
         _disconnectedCallback = fptr;
@@ -265,10 +270,10 @@ class BLEMIDI_Transport
         byte headerByte = buffer[lPtr++];
 
         auto timestampHigh = 0x3f & headerByte;
-
+        timestampHigh = timestampHigh; // <-- This line is for avoid Warning message due it is unused
         byte timestampByte = buffer[lPtr++];
         uint16_t timestamp = 0;
-
+        timestamp = timestamp; // <-- This line is for avoid Warning message due it is unused
         bool sysExContinuation = false;
         bool runningStatusContinuation = false;