Skip to content

Commit 3d67010

Browse files
committed
Update readme for notification queueing
1 parent 7709abe commit 3d67010

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

readme.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,14 @@ Discovery works differently between Android and iOS. In Android, a single functi
181181

182182

183183
## Queuing (Android) ##
184-
Read, write, subscribe, unsubscribe, readDescriptor and writeDescriptor queueing has been added to the master branch and will be part of the 4.1.0 release. If you'd like to try it out, install the plugin directly from GitHub using: ```cordova plugin https://github.com/randdusing/cordova-plugin-bluetoothle```
184+
On Android, the plugin automatically queues the following operations:
185+
* read
186+
* write
187+
* subscribe
188+
* unsubscribe
189+
* readDescriptor
190+
* writeDescriptor
191+
* notify
185192

186193

187194
## UUIDs ##
@@ -1809,7 +1816,7 @@ Initialization works slightly different between Android and iOS. On iOS, you don
18091816

18101817

18111818
### Notifications ###
1812-
Notifications work slightly differently between Android and iOS. On Android, you should wait for the ```notificationSent``` event before calling notify() again. On iOS, you need to check the notify() callback for the sent property. If the sent property is set to false, you should wait until receiving the ```peripheralManagerIsReadyToUpdateSubscribers``` event to resend the notification. In future versions, I hope to standardize the functionality between platforms.
1819+
Notifications work slightly differently between Android and iOS. Queueing for notifications is currently only implemented on Android. On Android, the notify() success callback will always include ```sent: true```. On iOS, if the sent property is set to false, you should wait until receiving the ```peripheralManagerIsReadyToUpdateSubscribers``` event to resend the notification. In future versions, I hope to standardize the functionality between platforms.
18131820

18141821

18151822
### Descriptors ###
@@ -1845,7 +1852,7 @@ bluetoothle.initializePeripheral(success, error, params);
18451852
* status => subscribed = Subscription started request, use notify() to send new data
18461853
* status => unsubscribed = Subscription ended request, stop sending data
18471854
* status => notificationReady = Resume sending subscription updates (iOS)
1848-
* status => notificationSent = Notification has been sent (Android)
1855+
* status => notificationSent = Notification has been sent (Android) [DEPRECATED: Use notify() callback instead]
18491856
* status => connected = A device has connected
18501857
* status => disconnected = A device has disconnected
18511858
* status => mtuChanged = MTU has changed for device

0 commit comments

Comments
 (0)