Standardizing arguments passed to callback functions

[Bernstern]

Implementation for standardizing callback arguments passed to callback functions to make use easier across platforms (resolves #301).

This implements the feature for all platforms and include doc updates and an example.

[hbldh]

I like the idea, but I have not got the time to review this right now; it is a lot of changes...

@Bernstern Could you fix the conflicts and squash it down to one commit and I will look this over next week?

[dlech]

Thanks for taking time to work on this. I've made a bunch of comments, but looking at this from a higher level, we are already parsing advertising data in 2 places (implementations of BLEDevice and BaseBleakScanner abstract classes) and this adds a 3rd. Reusing this existing code would fix many of the bugs I pointed out in this PR.

I think we could create an AdvertisementData class based on the dictionary given in this PR and utility functions in each backend to convert the platform-specific data into the common AdvertisementData type. Then this common type could be passed around instead of the platform-specific data.

[Bernstern]

I agree, having it as a separate class will be really handy, I'll implement those changes (and remove that debug print 😃 ) over the next few days.

[Bernstern]

I implemented the requested changes to use an AdvertisementData class and updated the documentation and the example I wrote. I didn't quite follow @dlech's suggestion to include the other advertisement sections for the dotnet backend so I'm open to suggestions on how to implement that 😃.

[dlech]

This looks good. Just a few more questions and suggestions.

We can look at reusing this to replace the duplicated code later.

[Bernstern]

Let me know if there are any other changes you would like to see.

[dlech]

I was hoping to have to have some time to test this before merging, but I haven't had time yet.

[dlech]

Finally had some time to get back to this. It is looking really good.

Although I did find some problems on Windows and Linux - see inline comments.

FWIW, you can find my working branch at https://github.com/dlech/bleak/commits/pr/Bernstern/334 which contains the suggested fixes and some other unrelated fixes

Finally, it would also be helpful to add a changelog entry for this.

[dlech]

I added a __repr__() method here for debugging:

    def __repr__(self) -> str:
        kwargs = ""
        if self.local_name:
            kwargs += f", local_name={repr(self.local_name)}"
        if self.rssi:
            kwargs += f", rssi={repr(self.rssi)}"
        if self.manufacturer_data:
            kwargs += f", manufacturer_data={repr(self.manufacturer_data)}"
        if self.service_data:
            kwargs += f", service_data={repr(self.service_data)}"
        if self.service_uuids:
            kwargs += f", service_uuids={repr(self.service_uuids)}"
        if self.platform_data:
            kwargs += f", platform_data={repr(self.platform_data)}"
        return f"AdvertisementData({repr(self.address)}{kwargs})"

[dlech]

@hbldh do you have an opinion on where the AdvertisementData class should live? Currently it is at bleak.backends.scanner.AdvertisementData.

[Bernstern]

@dlech Thank you very much for your suggestions and your working branch made it very apply your requested changes and test them locally, much appreciated!

I added all of the changes on the working branch and merged develop back into it since there were merge conflicts but they should be resolved.

[dlech]

Awesome. Let's call this good enough and get it merged.