Rework the API to use descriptors. #30
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This makes Advertisement and Service definitions declarative by factoring out parsing logic out into shareable descriptor classes similar to how the Register library works. This also introduces SmartAdapter and SmartConnection which will auto-create the correct Advertisements and Services without requiring any direct use of UUIDs. Instead, classes are used to identify relevant objects to "recognize". This requires adafruit/circuitpython#2236 and relates to adafruit/circuitpython#586.
|
@theacodes This is the API we chatted about a while back. Would love your thoughts on it. |
|
Will take a look either tonight or tomorrow. 👍
…On Tue, Oct 22, 2019, 5:34 PM Scott Shawcroft ***@***.***> wrote:
@theacodes <https://github.com/theacodes> This is the API we chatted
about a while back. Would love your thoughts on it.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#30?email_source=notifications&email_token=AAB5I46H7AQOYHKZIPTPALTQP6LXZA5CNFSM4JD2FBT2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEB7UP4Q#issuecomment-545212402>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAB5I465Z2QO7SKJXXN62DLQP6LXZANCNFSM4JD2FBTQ>
.
|
theacodes
reviewed
Oct 23, 2019
dhalbert
requested changes
Oct 31, 2019
This renames Smart* to BLE* and removes the smart recognition. It is replaced by knowing the type of what we're interested at use time only. Only printing Service lists is now dumber. Interal variables to _bleio classes are now public as bleio_* instead so that other classes in the library can access them and its clearer what they are.
tannewt
commented
Nov 1, 2019
|
Some simple pylint failures. |
dhalbert
requested changes
Nov 1, 2019
There was a problem hiding this comment.
Thanks for the big talk we had: I have a much better understanding now of the internal structure. Any further internal changes will affect the user API very little or not at all. Only have minor stuff (and pylint fixes).
Thanks also for the reorg, removing the core.py stuff: the source structure is cleaner now.
theacodes
reviewed
Nov 2, 2019
|
|
||
| ble = BLERadio() | ||
| while True: | ||
| while ble.connected and any(UARTService in connection for connection in ble.connections): |
There was a problem hiding this comment.
Yeah, we really need a helper for this. Maybe:
ble.find_service(UARTService)
With a behavior of Helper method that looks through all connections for a given service and returns the first one found.
There was a problem hiding this comment.
We're merging this now and will look for API helpers, etc. when rewriting the current examples. Thanks and we'll keep all these in mind.
| k = Keyboard(hid.devices) | ||
| kl = KeyboardLayoutUS(k) | ||
| while True: | ||
| while not ble.connected: |
There was a problem hiding this comment.
This spinning on connected is becoming a pattern. Maybe a helper ble.wait_for_connection() with an optional timeout?
dhalbert
approved these changes
Nov 5, 2019
There was a problem hiding this comment.
Merging this now to keep up with the corresponding CircuitPython PR: adafruit/circuitpython#2236
adafruit-adabot
added a commit
to adafruit/Adafruit_CircuitPython_Bundle
that referenced
this pull request
Nov 20, 2019
Updating https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1305 to 1.0.3 from 1.0.2: > Merge pull request adafruit/Adafruit_CircuitPython_DisplayIO_SSD1305#5 from makermelissa/master Updating https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display to 3.6.0 from 3.5.6: > Merge pull request adafruit/Adafruit_CircuitPython_RGB_Display#51 from makermelissa/master > Merge pull request adafruit/Adafruit_CircuitPython_RGB_Display#47 from Johennes/feature/numpy Updating https://github.com/adafruit/Adafruit_CircuitPython_BLE to 3.0.0 from 1.0.2: > Merge pull request adafruit/Adafruit_CircuitPython_BLE#34 from dhalbert/check-cpy-version > Merge pull request adafruit/Adafruit_CircuitPython_BLE#32 from dhalbert/doc-and-cleanup > Merge pull request adafruit/Adafruit_CircuitPython_BLE#31 from dhalbert/char-fixes-and-float > Merge pull request adafruit/Adafruit_CircuitPython_BLE#30 from tannewt/api_rework > Merge pull request adafruit/Adafruit_CircuitPython_BLE#29 from adafruit/dherrada-patch-1 > Merge pull request adafruit/Adafruit_CircuitPython_BLE#25 from kattni/plotter-code > Merge pull request adafruit/Adafruit_CircuitPython_BLE#23 from kattni/update-color-picker > Merge pull request adafruit/Adafruit_CircuitPython_BLE#22 from kattni/update-color-picker > Merge pull request adafruit/Adafruit_CircuitPython_BLE#21 from kattni/cpb-color-picker > Merge pull request adafruit/Adafruit_CircuitPython_BLE#18 from dhalbert/bleio-api-revamp > Merge pull request adafruit/Adafruit_CircuitPython_BLE#17 from dhalbert/demo-central > Merge pull request adafruit/Adafruit_CircuitPython_BLE#16 from dhalbert/pairing > Merge pull request adafruit/Adafruit_CircuitPython_BLE#15 from dhalbert/python-advertisement-data
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thank you so much for taking this on @dhalbert.
This makes Advertisement and Service definitions declarative by
factoring out parsing logic out into shareable descriptor classes
similar to how the Register library works.
This also introduces SmartAdapter and SmartConnection which will
auto-create the correct Advertisements and Services without requiring
any direct use of UUIDs. Instead, classes are used to identify
relevant objects to "recognize".
I've added comments to the examples on which should work. I just confirmed that UART mostly still works. The client device safe moded for some reason but I'm out of debugging time. After a button reset it worked ok.
This requires adafruit/circuitpython#2236 and
relates to adafruit/circuitpython#586.