Update ble_hid.md - Fixed Bad Instruction #519
Conversation
This file contains 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
baconspoon85
commented
Jul 18, 2022
baconspoon85
commented
- Corrected and clarified bad instruction. This document tells you to place the "adafruit_ble" library at the device root. It should be placed in the "lib" directory.
- Provided a more direct link to get the Adafruit CircuitPython Bundle. New link provides better detail from Adafruit for how and what to download.
- Corrected the link to instructions for renaming the CIRCUITPY drive.
1. Corrected and clarified bad instruction. This document tells you to place the "adafruit_ble" library at the device root. It should be placed in the "lib" directory. 2. Provided a more direct link to get the Adafruit CircuitPython Bundle. New link provides better detail from Adafruit for how and what to download. 3. Corrected the link to instructions for renaming the CIRCUITPY drive.
xs5871
reviewed
Jul 18, 2022
| Simply put this in the "root" of your CircuitPython device. If unsure, it's the folder with main.py in it, and should be the first folder you see when you open the device. | ||
| If not running KMKPython, this does require the [adafruit_ble library from Adafruit](https://github.com/adafruit/Adafruit_CircuitPython_BLE/tree/master/adafruit_ble). | ||
| It's part of the Adafruit CircuitPython Bundle, which can be downloaded [here](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/tag/20220715). | ||
| Get the bundle version that corresponds to the CircuitPython version installed on your device. Unzip the bundle and open the "lib" folder to locate the "adafruit_ble" library. Selectively copy that library (the entire "adafruit_ble" folder) and place it into the "lib" folder located at the root of your CIRCUITPY device. If unsure, the root is the main device storage folder where your main.py (or code.py) file is located. The "lib" folder should have been created when you installed CircuitPython. If not, just create one to place the ble library. |
There was a problem hiding this comment.
Why doesn't the device root work? Is there some specific code somewhere that explicitly sources from lib?
There was a problem hiding this comment.
Our standard convention seems to be on the root of the drive. If that library somehow only magically works only under /lib then an exception can be made, however that shouldn't be the case last I worked on BLE
Removed reference to KMKPython Co-authored-by: xs5871 <[email protected]>
kdb424
suggested changes
Aug 1, 2022
| Simply put this in the "root" of your CircuitPython device. If unsure, it's the folder with main.py in it, and should be the first folder you see when you open the device. | ||
| If not running KMKPython, this does require the [adafruit_ble library from Adafruit](https://github.com/adafruit/Adafruit_CircuitPython_BLE/tree/master/adafruit_ble). | ||
| It's part of the Adafruit CircuitPython Bundle, which can be downloaded [here](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/tag/20220715). | ||
| Get the bundle version that corresponds to the CircuitPython version installed on your device. Unzip the bundle and open the "lib" folder to locate the "adafruit_ble" library. Selectively copy that library (the entire "adafruit_ble" folder) and place it into the "lib" folder located at the root of your CIRCUITPY device. If unsure, the root is the main device storage folder where your main.py (or code.py) file is located. The "lib" folder should have been created when you installed CircuitPython. If not, just create one to place the ble library. |
There was a problem hiding this comment.
Our standard convention seems to be on the root of the drive. If that library somehow only magically works only under /lib then an exception can be made, however that shouldn't be the case last I worked on BLE
|
@baconspoon85 Just wondering if you plan on coming to make more changes? Otherwise, we'll adopt this and get it patched up and merged. These fixes should be put in place in the docs. |
|
I wasn't. Sorry, life got a bit out of hand this month. Thanks for the email.On Aug 10, 2022 01:55, Kyle Brown ***@***.***> wrote:
@baconspoon85 Just wondering if you plan on coming to make more changes? Otherwise, we'll adopt this and get it patched up and merged. These fixes should be put in place in the docs.
—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: ***@***.***>
|
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.