irk_enrollment component for esphome - build issues, license etc

[agittins]

Hi David, this is amazing stuff!

I am particularly interested in seeing if your irk_enrollment component can be used to feed IRKs to the Private BLE Device integration that is now in HA core.

I am having trouble getting it to build.

I tried using the component block in my yaml, but it seems that esphome now requires the parent directory to be named components for it to consider importing it.

After cloning your repo locally and creating a symlink, it complained about not finding the text_sensor.h, adding an empty text_sensor: block to my yaml fixed that (the build setup seemed to not realise it needed to copy it in).

Now I am getting:

src/esphome/components/irk_enrollment/irk_enrollment.cpp: In member function 'virtual void esphome::irk_enrollment::IrkEnrollmentComponent::setup()':
src/esphome/components/irk_enrollment/irk_enrollment.cpp:39:84: error: no matching function for call to 'esphome::esp32_ble_server::BLEServer::create_service(int, bool)'
   this->service_ = esp32_ble_server::global_ble_server->create_service(0x1812, true);
                                                                                    ^
In file included from src/esphome/components/irk_enrollment/irk_enrollment.h:14,
                 from src/esphome/components/irk_enrollment/irk_enrollment.cpp:1:
src/esphome/components/esp32_ble_server/ble_server.h:54:8: note: candidate: 'void esphome::esp32_ble_server::BLEServer::create_service(esphome::esp32_ble::ESPBTUUID, bool, uint16_t, uint8_t)'
   void create_service(ESPBTUUID uuid, bool advertise = false, uint16_t num_handles = 15, uint8_t inst_id = 0);
        ^~~~~~~~~~~~~~
src/esphome/components/esp32_ble_server/ble_server.h:54:8: note:   no known conversion for argument 1 from 'int' to 'esphome::esp32_ble::ESPBTUUID'
Compiling .pioenvs/ttgotest/src/esphome/components/light/esp_color_correction.o
In file included from src/esphome/components/sensor/sensor.h:3,
                 from src/esphome/core/application.h:16,
                 from src/esphome/components/irk_enrollment/irk_enrollment.cpp:3:
src/esphome/components/irk_enrollment/irk_enrollment.cpp: In member function 'virtual void esphome::irk_enrollment::IrkEnrollmentComponent::loop()':
src/esphome/components/irk_enrollment/irk_enrollment.cpp:71:17: error: format '%s' expects argument of type 'char*', but argument 5 has type 'std::__cxx11::basic_string<char>' [-Werror=format=]
   ESP_LOGI(TAG, "      irk: %s", irkStr);
                 ^~~~~~~~~~~~~~~
src/esphome/core/log.h:72:36: note: in definition of macro 'ESPHOME_LOG_FORMAT'
 #define ESPHOME_LOG_FORMAT(format) format
                                    ^~~~~~
src/esphome/core/log.h:151:28: note: in expansion of macro 'esph_log_i'
 #define ESP_LOGI(tag, ...) esph_log_i(tag, __VA_ARGS__)
                            ^~~~~~~~~~
src/esphome/components/irk_enrollment/irk_enrollment.cpp:71:3: note: in expansion of macro 'ESP_LOGI'
   ESP_LOGI(TAG, "      irk: %s", irkStr);
   ^~~~~~~~
Compiling .pioenvs/ttgotest/src/esphome/components/light/esp_hsv_color.o
cc1plus: some warnings being treated as errors
*** [.pioenvs/ttgotest/src/esphome/components/irk_enrollment/irk_enrollment.o] Error 1

I suspect that it's just that some things have changed in esphome since you wrote the component.

Is this component something you'd be interested in updating for the current esphome (assuming it's not just something bone-headed I'm doing on my end, which is entirely possible!), or perhaps submitting to esphome for inclusion in core? I couldn't find a license statement so thought I'd check in with you to see what you are up for before getting in too deep myself :-)

There's a feature request in the esphome tracker that I'll link to this issue as well.

[dgrnbrg]

Hello! Yes, I would be happy to have this work with the HA in-built functionality.

I've pushed some changes to get it to build with the latest ESPHome. I'm not going to be able to test it for a while, but you could try and give it a spin, and it hopefully will work. I don't know to what extent the ble server code has changed in esphome, but hopefully it's just surface level, and this will work now.

Alternatively, you can checkout the prior commit, and use ESPHome version 2023.9, which definitely will work.

[luzik]

On Arduino esp32 it is compiling but can't find any devices on my iPhone. On espidf with esp32s3 got this:

In file included from src/esphome/components/sensor/sensor.h:3,
                 from src/esphome/core/application.h:16,
                 from src/esphome/components/irk_enrollment/irk_enrollment.cpp:3:
src/esphome/components/irk_enrollment/irk_enrollment.cpp: In member function 'virtual void esphome::irk_enrollment::IrkEnrollmentComponent::loop()':
src/esphome/components/irk_enrollment/irk_enrollment.cpp:73:17: error: format '%s' expects argument of type 'char*', but argument 5 has type 'std::__cxx11::basic_string<char>' [-Werror=format=]
   ESP_LOGI(TAG, "      irk: %s", irkStr);
                 ^~~~~~~~~~~~~~~
src/esphome/core/log.h:72:36: note: in definition of macro 'ESPHOME_LOG_FORMAT'
 #define ESPHOME_LOG_FORMAT(format) format
                                    ^~~~~~
src/esphome/core/log.h:151:28: note: in expansion of macro 'esph_log_i'
 #define ESP_LOGI(tag, ...) esph_log_i(tag, __VA_ARGS__)
                            ^~~~~~~~~~
src/esphome/components/irk_enrollment/irk_enrollment.cpp:73:3: note: in expansion of macro 'ESP_LOGI'
   ESP_LOGI(TAG, "      irk: %s", irkStr);
   ^~~~~~~~
Compiling .pioenvs/garaz-esp/src/esphome/components/sensor/sensor.o
cc1plus: some warnings being treated as errors
Compiling .pioenvs/garaz-esp/src/esphome/components/socket/bsd_sockets_impl.o
*** [.pioenvs/garaz-esp/src/esphome/components/irk_enrollment/irk_enrollment.o] Error 1
========================= [FAILED] Took 14.28 seconds =========================

[luzik]

after fixing this error (commenting out) there is no any visible bluetooth device nearby.

[myhomeiot]

@luzik If you don't see Bluetooth device nearby try to use LightBlue or similar application to connect.

[luzik]

Thx, yeah it worked. Do you have idea why iPhone do not show it before using LightBlue ? Is there any way to find it without extra app ?

[luzik]

Found something like that:
However, it seems that iOS does list BLE devices when they advertise some of the BT SIG adopted services such as the Heart Rate service. By advertising this service you can get your device visible in the Bluetooth Settings page..

Maybe we can change advertising service to be heart rate ?

[luzik]

I've changed

appdaemon-configs/custom_components/irk_enrollment/irk_enrollment.cpp

Line 39 in 392b19d

auto service_uuid = esphome::esp32_ble::ESPBTUUID::from_uint16(0x1812);

to 0x180D but still not shown. So dead end. I've read that the only way to make it on list is to start "dual mode of BLE and Bluetooth classic"

[luzik]

One more thing .. LightBlue shows no services associated with my ble device. Why is that ?

[dgrnbrg]

The really fun trick of why this works to get the IRK is that I only implemented enough that the BLE handshake happens. Then, there's nothing lol. So we do enough to get the private key, but there isn't anything implemented.

I haven't investigated to understand what/whether there are consequences for this.

[myhomeiot]

@luzik Here the dirty hack to advertise service (actually it's advertise 2 same services).
Now it's will works but sure the component should be reviewed/rewritten in order to be included into ESPHome as base service. Maybe it's will requires some Enroll service and only when this service will be visible, maybe it's should send event which will be catches by Private BLE Integration, etc.

[luzik]

Worked like a charm! With your hack and 0x180D

[luzik]

While my esp is now visible in iPhone and its recover my IRK, is there a way to rename esp devices visible on bluetooth list ? It is defaults to

esphome:
    name:

And this is ok for most of the cases, but If I want to change it, I have to change all the staff (DHCP, HA)