BLE-MIDI/src/hardware/BLEMIDI_ESP32_NimBLE.h compile error

[RCPilot1604]

Attempted to compile a previously working piece of code which now produces the following compilation error.
The error is in line 144 and 145 of Arduino-BLE-MIDI/src/hardware/BLEMIDI_ESP32_NimBLE.h.

I suspect that there was a migration of the h2zero/NimBLE-Arduino library, causing the code to break.

In file included from src/main.cpp:4:
.pio/libdeps/esp32doit-devkit-v1/BLE-MIDI/src/hardware/BLEMIDI_ESP32_NimBLE.h: In member function 'bool bleMidi::BLEMIDI_ESP32_NimBLE::begin(const char*, bleMidi::BLEMIDI_Transport<bleMidi::BLEMIDI_ESP32_NimBLE>*)':
.pio/libdeps/esp32doit-devkit-v1/BLE-MIDI/src/hardware/BLEMIDI_ESP32_NimBLE.h:144:26: error: expected type-specifier before 'NimBLESecurity'
  144 |     auto _security = new NimBLESecurity();
      |                          ^~~~~~~~~~~~~~
.pio/libdeps/esp32doit-devkit-v1/BLE-MIDI/src/hardware/BLEMIDI_ESP32_NimBLE.h:145:38: error: 'ESP_LE_AUTH_BOND' was not declared in this scope
  145 |     _security->setAuthenticationMode(ESP_LE_AUTH_BOND);
      |                                      ^~~~~~~~~~~~~~~~
*** [.pio\build\esp32doit-devkit-v1\src\main.cpp.o] Error 1

[spDuchamp]

I can confirm I'm having the exact same problem, and when I roll back to version 2.1.0, the project compiles just fine.

[MicroMidi]

May I ask if there will be a new official release of this brilliant library that leverages the features of the new major NimBLE 2.x.x version? Thanks in advance🙏

[lathoub]

Hi @MicroMidi et al - good question. An official release of this library is difficult, as it relies on calls in the underlying MIDI library that have not been rolled up in a release. It has been in the air for a while, but we (@FortySevenEffects (*) and myself) have to organize a 'release party' to align all the releases of the libraries again (the base libraries and all the derived protocols). Maybe this is a good trigger for a concerted effort.

[MicroMidi]

Hi @lathoub,
thank you for your reply. I wasn't aware of all the dependencies that need to be considered in order to have the furious “release party”. It would be really great to have an updated state of the art BLE-MIDI library, as the hard work you and the other library owners have put into developing these libraries will be carried into the future. Right now, users have to struggle with different library versions to find a solution that works for their project. And I'm pretty sure your user base is quite large.

Thanks again for your hard work and for your great contribution to the Arduino ESP32 community

Bernd

[lathoub]

Problem fixed in master branch.
but... I do not have hardware to test for the moment, so please test for me!

the main security settings are

Arduino-BLE-MIDI/src/hardware/BLEMIDI_ESP32_NimBLE.h

Line 142 in 2e4b39f

NimBLEDevice::setSecurityAuth(true, false, false);

parameters described here:

Please let me know if this fix works

[JasonBugeja]

Hi @lathoub,
I have tried the fixed version. Still gives the exact same error log.

What I ended up doing to fix the problem temporarily is copying all the libraries from a working system and replacing the libraries folder. It gave me an error in the Arduino IDE cache. The directory was the Windows user\AppData\Local\Arduino15\etc and several subfolders. I deleted that folder and it compiled correctly.

Thanks for your hard work and great contributions to the Arduino esp32 community

[lathoub]

@JasonBugeja just checking: all is A-OK? (I just checked with a fresh checkout from github and all compiled correctly)

[MicroMidi]

Hi @lathoub,

i tried to compile the BLE MIDI client demo code from @RobertoHE ("MidiBle_Client.ino") and get the following error while compiling:

_In file included from C:\Users\bernd\AppData\Local\Temp\arduino_modified_sketch_379318\MidiBle_Client.ino:31:
C:\Users\bernd\Documents\Arduino\libraries\Arduino-BLE-MIDI-master\src/hardware/BLEMIDI_Client_ESP32.h:142:1: error: expected class-name before '{' token
142 | {
| ^
C:\Users\bernd\Documents\Arduino\libraries\Arduino-BLE-MIDI-master\src/hardware/BLEMIDI_Client_ESP32.h: In member function 'void bleMidi::AdvertisedDeviceCallbacks::onResult(NimBLEAdvertisedDevice*)':
C:\Users\bernd\Documents\Arduino\libraries\Arduino-BLE-MIDI-master\src/hardware/BLEMIDI_Client_ESP32.h:168:119: error: no match for 'operator==' (operand types are 'const NimBLEAddress' and 'std::string' {aka 'std::__cxx11::basic_string'})
168 | if (!(!specificTarget || (advertisedDevice->getName() == nameTarget.c_str() || advertisedDevice->getAddress() == nameTarget)))
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ^~ ~~~~~~~~~~
| | |
| | std::string {aka std::_cxx11::basic_string}
| const NimBLEAddress
In file included from C:\Users\bernd\Documents\Arduino\libraries\NimBLE-Arduino\src/NimBLEClient.h:30,

I tried that with the Espressif ESP32 v2.x and v3.x board framework and NimBLE library v2.2.1. Do you have any ideas how to solve that?
Thanks in advance for any hint

Bernd

[lathoub]

The NimBLE library has changed its API, and I am unfamiliar with the BLE client usage.
I'm going to rely on RobertoHE to fix the code.

@RobertoHE can you check the code?

Mainly here:

Arduino-BLE-MIDI/src/hardware/BLEMIDI_Client_ESP32.h

Line 168 in 4c2f496

if (!(!specificTarget || (advertisedDevice->getName() == nameTarget.c_str() || advertisedDevice->getAddress() == nameTarget)))

Arduino-BLE-MIDI/src/hardware/BLEMIDI_Client_ESP32.h

Line 458 in 4c2f496

pBLEScan->setAdvertisedDeviceCallbacks(&myAdvCB);

mix up on template parameters:

Arduino-BLE-MIDI/src/hardware/BLEMIDI_Client_ESP32.h

Line 371 in 4c2f496

_bleMidiTransport = bleMidiTransport;

[RobertoHE]

Hello everyone.
Now I haven't any resources to test the solution with software or hardware until March. I can only give you some ideas or tips that you'll need to investigate.

1. return type of getAddress

Arduino-BLE-MIDI/src/hardware/BLEMIDI_Client_ESP32.h

Line 168 in 4c2f496

if (!(!specificTarget || (advertisedDevice->getName() == nameTarget.c_str() || advertisedDevice->getAddress() == nameTarget)))

This line tries to check if the address or name matches the name that you choose, client will try to connect with that server. The error of @MicroMidi says that type mismatch. Would you verify that NimbleBLEAddress->getAddres() type return type matches with string? I think that the method has a casting method to string type (toString()).

2. Possible error when CustomSetting merge.

I just compare my local repo with this master report
My Repo:

https://github.com/RobertoHE/Arduino-BLE-MIDI/blob/38fea5dfe32a93ce09cd271df03bfe8fb2407c9e/src/hardware/BLEMIDI_Client_ESP32.h#L580-L594

Master Repo:

Arduino-BLE-MIDI/src/hardware/BLEMIDI_Client_ESP32.h

Lines 631 to 643 in 2e4b39f

	/*! \brief Create an instance for ESP32 named <DeviceName>, and adviertise it like "Prefix + <DeviceName> + Subfix"
	It will try to connect to a specific server with equal name or addr than <DeviceName>. If <DeviceName> is "", it will connect to first midi server
	*/
	#define BLEMIDI_CREATE_INSTANCE(DeviceName, Name) \
	BLEMIDI_NAMESPACE::BLEMIDI_Transport<BLEMIDI_NAMESPACE::BLEMIDI_Client_ESP32> BLE##Name(DeviceName); \
	MIDI_NAMESPACE::MidiInterface<BLEMIDI_NAMESPACE::BLEMIDI_Transport<BLEMIDI_NAMESPACE::BLEMIDI_Client_ESP32>, BLEMIDI_NAMESPACE::MySettings> Name((BLEMIDI_NAMESPACE::BLEMIDI_Transport<BLEMIDI_NAMESPACE::BLEMIDI_Client_ESP32> &)BLE##Name);
	/*! \brief Create a default instance for ESP32 named BLEMIDI-CLIENT.
	It will try to connect to first midi ble server found.
	*/
	#define BLEMIDI_CREATE_DEFAULT_INSTANCE() \
	BLEMIDI_CREATE_INSTANCE("", MIDI)

At any moment you remove _setting Template class, @lathoub. If setting class is not defined in the constructor at creation time, some error may occur because some variables are not defined.

The main change to work with customizable settings is based on the heritage of setting to midi->blemide->transport layer.

Arduino-BLE-MIDI/src/hardware/BLEMIDI_Client_ESP32.h

Line 30 in 4c2f496

struct DefaultSettingsClient : public BLEMIDI_NAMESPACE::DefaultSettings

In master repo, the settings are not used with the constructors.
This kind of logic must be implemented at similar way and adapt to the specific setting or parameter of each layer. If you copy the logic of my local repo to all transport layers (heritage class for settings), you will save some problems in the future.

Please, check that settings are correctly used in the constructor in all layers, not only in Client transport layer.

Sorry for not being more useful until March.