Merge pull request #1 from tannewt/lint

Lint and doc

Author: TheKitty

.travis.yml

@@ -39,7 +39,7 @@ deploy:
 install:
   - pip install -r requirements.txt
   - pip install circuitpython-build-tools Sphinx sphinx-rtd-theme
-  - pip install --force-reinstall pylint==1.9.2
+  - pip install --force-reinstall "pylint<3"
 
 script:
   - pylint adafruit_ble_apple_notification_center.py

README.rst

@@ -56,7 +56,44 @@ To install in a virtual environment in your current project:
 Usage Example
 =============
 
-.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
+.. code::python
+
+    """
+    This example solicits that apple devices that provide notifications connect to it, initiates
+    pairing, and prints existing notifications.
+    """
+
+    import adafruit_ble
+    from adafruit_ble.advertising.standard import SolicitServicesAdvertisement
+    import adafruit_ble_apple_notification_center as ancs
+
+    radio = adafruit_ble.BLERadio()
+    a = SolicitServicesAdvertisement()
+    a.solicited_services.append(ancs.AppleNotificationCenterService)
+    radio.start_advertising(a)
+
+    print("Waiting for connection")
+
+    while not radio.connected:
+        pass
+
+    print("Connected")
+
+    for connection in radio.connections:
+        if ancs.AppleNotificationCenterService not in connection:
+            continue
+
+        if not connection.paired:
+            connection.pair()
+            print("Paired")
+
+        ans = connection[ancs.AppleNotificationCenterService]
+        # Wait for the notifications to load.
+        while len(ans.active_notifications) == 0:
+            pass
+        for notification_id in ans.active_notifications:
+            notification = ans.active_notifications[notification_id]
+            print(notification.app_id, notification.title)
 
 Contributing
 ============

adafruit_ble_apple_notification_center.py

@@ -188,7 +188,8 @@ def __str__(self):
 class AppleNotificationCenterService(Service):
     """Notification service.
 
-    Documented by Apple here: https://developer.apple.com/library/archive/documentation/CoreBluetooth/Reference/AppleNotificationCenterServiceSpecification/Specification/Specification.html
+    Documented by Apple here:
+      https://developer.apple.com/library/archive/documentation/CoreBluetooth/Reference/AppleNotificationCenterServiceSpecification/Specification/Specification.html
 
     """
     uuid = VendorUUID("7905F431-B5CE-4E99-A40F-4B1E122D00D0")

docs/conf.py

@@ -20,7 +20,7 @@
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-# autodoc_mock_imports = ["digitalio", "busio"]
+autodoc_mock_imports = ["adafruit_ble"]
 
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}

docs/index.rst

@@ -23,14 +23,11 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-
 .. toctree::
     :caption: Related Products
 
-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
+    CircuitPlayground Bluefruit <https://www.adafruit.com/product/4333>
+    Feather nRF52840 <https://www.adafruit.com/product/4062>
 
 .. toctree::
     :caption: Other Links

examples/ble_apple_notification_center_new.py

@@ -0,0 +1,36 @@
+"""
+This example solicits that apple devices that provide notifications connect to it, initiates
+pairing, prints existing notifications and then prints any new ones as they arrive.
+"""
+
+import time
+import adafruit_ble
+from adafruit_ble.advertising.standard import SolicitServicesAdvertisement
+import adafruit_ble_apple_notification_center as ancs
+
+radio = adafruit_ble.BLERadio()
+a = SolicitServicesAdvertisement()
+a.solicited_services.append(ancs.AppleNotificationCenterService)
+radio.start_advertising(a)
+
+while not radio.connected:
+    pass
+
+print("connected")
+
+known_notifications = set()
+
+while radio.connected:
+    for connection in radio.connections:
+        if not connection.paired:
+            connection.pair()
+            print("paired")
+
+        ans = connection[ancs.AppleNotificationCenterService]
+        for notification in ans.wait_for_new_notifications():
+            print(notification)
+
+        print(len(ans.active_notifications))
+    time.sleep(1)
+
+print("disconnected")

examples/ble_apple_notification_center_simpletest.py

@@ -1,9 +1,8 @@
 """
 This example solicits that apple devices that provide notifications connect to it, initiates
-pairing, prints existing notifications and then prints any new ones as they arrive.
+pairing, and prints existing notifications.
 """
 
-import time
 import adafruit_ble
 from adafruit_ble.advertising.standard import SolicitServicesAdvertisement
 import adafruit_ble_apple_notification_center as ancs
@@ -13,22 +12,25 @@
 a.solicited_services.append(ancs.AppleNotificationCenterService)
 radio.start_advertising(a)
 
+print("Waiting for connection")
+
 while not radio.connected:
     pass
 
-print("connected")
-
-known_notifications = set()
+print("Connected")
 
-while radio.connected:
-    for connection in radio.connections:
-        if not connection.paired:
-            connection.pair()
-            print("paired")
+for connection in radio.connections:
+    if ancs.AppleNotificationCenterService not in connection:
+        continue
 
-        ans = connection[ancs.AppleNotificationCenterService]
-        for notification in ans.wait_for_new_notifications():
-            print(notification)
-    time.sleep(1)
+    if not connection.paired:
+        connection.pair()
+        print("Paired")
 
-print("disconnected")
+    ans = connection[ancs.AppleNotificationCenterService]
+    # Wait for the notifications to load.
+    while len(ans.active_notifications) == 0:
+        pass
+    for notification_id in ans.active_notifications:
+        notification = ans.active_notifications[notification_id]
+        print(notification.app_id, notification.title)

requirements.txt

@@ -1,2 +0,0 @@
-Adafruit-Blinka
-adafruit-circuitpython-ble