-
Notifications
You must be signed in to change notification settings - Fork 335
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add ensuring ble stack ready to readme #305
Conversation
README.md
Outdated
|
||
#### Why doesn't the BLE stack directly connect to my peripheral? | ||
|
||
Before you are able to execute BLE operations the ble stack of the device makes sure everything is setup correctly and then reports ready for duty. For some devices this takes a bit longer then for others. When starting the app make sure that the BLE-stack is properly intialized before you execute BLE operations. The safest way to do this is by listening to the `statusStream` and wait for `BleStatus.ready`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo:
this takes a bit longer than for others
properly initialized before you execute BLE operations
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a couple of amendments, please.
README.md
Outdated
@@ -208,15 +211,21 @@ iOS13 and higher | |||
iOS12 and lower | |||
* NSBluetoothPeripheralUsageDescription | |||
|
|||
#### How to adjust ProGuard (Android) | |||
#### How to adjust ProGuard (Android)? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would suggest to remove (revert) the question mark in the title.
An external example: https://support.microsoft.com/en-us/windows/how-to-refresh-reset-or-restore-your-pc-51391d9a-eb0a-84a7-69e4-c2c1fbceb8dd
README.md
Outdated
This will prevent issues like [#131](https://github.com/PhilipsHue/flutter_reactive_ble/issues/131) . | ||
This will prevent issues like [#131](https://github.com/PhilipsHue/flutter_reactive_ble/issues/131). | ||
|
||
#### Why doesn't the BLE stack directly connect to my peripheral? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here, suggesting to remove the question mark in the title.
README.md
Outdated
|
||
#### Why doesn't the BLE stack directly connect to my peripheral? | ||
|
||
Before you are able to execute BLE operations the ble stack of the device makes sure everything is setup correctly and then reports ready for duty. For some devices this takes a bit longer then for others. When starting the app make sure that the BLE-stack is properly intialized before you execute BLE operations. The safest way to do this is by listening to the `statusStream` and wait for `BleStatus.ready`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Always capitalize "BLE" (because it's an abbreviation).
Use a consistent spelling: either "BLE stack" (my preference) or "BLE-stack", not both.
"ready for duty" is probably fine, but I'd write "ready for operation".
Fixed the comments thanks for reviewing! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good now! 😄
Fix #147