Add support for pairing and services that require it.

This adds HID Server, Current Time Service and Apple Notification
Service Client support.

Author: tannewt

adafruit_ble/__init__.py

@@ -21,27 +21,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`adafruit_ble`
-====================================================
 
 This module provides higher-level BLE (Bluetooth Low Energy) functionality,
 building on the native `_bleio` module.
 
-* Author(s): Dan Halbert and Scott Shawcroft for Adafruit Industries
-
-Implementation Notes
---------------------
-
-**Hardware:**
-
-   Adafruit Feather nRF52840 Express <https://www.adafruit.com/product/4062>
-   Adafruit Circuit Playground Bluefruit <https://www.adafruit.com/product/4333>
-
-**Software and Dependencies:**
-
-* Adafruit CircuitPython firmware for the supported boards:
-  https://github.com/adafruit/circuitpython/releases
-
 """
 #pylint: disable=wrong-import-position
 import sys
@@ -129,6 +112,15 @@ def connected(self):
         """True if the connection to the peer is still active."""
         return self._bleio_connection.connected
 
+    @property
+    def paired(self):
+        """True if the paired to the peer."""
+        return self._bleio_connection.paired
+
+    def pair(self, *, bond=True):
+        """Pair to the peer to increase security of the connection."""
+        return self._bleio_connection.pair(bond=bond)
+
     def disconnect(self):
         """Disconnect from peer."""
         self._bleio_connection.disconnect()

adafruit_ble/advertising/__init__.py

@@ -209,8 +209,8 @@ class Advertisement:
     # RANDOM_TARGET_ADDRESS = 0x18
     # """Random target address (chosen randomly)."""
     # APPEARANCE = 0x19
-    # # self.add_field(AdvertisingPacket.APPEARANCE, struct.pack("<H", appearance))
-    # """Appearance."""
+    appearance = Struct("<H", advertising_data_type=0x19)
+    """Appearance."""
     # DEVICE_ADDRESS = 0x1B
     # """LE Bluetooth device address."""
     # ROLE = 0x1C

adafruit_ble/advertising/standard.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`standard`
+:py:mod:`~adafruit_ble.advertising.standard`
 ====================================================
 
 This module provides BLE standard defined advertisements. The Advertisements are single purpose
@@ -84,8 +84,11 @@ def __iter__(self):
     def append(self, service):
         """Append a service to the list."""
         if isinstance(service.uuid, StandardUUID) and service not in self._standard_services:
-            self._standard_services.append(service)
+            self._standard_services.append(service.uuid)
             self._update(self._standard_service_fields[0], self._standard_services)
+        elif isinstance(service.uuid, VendorUUID) and service not in self._vendor_services:
+            self._vendor_services.append(service.uuid)
+            self._update(self._vendor_service_fields[0], self._vendor_services)
 
     # TODO: Differentiate between complete and incomplete lists.
     def extend(self, services):

adafruit_ble/characteristics/__init__.py

@@ -20,8 +20,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-:py:mod:`~adafruit_ble.characteristics`
-====================================================
 
 This module provides core BLE characteristic classes that are used within Services.
 
@@ -92,7 +90,7 @@ class Characteristic:
 
     def __init__(self, *, uuid=None, properties=0,
                  read_perm=Attribute.OPEN, write_perm=Attribute.OPEN,
-                 max_length=20, fixed_length=False, initial_value=None):
+                 max_length=None, fixed_length=False, initial_value=None):
         self.field_name = None # Set by Service during basic binding
 
         if uuid:
@@ -201,7 +199,7 @@ def __init__(self, struct_format, *, uuid=None, properties=0,
         self._struct_format = struct_format
         self._expected_size = struct.calcsize(struct_format)
         if initial_value:
-            initial_value = struct.pack(self._struct_format, initial_value)
+            initial_value = struct.pack(self._struct_format, *initial_value)
         super().__init__(uuid=uuid, initial_value=initial_value,
                          max_length=self._expected_size, fixed_length=True,
                          properties=properties, read_perm=read_perm, write_perm=write_perm)

adafruit_ble/characteristics/int.py

@@ -41,9 +41,9 @@ def __init__(self, format_string, min_value, max_value, *, uuid=None, properties
         self._min_value = min_value
         self._max_value = max_value
         if initial_value:
-            initial_value = (initial_value,)
             if not self._min_value <= initial_value <= self._max_value:
                 raise ValueError("initial_value out of range")
+            initial_value = (initial_value,)
 
 
         super().__init__(format_string, uuid=uuid, properties=properties,

adafruit_ble/services/__init__.py

@@ -20,8 +20,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-:py:mod:`~adafruit_ble.services`
-====================================================
 
 This module provides the top level Service definition.
 

adafruit_ble/services/apple.py

@@ -27,8 +27,11 @@
 
 """
 
+import struct
+
 from . import Service
 from ..uuid import VendorUUID
+from ..characteristics.stream import StreamIn, StreamOut
 
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BLE.git"
@@ -41,10 +44,121 @@ class UnknownApple1Service(Service):
     """Unknown service. Unimplemented."""
     uuid = VendorUUID("9fa480e0-4967-4542-9390-d343dc5d04ae")
 
+class Notification:
+    def __init__(self, id, event_flags, category_id, category_count, *, control_point, data_source):
+        self.id = id
+        self.category_id = category_id
+        self.removed = False
+
+        self.silent = (event_flags & (1 << 0)) != 0
+        self.important = (event_flags & (1 << 1)) != 0
+        self.preexisting = (event_flags & (1 << 2)) != 0
+        self.positive_action = (event_flags & (1 << 3)) != 0
+        self.negative_action = (event_flags & (1 << 4)) != 0
+
+        self.subtitle = None
+        self.message = None
+
+        self.control_point = control_point
+        self.data_source = data_source
+
+    def update(self, event_flags, category_id, category_count):
+        pass
+
+    def _fetch_all(self):
+        self.control_point.write(struct.pack("<BIBBHBHBHBBBB", 0, self.id, 0, 1, 32, 2, 32, 3, 255, 4, 5, 6, 7))
+        while self.data_source.in_waiting == 0:
+            pass
+        _, _ = struct.unpack("<BI", self.data_source.read(5))
+
+        for attribute in ["app_id", "title", "subtitle", "message", "message_size", "date", "positive_action_label", "negative_action_label"]:
+            attribute_id, attribute_length = struct.unpack("<BH", self.data_source.read(3))
+            if attribute_length == 0:
+                continue
+            value = self.data_source.read(attribute_length).decode("utf-8")
+            setattr(self, attribute, value)
+
+    @property
+    def app(self):
+        self.control_point.write(struct.pack("<BIB", 0, self.id, 0))
+        while self.data_source.in_waiting == 0:
+            pass
+        print(self.data_source.in_waiting)
+        print(self.data_source.read())
+        return ""
+
+
+    def __str__(self):
+        self._fetch_all()
+        flags = []
+        category = None
+        if self.category_id == 0:
+            category = "Other"
+        elif self.category_id == 1:
+            category = "IncomingCall"
+        elif self.category_id == 2:
+            category = "MissedCall"
+        elif self.category_id == 3:
+            category = "Voicemail"
+        elif self.category_id == 4:
+            category = "Social"
+        elif self.category_id == 5:
+            category = "Schedule"
+        elif self.category_id == 6:
+            category = "Email"
+        elif self.category_id == 7:
+            category = "News"
+        elif self.category_id == 8:
+            category = "HealthAndFitness"
+        elif self.category_id == 9:
+            category = "BusinessAndFinance"
+        elif self.category_id == 10:
+            category = "Location"
+        elif self.category_id == 11:
+            category = "Entertainment"
+
+        if self.silent:
+            flags.append("silent")
+        if self.important:
+            flags.append("important")
+        if self.preexisting:
+            flags.append("preexisting")
+        if self.positive_action:
+            flags.append("positive_action")
+        if self.negative_action:
+            flags.append("negative_action")
+        return category + " " + " ".join(flags) + " " + self.app_id + " " + self.title + " " + str(self.subtitle) + " " + str(self.message) + " " + self.date
+
 class AppleNotificationService(Service):
-    """Notification service. Unimplemented."""
+    """Notification service."""
     uuid = VendorUUID("7905F431-B5CE-4E99-A40F-4B1E122D00D0")
 
+    control_point = StreamIn(uuid=VendorUUID("69D1D8F3-45E1-49A8-9821-9BBDFDAAD9D9"))
+    data_source = StreamOut(uuid=VendorUUID("22EAC6E9-24D6-4BB5-BE44-B36ACE7C7BFB"), buffer_size=1024)
+    notification_source = StreamOut(uuid=VendorUUID("9FBF120D-6301-42D9-8C58-25E699A21DBD"), buffer_size=8*100)
+
+    def __init__(self, service=None):
+        super().__init__(service=service)
+        self._active_notifications = {}
+
+    def _update_notifications(self):
+        while self.notification_source.in_waiting > 7:
+            buffer = self.notification_source.read(8)
+            event_id, event_flags, category_id, category_count, id = struct.unpack("<BBBBI", buffer)
+            if event_id == 0:
+                self._active_notifications[id] = Notification(id, event_flags, category_id,
+                    category_count, control_point=self.control_point, data_source=self.data_source)
+            elif event_id == 1:
+                self._active_notifications[id].update(event_flags, category_id, category_count)
+            elif event_id == 2:
+                self._active_notifications[id].removed = True
+                del self._active_notifications[id]
+            #print(event_id, event_flags, category_id, category_count)
+
+    def __iter__(self):
+        self._update_notifications()
+        return iter(self._active_notifications.values())
+
 class AppleMediaService(Service):
     """View and control currently playing media. Unimplemented."""
     uuid = VendorUUID("89D3502B-0F36-433A-8EF4-C502AD55F8DC")

adafruit_ble/services/standard/__init__.py

@@ -0,0 +1,82 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2019 Scott Shawcroft for Adafruit Industries
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""
+
+This module provides Service classes for BLE defined standard services.
+
+"""
+
+import time
+
+from .. import Service
+from ...uuid import StandardUUID
+from ...characteristics.string import StringCharacteristic
+from ...characteristics import StructCharacteristic
+from ...characteristics.int import Uint8Characteristic
+
+__version__ = "0.0.0-auto.0"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BLE.git"
+
+class AppearanceCharacteristic(StructCharacteristic):
+    """What type of device it is"""
+    uuid = StandardUUID(0x2a01)
+
+    def __init__(self, **kwargs):
+        super().__init__("<H", **kwargs)
+
+class GenericAccess(Service):
+    """Required service that provides basic device information"""
+    uuid = StandardUUID(0x1800)
+    device_name = StringCharacteristic(uuid=StandardUUID(0x2a00))
+    appearance = AppearanceCharacteristic()
+    # privacy_flag
+    # reconnection_address
+    # preferred_connection_parameters
+
+class GenericAttribute(Service):
+    """Required service that provides notifications when Services change"""
+    uuid = StandardUUID(0x1801)
+    # service_changed - indicate only
+
+class BatteryService(Service):
+    """Provides battery level information"""
+    uuid = StandardUUID(0x180f)
+    level = Uint8Characteristic(max_value=100, uuid=StandardUUID(0x2A19))
+
+class CurrentTimeService(Service):
+    """Provides the current time."""
+    uuid = StandardUUID(0x1805)
+    current_time = StructCharacteristic('<HBBBBBBBB', uuid=StandardUUID(0x2a2b))
+    """A tuple describing the current time:
+        (year, month, day, hour, minute, second, weekday, subsecond, adjust_reason)"""
+
+    local_time_info = StructCharacteristic('<bB', uuid=StandardUUID(0x2a0f))
+    """A tuple of location information: (timezone, dst_offset)"""
+
+    @property
+    def struct_time(self):
+        """The current time as a `time.struct_time`. Day of year and whether DST is in effect
+        are always -1.
+        """
+        year, month, day, hour, minute, second, weekday, _, _ = self.current_time
+        # Bluetooth weekdays count from 1. struct_time counts from 0.
+        return time.struct_time((year, month, day, hour, minute, second, weekday - 1, -1, -1))

adafruit_ble/services/standard/device_info.py

@@ -21,25 +21,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`adafruit_ble`
-====================================================
-
-This module provides higher-level BLE (Bluetooth Low Energy) functionality,
-building on the native `_bleio` module.
-
-* Author(s): Dan Halbert for Adafruit Industries
-
-Implementation Notes
---------------------
-
-**Hardware:**
-
-   Adafruit Feather nRF52840 Express <https://www.adafruit.com/product/4062>
-
-**Software and Dependencies:**
-
-* Adafruit CircuitPython firmware for the supported boards:
-  https://github.com/adafruit/circuitpython/releases
+:py:mod:`~adafruit_ble.services.standard.device_info`
+=======================================================
 
 """