GATT server support for Rust #454

marshallpierce · 2024-03-25T23:09:37Z

With a whole lot of support to get there:

Device::add_service(), with some complexity around how to represent the mutable Python Service being used under the covers
AttributePermission, CharacteristicProperty, and other supporting GATT-related stuff
Ability to handle the different data types used by various Python Characteristic subclasses
Support for running tests in the context of a background rootcanal process
TryToPy and TryFromPy traits to help make the lifecycle more clear for structs that have a Python equivalent, but are also meaningful standalone
Add example with a minimal battery service
Rearrange known service IDs to make it possible to refer to a service UUID in a meaningful way
Make Address hold its own state to avoid propagating PyResult so much, and adopt the new TryToPy and TryFromPy traits
AdvertisingDataValue trait so users don't have to remember as many ADU encoding details at a call site

marshallpierce

Not sure how much motivation I have to fix the build with Python 3.8 and 3.9 given that 3.10 is almost 3 years old...

marshallpierce · 2024-03-25T23:11:08Z

bumble/device.py

+        attribute: Attribute,
+        value: Optional[bytes] = None,
+        force: bool = False,
+    ) -> None:


Added type annotations based on poking around at the callers, but since of course the type info isn't pervasive I'm not sure these are right

This is good. We want to eventually have everything type, incrementally.

marshallpierce · 2024-03-25T23:12:07Z

rust/Cargo.toml


 # Dev tools
 file-header = { version = "0.1.2", optional = true }
 globset = { version = "0.4.13", optional = true }

 # CLI
-anyhow = { version = "1.0.71", optional = true }


No longer optional due to wanting a "don't care" error for callbacks, etc, that wasn't the Python-specific PyError

marshallpierce · 2024-03-25T23:14:33Z

rust/examples/battery_service.rs

+
+    let mut builder = AdvertisementDataBuilder::new();
+    builder.append(CommonDataType::CompleteLocalName, "Bumble Battery")?;
+    builder.append(


This is fairly manual, but given the use cases for Bumble that might want to do somewhat exciting things vis-a-vis spec compliance, I'm not sure it makes sense to make a more OS-style API that doesn't require you to assemble the advertisement and prevents you from doing things wrong...?

Having a set of reusable AdvertismementData pre-set builders would be nice, for users who what just basic common stuff. That's something I've considered adding to the Python lib but haven't found the time to yet.

marshallpierce · 2024-03-25T23:15:55Z

rust/pytests/rootcanal.rs

+///
+/// This is a stop-gap until rootcanal's build is improved to the point that a rootcanal-sys crate,
+/// and using rootcanal as a library rather than a separate process, becomes feasible.
+pub(crate) async fn run_with_rootcanal<O, F>(closure: F) -> anyhow::Result<()>


@hchataing forgive me for these rootcanal crimes. Let me know if there is a less bad way to do this while I try to get the rootcanal build working on more systems.

marshallpierce · 2024-03-25T23:19:02Z

rust/pytests/rootcanal.rs

+/// Execute `closure` with a simple directory lock held.
+///
+/// Assumes that directory creation is atomic, which it is on most OS's.
+async fn with_dir_lock<T>(


Needed since tests run concurrently, and I don't want to sacrifice that as integration-level ones are rather slow

marshallpierce · 2024-03-25T23:22:28Z

rust/src/wrapper/att.rs

+use pyo3::types::PyBytes;
+use pyo3::{intern, PyAny, PyResult, Python};
+
+impl TryToPy for AttributeUuid {


Not quite sure how it'll work out, but I'm experimenting with having Try[To|From]Py in the wrapper module distinct from the relatively pure Rust structs in crate::internal

+1 this makes sense to me. If it causes confusion later, we can move things around.

marshallpierce · 2024-03-26T14:00:00Z

rust/src/wrapper/device/mod.rs

+
+            // Needed for Python 3.8-3.9, in which the Semaphore object, when constructed, calls
+            // `get_event_loop`.
+            wrap_python_async(py, device_ctor)?


Had to sprinkle this on Device and Peer invocations that end up instantiating an asyncio.Semaphore

rust/examples/battery_service.rs

nabilwadih · 2024-03-26T17:12:26Z

rust/pytests/rootcanal.rs

+    })
+}
+
+/// Returns the path to a rootcanal binary, downloading it from GitHub if necessary.


It seems a little odd to me that this is downloading artifacts at runtime, would it make sense to move this step into a build.rs and setting this up at build time?

I don't enjoy the current approach, but I don't see a great way of doing it with build.rs either that would work nicely with doing dirty tracking. I hope either way it's short lived, though -- with n additional hours I think I can get rootcanal building as a library, at which point a rootcanal-sys crate becomes reasonable, and this whole spawn-a-process thing can go away.

rust/src/internal/core.rs

rust/src/wrapper/assigned_numbers/services.rs

whitevegagabriel · 2024-04-03T18:40:17Z

rust/src/wrapper/att.rs

+use pyo3::types::PyBytes;
+use pyo3::{intern, PyAny, PyResult, Python};
+
+impl TryToPy for AttributeUuid {


+1 this makes sense to me. If it causes confusion later, we can move things around.

rust/examples/battery_service.rs

rust/src/internal/core.rs

rust/src/wrapper/hci.rs

rust/src/wrapper/mod.rs

rust/pytests/rootcanal.rs

whitevegagabriel · 2024-04-04T21:00:07Z

Also, although we've not quite kept up-to-date with the Changelog up to this point, could we at least make note of these changes in the Changelog now, so they're there for the next release?

With a whole lot of support to get there: - Device::add_service(), with some complexity around how to represent the mutable Python `Service` being used under the covers - AttributePermission, CharacteristicProperty, and other supporting GATT-related stuff - Ability to handle the different data types used by various Python `Characteristic` subclasses - Support for running tests in the context of a background `rootcanal` process - `TryToPy` and `TryFromPy` traits to help make the lifecycle more clear for structs that have a Python equivalent, but are also meaningful standalone - Add example with a minimal battery service - Rearrange known service IDs to make it possible to refer to a service UUID in a meaningful way - Make Address hold its own state to avoid propagating PyResult so much, and adopt the new TryToPy and TryFromPy traits - `AdvertisingDataValue` trait so users don't have to remember as many ADU encoding details at a call site - Sprinkle in more wrap_python_async to work on Python 3.8 and 3.9

marshallpierce force-pushed the mp/gatt-server branch 2 times, most recently from 2a6aedd to e823482 Compare March 25, 2024 23:31

marshallpierce commented Mar 25, 2024

View reviewed changes

marshallpierce force-pushed the mp/gatt-server branch from e823482 to bf9eb05 Compare March 26, 2024 13:50

marshallpierce commented Mar 26, 2024

View reviewed changes

marshallpierce marked this pull request as ready for review March 26, 2024 14:00

nabilwadih approved these changes Mar 26, 2024

View reviewed changes

marshallpierce force-pushed the mp/gatt-server branch from bf9eb05 to e521e68 Compare March 26, 2024 19:17

whitevegagabriel approved these changes Apr 4, 2024

View reviewed changes

marshallpierce force-pushed the mp/gatt-server branch from c8cb4d9 to e3f3cfc Compare April 5, 2024 15:31

marshallpierce and others added 2 commits April 5, 2024 09:35

Address PR feedback

19dc37d

marshallpierce force-pushed the mp/gatt-server branch from e3f3cfc to 19dc37d Compare April 5, 2024 15:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GATT server support for Rust #454

GATT server support for Rust #454

marshallpierce commented Mar 25, 2024

marshallpierce left a comment

marshallpierce Mar 25, 2024

barbibulle Mar 28, 2024

marshallpierce Mar 25, 2024

marshallpierce Mar 25, 2024

barbibulle Mar 28, 2024

marshallpierce Mar 25, 2024

marshallpierce Mar 25, 2024

marshallpierce Mar 25, 2024

whitevegagabriel Apr 3, 2024

marshallpierce Mar 26, 2024

nabilwadih Mar 26, 2024

marshallpierce Mar 26, 2024

whitevegagabriel Apr 3, 2024

whitevegagabriel commented Apr 4, 2024

GATT server support for Rust #454

Are you sure you want to change the base?

GATT server support for Rust #454

Conversation

marshallpierce commented Mar 25, 2024

marshallpierce left a 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

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

whitevegagabriel commented Apr 4, 2024