hci: add advertiser support for ManufacturerData and ServiceData #307

deadprogram · 2024-11-27T13:50:28Z

This PR adds advertiser support for ManufacturerData and ServiceData to the HCI implementation.

Addresses #306

deadprogram · 2024-11-30T15:46:11Z

gap_linux.go

@@ -125,6 +125,26 @@ func (a *Advertisement) Stop() error {
 	return nil
 }

+// SetServiceData sets the service data for the advertisement.
+func (a *Advertisement) SetServiceData(sd []ServiceDataElement) error {


@aykevl do you happen to know how I can do this? 😸

What is your goal?

If you want to change advertisement data then I think you can stop and restart the advertisement with the new service data. Looking at the API I don't see a straightforward way to update any part of the advertisement. But this is straightforward to do from userspace: simply stop and restart the advertisement with the new parameters.

See:
https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc/org.bluez.LEAdvertisement.rst
https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc/org.bluez.LEAdvertisingManager.rst

If you want to change advertisement data then I think you can stop and restart the advertisement

OK I will probably do that in a separate PR.

@aykevl I took your advice and got rid of SetServiceData() entirely. PTAL.

gap_nrf51.go

aykevl · 2024-12-02T09:18:37Z

gap_linux.go

@@ -125,6 +125,26 @@ func (a *Advertisement) Stop() error {
 	return nil
 }

+// SetServiceData sets the service data for the advertisement.
+func (a *Advertisement) SetServiceData(sd []ServiceDataElement) error {


What is your goal?

If you want to change advertisement data then I think you can stop and restart the advertisement with the new service data. Looking at the API I don't see a straightforward way to update any part of the advertisement. But this is straightforward to do from userspace: simply stop and restart the advertisement with the new parameters.

See:
https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc/org.bluez.LEAdvertisement.rst
https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc/org.bluez.LEAdvertisingManager.rst

aykevl · 2024-12-02T09:24:20Z

gap_nrf528xx-advertisement.go

+	// TODO: implement
+	return nil


Looks like this can be implemented here, but it needs a different API.
https://docs.nordicsemi.com/bundle/s132_v6.0.0_api/page/group_b_l_e_g_a_p_f_u_n_c_t_i_o_n_s.html#ga9969047f4e7485c3f856c841978cc31a
Instead of a SetServiceData, you'd need to construct an entirely new advertisement payload (bluetooth.AdvertisementOptions) and set it as a whole.

How about preserve the initial options and then set a new payload when SetServiceData is changed?

Please see the new example beacon for how I am trying to use this function.

See my other comment above.

colececil · 2024-12-27T02:39:17Z

gap_hci.go

@@ -420,3 +441,51 @@ func (a *Advertisement) Start() error {
 func (a *Advertisement) Stop() error {
 	return a.adapter.hci.leSetAdvertiseEnable(false)
 }
+
+// SetServiceData sets the service data for the advertisement.


Here are some points I think it might be helpful to cover in the method documentation here, to make it more clear how SetServiceData needs to be used and what its effects are:

It causes a new advertisement to be broadcast, with the updated service data that has been passed in.

Just updating the data in the []ServiceDataElement that has already been passed in to Configure via AdvertisementOptions.ServiceData will not change the data being broadcast in the advertisement. SetServiceData must be called for the new data to go into effect.

What happens if Configure or Start have not yet been called on the Advertisement?

What effect does this have if the Advertisement has been configured with the Interval option?

deadprogram · 2025-01-02T12:48:30Z

After some consideration, I think that it is better to just call adv.Stop(), then adv.Configure() and then adv.Start() again instead of adding a new API function.

This makes it more straightforward to understand what is happening, and to consequently then make the various platform implementations work as expected.

@colececil I think this implementation answers the questions you raised:

It causes a new advertisement to be broadcast, with the updated service data that has been passed in.

That is accommodated by the pattern in this updated PR.

Just updating the data in the []ServiceDataElement that has already been passed in to Configure via AdvertisementOptions.ServiceData will not change the data being broadcast in the advertisement. SetServiceData must be called for the new data to go into effect.

That is no longer a problem since there is only 1 way to set this data.

What happens if Configure or Start have not yet been called on the Advertisement?

This is also not a problem now.

What effect does this have if the Advertisement has been configured with the Interval option?

This is just a normal advertising option, nothing specific to the ServiceData.

I have updated this PR accordingly, including the new example. It works correctly with the HCI, I will still need to make some changes for other targets.

deadprogram · 2025-01-02T13:00:49Z

I just added another commit to this PR that allows the example/beacon to run correctly on Linux.

deadprogram · 2025-01-02T13:36:25Z

OK this PR is rebased and squashed. Works correctly on HCI and Linux. nrf is currently broken (See #310) and Windows does not support ServiceData. macOS does not yet have the Advertisement implemented. As such, I think this PR is now ready for final review.

deadprogram · 2025-01-03T16:56:01Z

@colececil @aykevl or anyone else, any thoughts here? I think this is ready to merge.

colececil · 2025-01-04T03:03:57Z

@deadprogram I haven't had the chance to check it out in detail, but the new approach you described does indeed sound more straightforward and less confusing.

A couple questions:

To send updated data at a set interval, I'm assuming I would leave the Interval option unset as before, and just call call Stop, Configure, and Start at whatever interval I want?
If the above assumption is correct, is there any advantage to calling Stop right after the advertisement is sent, rather than right before sending the next one? Like, would that save power or anything? And if so, is there a way for the program to know when the advertisement has been sent, so it knows when Stop can safely be called?

Thanks!

deadprogram · 2025-01-04T07:26:36Z

To send updated data at a set interval, I'm assuming I would leave the Interval option unset as before, and just call call Stop, Configure, and Start at whatever interval I want?

Not setting Interval is probably just leaving it at the default. So as long as it is something less than the frequency that you are calling "Stop, Configure, and Start" it would do what you would expect.

If the above assumption is correct, is there any advantage to calling Stop right after the advertisement is sent, rather than right before sending the next one?

That would almost certainly result in some receivers not getting the advertisement data, since you do not know how often they are scanning for updates..

Signed-off-by: deadprogram <[email protected]>

…advertising correctly. Needed to update ServiceData after Advertisment is already started. Signed-off-by: deadprogram <[email protected]>

deadprogram · 2025-01-04T15:32:29Z

Rebased against the latest dev and ready.

deadprogram · 2025-01-04T17:33:45Z

OK I realized from some testing I needed to add another commit. The problem was that multiple calls to adv.Configure() when using the HCI adaptor were creating additional generic Services each time it was called. The additional commit handles that case.

Signed-off-by: deadprogram <[email protected]>

gap_linux.go

bgould · 2025-01-05T07:33:31Z

Overall this is working great for me on arduino-nano33 to implement the "BTHome" protocol using this program - https://github.com/bgould/tinygo-float-sensor/blob/main/main.go ... Home Assistant is able to automatically discover the device and receive sensor values from the advertising data every 100ms. Going to let it run for a while and log data for a bit, but so far it is working well. Will also try this on pico-w and let you know the results.

Was also able to confirm using AdvertisementType option appears to working as expected using nRF Connect. At some point it might be nice to add this option for SoftDevice as well.

Thank you @deadprogram, this is really good :)

…figure() followed by adv.Start() followed by adv.Stop() multiple times. This is required in order to update advertising ServiceData. Signed-off-by: deadprogram <[email protected]>

Signed-off-by: deadprogram <[email protected]>

…otherwise different adverting types do not work correctly Signed-off-by: deadprogram <[email protected]>

deadprogram · 2025-01-05T09:13:53Z

Will also try this on pico-w and let you know the results.

@bgould advertising is not working correctly on Pico-W at present. See #301

deadprogram · 2025-01-05T09:15:08Z

At some point it might be nice to add this option for SoftDevice as well.

@bgould softdevice advertising is also currently non-functional. See #310

deadprogram · 2025-01-05T09:18:21Z

I've addressed all of the feedback, and squashed commits as much as makes sense. Now going to merge this so further work can proceed.

Thanks very much to @colececil @aykevl @bgould for feedback and testing!

deadprogram · 2025-01-05T10:47:06Z

FYI for @colececil @bgould or anyone else interested in BTHome, I just started this little helper package https://github.com/hybridgroup/go-bthome

colececil · 2025-01-05T14:04:23Z

That's awesome @deadprogram! Thanks!

bgould · 2025-01-05T17:14:27Z

At some point it might be nice to add this option for SoftDevice as well.

@bgould softdevice advertising is also currently non-functional. See #310

FWIW ... advertisements using SoftDevice are working with this program on feather-nrf52840 - https://github.com/bgould/tinygo-float-sensor/blob/main/main.go ... that said I am able to reproduce the crash described in #310 on the same board, but it does not appear to be directly related to advertisement data.

deadprogram · 2025-01-05T17:29:16Z

@bgould that is interesting to know, might help to track down the problem there...

colececil · 2025-01-12T01:31:33Z

@deadprogram Good news! I updated my project (https://github.com/colececil/automatic-soil-monitor) to use the revised API here, along with the BTHome helper package you created, and it's still working as expected! And it's working well with Home Assistant:

deadprogram · 2025-01-12T07:59:47Z

That is good to hear, thank you for testing @colececil !

deadprogram commented Nov 30, 2024

View reviewed changes

aykevl reviewed Dec 2, 2024

View reviewed changes

deadprogram force-pushed the hci-service-data branch from 2cc12eb to 7dbb60e Compare December 2, 2024 13:43

deadprogram force-pushed the hci-service-data branch from 7dbb60e to 95bf26a Compare December 11, 2024 17:51

colececil reviewed Dec 27, 2024

View reviewed changes

deadprogram force-pushed the hci-service-data branch from 8ee03a0 to cf6f9c8 Compare January 2, 2025 13:32

deadprogram force-pushed the hci-service-data branch 2 times, most recently from 579edec to 6871cd0 Compare January 3, 2025 16:44

deadprogram added 2 commits January 4, 2025 16:31

hci: add advertiser support for ManufacturerData and ServiceData

0d77d9e

Signed-off-by: deadprogram <[email protected]>

gap/linux: correct HCI implementation so it can Configure/Start/Stop …

92fa7b4

…advertising correctly. Needed to update ServiceData after Advertisment is already started. Signed-off-by: deadprogram <[email protected]>

deadprogram force-pushed the hci-service-data branch from 6871cd0 to 0734b61 Compare January 4, 2025 15:31

examples: add example to broadcast advertising servicedata

9eb01a1

Signed-off-by: deadprogram <[email protected]>

deadprogram force-pushed the hci-service-data branch from 23cd9dc to 85dac3b Compare January 4, 2025 20:11

bgould reviewed Jan 5, 2025

View reviewed changes

gap_linux.go Outdated Show resolved Hide resolved

deadprogram added 3 commits January 5, 2025 10:11

gap/linux: update implementation for GAP to allow for calling adv.Con…

391df80

…figure() followed by adv.Start() followed by adv.Stop() multiple times. This is required in order to update advertising ServiceData. Signed-off-by: deadprogram <[email protected]>

gap: make generic services function for HCI separate function

07d2cfa

Signed-off-by: deadprogram <[email protected]>

fix: ensure that HCI advertising interval is set to a default value, …

1e01e58

…otherwise different adverting types do not work correctly Signed-off-by: deadprogram <[email protected]>

deadprogram force-pushed the hci-service-data branch from 85dac3b to 1e01e58 Compare January 5, 2025 09:11

deadprogram merged commit afac5f0 into dev Jan 5, 2025
4 checks passed

deadprogram deleted the hci-service-data branch January 5, 2025 09:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

hci: add advertiser support for ManufacturerData and ServiceData #307

hci: add advertiser support for ManufacturerData and ServiceData #307

deadprogram commented Nov 27, 2024 •

edited

Loading

deadprogram Nov 30, 2024

aykevl Dec 2, 2024

deadprogram Dec 2, 2024

deadprogram Jan 2, 2025

aykevl Dec 2, 2024

aykevl Dec 2, 2024

deadprogram Dec 2, 2024

deadprogram Jan 2, 2025

colececil Dec 27, 2024 •

edited

Loading

deadprogram commented Jan 2, 2025

deadprogram commented Jan 2, 2025

deadprogram commented Jan 2, 2025

deadprogram commented Jan 3, 2025

colececil commented Jan 4, 2025

deadprogram commented Jan 4, 2025

deadprogram commented Jan 4, 2025

deadprogram commented Jan 4, 2025

bgould commented Jan 5, 2025

deadprogram commented Jan 5, 2025

deadprogram commented Jan 5, 2025

deadprogram commented Jan 5, 2025

deadprogram commented Jan 5, 2025

colececil commented Jan 5, 2025

bgould commented Jan 5, 2025

deadprogram commented Jan 5, 2025

colececil commented Jan 12, 2025

deadprogram commented Jan 12, 2025

hci: add advertiser support for ManufacturerData and ServiceData #307

hci: add advertiser support for ManufacturerData and ServiceData #307

Conversation

deadprogram commented Nov 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

colececil Dec 27, 2024 • edited Loading

Choose a reason for hiding this comment

deadprogram commented Jan 2, 2025

deadprogram commented Jan 2, 2025

deadprogram commented Jan 2, 2025

deadprogram commented Jan 3, 2025

colececil commented Jan 4, 2025

deadprogram commented Jan 4, 2025

deadprogram commented Jan 4, 2025

deadprogram commented Jan 4, 2025

bgould commented Jan 5, 2025

deadprogram commented Jan 5, 2025

deadprogram commented Jan 5, 2025

deadprogram commented Jan 5, 2025

deadprogram commented Jan 5, 2025

colececil commented Jan 5, 2025

bgould commented Jan 5, 2025

deadprogram commented Jan 5, 2025

colececil commented Jan 12, 2025

deadprogram commented Jan 12, 2025

deadprogram commented Nov 27, 2024 •

edited

Loading

colececil Dec 27, 2024 •

edited

Loading