add passkey delegate support for pairing #708
Conversation
barbibulle
force-pushed
the
gbg/delegated-passkey
branch
from
df90a5a to
d631156
Compare
bumble/smp.py
Outdated
| try: | ||
| utils.cancel_on_event( | ||
| self.connection, | ||
| 'disconnection', |
There was a problem hiding this comment.
| 'disconnection', | |
| self.connection.EVENT_DISCONNECTION, |
There was a problem hiding this comment.
I ended up creating a help function for the common call: utils.cancel_on_event(self.connection, 'disconnection', foo() --> self.connection.cancel_on_disconnection(foo())
bumble/smp.py
Outdated
|
|
||
| # Send our public key back to the initiator | ||
| self.send_public_key_command() | ||
| def next_steps(): |
There was a problem hiding this comment.
To enforce type checking
| def next_steps(): | |
| def next_steps() -> None: |
| ) | ||
| except Exception as error: | ||
| logger.warning(f'exception while displaying number: {error}') | ||
| await self.pairing_config.delegate.display_number(self.passkey, digits=6) |
There was a problem hiding this comment.
nit: This will become blocking, but it looks intended. Maybe we should have a better documentation about which methods are and should be blocking.
There was a problem hiding this comment.
all the delegate methods are made async so that they can block if needed. I'm planning on doing a complete doc of the pairing delegate, where this will be explained in details.
| """ | ||
|
|
||
| # By default, generate a random passkey. | ||
| return secrets.randbelow(1000000) |
There was a problem hiding this comment.
Unrelated: Currently, both PairingConfig and PairingDelegate don't have information about the pairing session. I think we may need to add such information like a connection attribute in the future.
There was a problem hiding this comment.
Actually, the pairing configs can use the connection context if they need it. The PairingConfig and PairingDelegate base classes don't store it, because they don't need it, but pairing_config_factory takes a connection arg, so if your config or delegate needs the context, it can keep it.
Ex:
device.pairing_config_factory = lambda connection: MyPairingConfig(connection)
As discussed in #705
Passkey generation has a default implementation in
PairingDelegatewhich can be overridden by subclasses.