rename bleio to _bleio

dhalbert · dhalbert · commit 42e871d25981 · 2019-08-29T18:44:46.000-04:00
diff --git a/README.rst b/README.rst
@@ -13,7 +13,8 @@ Introduction
     :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_ble
     :alt: Build Status
 
-This module provides higher-level BLE (Bluetooth Low Energy) functionality, building on the native `bleio` module.
+This module provides higher-level BLE (Bluetooth Low Energy) functionality,
+building on the native `_bleio` module.
 
 Dependencies
 =============
diff --git a/adafruit_ble/__init__.py b/adafruit_ble/__init__.py
@@ -24,7 +24,7 @@
 ====================================================
 
 This module provides higher-level BLE (Bluetooth Low Energy) functionality,
-building on the native `bleio` module.
+building on the native `_bleio` module.
 
 * Author(s): Dan Halbert for Adafruit Industries
 
diff --git a/adafruit_ble/beacon.py b/adafruit_ble/beacon.py
@@ -30,7 +30,7 @@
 """
 
 import struct
-import bleio
+from _bleio import Peripheral
 
 from .advertising import AdvertisingPacket
 
@@ -41,7 +41,7 @@ def __init__(self, advertising_packet):
 
         :param AdvertisingPacket advertising_packet
         """
-        self._broadcaster = bleio.Peripheral()
+        self._broadcaster = Peripheral()
         self._advertising_packet = advertising_packet
 
     def start(self, interval=1.0):
@@ -76,7 +76,7 @@ def __init__(self, company_id, uuid, major, minor, rssi):
     Example::
 
         from adafruit_ble.beacon import LocationBeacon
-        from bleio import UUID
+        from adafruit_ble.uuid import UUID
         test_uuid = UUID('12345678-1234-1234-1234-123456789abc')
         test_company = 0xFFFF
         b = LocationBeacon(test_company, test_uuid, 123, 234, -54)
diff --git a/adafruit_ble/current_time_client.py b/adafruit_ble/current_time_client.py
@@ -31,7 +31,7 @@
 import struct
 import time
 
-from bleio import Peripheral, UUID
+from _bleio import Peripheral, UUID
 from .advertising import SolicitationAdvertisement
 
 class CurrentTimeClient:
diff --git a/adafruit_ble/device_information_service.py b/adafruit_ble/device_information_service.py
@@ -28,7 +28,7 @@
 * Author(s): Dan Halbert for Adafruit Industries
 
 """
-from bleio import Attribute, Characteristic, UUID
+from _bleio import Attribute, Characteristic, Service, UUID
 
 class DeviceInformationService:
     """This is a factory class only, and has no instances."""
@@ -67,7 +67,7 @@ def add_to_peripheral(peripheral, *, model_number=None, serial_number=None,
         # Software Revision UUID = 0x2A28
         # Manufacturer Name UUID = 0x2A29
 
-        service = peripheral.add_service(UUID(0x180A))
+        service = Service.add_to_peripheral(peripheral, UUID(0x180A))
 
         if model_number is None:
             import sys
@@ -88,9 +88,10 @@ def add_to_peripheral(peripheral, *, model_number=None, serial_number=None,
                  firmware_revision, hardware_revision, software_revision,
                  manufacturer)):
 
-            service.add_characteristic(UUID(uuid_num), properties=Characteristic.READ,
-                                       read_perm=Attribute.OPEN, write_perm=Attribute.NO_ACCESS,
-                                       fixed_length=True, max_length=len(value),
-                                       initial_value=value)
+            Characteristic.add_to_service(
+                service, UUID(uuid_num), properties=Characteristic.READ,
+                read_perm=Attribute.OPEN, write_perm=Attribute.NO_ACCESS,
+                fixed_length=True, max_length=len(value),
+                initial_value=value)
 
         return service
diff --git a/adafruit_ble/hid_server.py b/adafruit_ble/hid_server.py
@@ -35,7 +35,7 @@
 # for __version__
 import adafruit_ble
 
-from bleio import Attribute, Characteristic, Descriptor, Peripheral, Service, UUID
+from _bleio import Attribute, Characteristic, Descriptor, Peripheral, Service, UUID
 from .advertising import ServerAdvertisement
 from .device_information_service import DeviceInformationService
 
@@ -116,52 +116,52 @@ class HIDServer:
         b'\x95\x03'        #   Report Count (3)
         b'\x91\x01'        #   Output (Const,Array,Abs,No Wrap,Linear,Preferred State,No Null Position,Non-volatile)
         b'\xC0'            # End Collection
-        # b'\x05\x01'        # Usage Page (Generic Desktop Ctrls)
-        # b'\x09\x02'        # Usage (Mouse)
-        # b'\xA1\x01'        # Collection (Application)
-        # b'\x09\x01'        #   Usage (Pointer)
-        # b'\xA1\x00'        #   Collection (Physical)
-        # b'\x85\x02'        #     Report ID (2)
-        # b'\x05\x09'        #     Usage Page (Button)
-        # b'\x19\x01'        #     Usage Minimum (\x01)
-        # b'\x29\x05'        #     Usage Maximum (\x05)
-        # b'\x15\x00'        #     Logical Minimum (0)
-        # b'\x25\x01'        #     Logical Maximum (1)
-        # b'\x95\x05'        #     Report Count (5)
-        # b'\x75\x01'        #     Report Size (1)
-        # b'\x81\x02'        #     Input (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position)
-        # b'\x95\x01'        #     Report Count (1)
-        # b'\x75\x03'        #     Report Size (3)
-        # b'\x81\x01'        #     Input (Const,Array,Abs,No Wrap,Linear,Preferred State,No Null Position)
-        # b'\x05\x01'        #     Usage Page (Generic Desktop Ctrls)
-        # b'\x09\x30'        #     Usage (X)
-        # b'\x09\x31'        #     Usage (Y)
-        # b'\x15\x81'        #     Logical Minimum (-127)
-        # b'\x25\x7F'        #     Logical Maximum (127)
-        # b'\x75\x08'        #     Report Size (8)
-        # b'\x95\x02'        #     Report Count (2)
-        # b'\x81\x06'        #     Input (Data,Var,Rel,No Wrap,Linear,Preferred State,No Null Position)
-        # b'\x09\x38'        #     Usage (Wheel)
-        # b'\x15\x81'        #     Logical Minimum (-127)
-        # b'\x25\x7F'        #     Logical Maximum (127)
-        # b'\x75\x08'        #     Report Size (8)
-        # b'\x95\x01'        #     Report Count (1)
-        # b'\x81\x06'        #     Input (Data,Var,Rel,No Wrap,Linear,Preferred State,No Null Position)
-        # b'\xC0'            #   End Collection
-        # b'\xC0'            # End Collection
-        # b'\x05\x0C'        # Usage Page (Consumer)
-        # b'\x09\x01'        # Usage (Consumer Control)
-        # b'\xA1\x01'        # Collection (Application)
-        # b'\x85\x03'        #   Report ID (3)
-        # b'\x75\x10'        #   Report Size (16)
-        # b'\x95\x01'        #   Report Count (1)
-        # b'\x15\x01'        #   Logical Minimum (1)
-        # b'\x26\x8C\x02'    #   Logical Maximum (652)
-        # b'\x19\x01'        #   Usage Minimum (Consumer Control)
-        # b'\x2A\x8C\x02'    #   Usage Maximum (AC Send)
-        # b'\x81\x00'        #   Input (Data,Array,Abs,No Wrap,Linear,Preferred State,No Null Position)
-        # b'\xC0'            # End Collection
-        # b'\x05\x01'        # Usage Page (Generic Desktop Ctrls)
+        b'\x05\x01'        # Usage Page (Generic Desktop Ctrls)
+        b'\x09\x02'        # Usage (Mouse)
+        b'\xA1\x01'        # Collection (Application)
+        b'\x09\x01'        #   Usage (Pointer)
+        b'\xA1\x00'        #   Collection (Physical)
+        b'\x85\x02'        #     Report ID (2)
+        b'\x05\x09'        #     Usage Page (Button)
+        b'\x19\x01'        #     Usage Minimum (\x01)
+        b'\x29\x05'        #     Usage Maximum (\x05)
+        b'\x15\x00'        #     Logical Minimum (0)
+        b'\x25\x01'        #     Logical Maximum (1)
+        b'\x95\x05'        #     Report Count (5)
+        b'\x75\x01'        #     Report Size (1)
+        b'\x81\x02'        #     Input (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position)
+        b'\x95\x01'        #     Report Count (1)
+        b'\x75\x03'        #     Report Size (3)
+        b'\x81\x01'        #     Input (Const,Array,Abs,No Wrap,Linear,Preferred State,No Null Position)
+        b'\x05\x01'        #     Usage Page (Generic Desktop Ctrls)
+        b'\x09\x30'        #     Usage (X)
+        b'\x09\x31'        #     Usage (Y)
+        b'\x15\x81'        #     Logical Minimum (-127)
+        b'\x25\x7F'        #     Logical Maximum (127)
+        b'\x75\x08'        #     Report Size (8)
+        b'\x95\x02'        #     Report Count (2)
+        b'\x81\x06'        #     Input (Data,Var,Rel,No Wrap,Linear,Preferred State,No Null Position)
+        b'\x09\x38'        #     Usage (Wheel)
+        b'\x15\x81'        #     Logical Minimum (-127)
+        b'\x25\x7F'        #     Logical Maximum (127)
+        b'\x75\x08'        #     Report Size (8)
+        b'\x95\x01'        #     Report Count (1)
+        b'\x81\x06'        #     Input (Data,Var,Rel,No Wrap,Linear,Preferred State,No Null Position)
+        b'\xC0'            #   End Collection
+        b'\xC0'            # End Collection
+        b'\x05\x0C'        # Usage Page (Consumer)
+        b'\x09\x01'        # Usage (Consumer Control)
+        b'\xA1\x01'        # Collection (Application)
+        b'\x85\x03'        #   Report ID (3)
+        b'\x75\x10'        #   Report Size (16)
+        b'\x95\x01'        #   Report Count (1)
+        b'\x15\x01'        #   Logical Minimum (1)
+        b'\x26\x8C\x02'    #   Logical Maximum (652)
+        b'\x19\x01'        #   Usage Minimum (Consumer Control)
+        b'\x2A\x8C\x02'    #   Usage Maximum (AC Send)
+        b'\x81\x00'        #   Input (Data,Array,Abs,No Wrap,Linear,Preferred State,No Null Position)
+        b'\xC0'            # End Collection
+        b'\x05\x01'        # Usage Page (Generic Desktop Ctrls)
         # b'\x09\x05'        # Usage (Game Pad)
         # b'\xA1\x01'        # Collection (Application)
         # b'\x85\x05'        #   Report ID (5)
@@ -198,8 +198,8 @@ class HIDServer:
 
     _INPUT_REPORT_SIZES = {
         REPORT_ID_KEYBOARD : 8,
-        # REPORT_ID_MOUSE : 4,
-        # REPORT_ID_CONSUMER_CONTROL : 2,
+        REPORT_ID_MOUSE : 4,
+        REPORT_ID_CONSUMER_CONTROL : 2,
         # REPORT_ID_GAMEPAD : 6,
     }
 
@@ -215,7 +215,7 @@ def __init__(self, name=None, tx_power=0):
             self._periph, software_revision=adafruit_ble.__version__,
             manufacturer="Adafruit Industries")
 
-        hid_service = Service.add_to_peripheral(UUID(_HID_SERVICE_UUID_NUM))
+        hid_service = Service.add_to_peripheral(self._periph, UUID(_HID_SERVICE_UUID_NUM))
 
         self._input_chars = {}
         for report_id in sorted(self._INPUT_REPORT_SIZES.keys()):
diff --git a/adafruit_ble/scanner.py b/adafruit_ble/scanner.py
@@ -30,7 +30,8 @@
 """
 import struct
 
-import bleio
+from _bleio import Scanner as _BLEIOScanner
+from _bleio import UUID
 
 from .advertising import AdvertisingPacket
 
@@ -46,7 +47,7 @@ class Scanner:
     """
 
     def __init__(self):
-        self._scanner = bleio.Scanner()
+        self._scanner = _BLEIOScanner()
 
     def scan(self, timeout, *, interval=0.1, window=0.1):
         """Scan for advertisements from BLE devices. Suppress duplicates
@@ -82,7 +83,7 @@ class ScanEntry:
     """
     Information about an advertising packet from a BLE device received by a `Scanner`.
 
-    :param bleio.ScanEntry scan_entry: lower-level ScanEntry returned from `bleio.Scanner`.
+    :param _bleio.ScanEntry scan_entry: lower-level ScanEntry returned from `_bleio.Scanner`.
       This constructor is normally used only by `Scanner`.
     """
 
@@ -133,7 +134,7 @@ def service_uuids(self):
             for i in range(0, len(concat_uuids), 16):
                 uuid_values.append(concat_uuids[i:i+16])
 
-        return [bleio.UUID(value) for value in uuid_values]
+        return [UUID(value) for value in uuid_values]
 
     @property
     def manufacturer_specific_data(self):
diff --git a/adafruit_ble/uart.py b/adafruit_ble/uart.py
@@ -28,7 +28,7 @@
 * Author(s): Dan Halbert for Adafruit Industries
 
 """
-from bleio import UUID
+from _bleio import UUID
 
 NUS_SERVICE_UUID = UUID("6E400001-B5A3-F393-E0A9-E50E24DCCA9E")
 """Nordic UART Service UUID"""
diff --git a/adafruit_ble/uart_client.py b/adafruit_ble/uart_client.py
@@ -28,7 +28,7 @@
 * Author(s): Dan Halbert for Adafruit Industries
 
 """
-from bleio import Central, CharacteristicBuffer
+from _bleio import Central, CharacteristicBuffer
 from .uart import NUS_SERVICE_UUID, NUS_RX_CHAR_UUID, NUS_TX_CHAR_UUID
 from .scanner import Scanner, ScanEntry
 
@@ -65,7 +65,7 @@ def __init__(self, *, timeout=1.0, buffer_size=64):
     def connect(self, address, timeout):
         """Try to connect to the peripheral at the given address.
 
-        :param bleio.Address address: The address of the peripheral to connect to
+        :param Address address: The address of the peripheral to connect to
         :param float/int timeout: Try to connect for ``timeout`` seconds.
            Not related to the timeout passed to ``UARTClient()``.
         """
diff --git a/adafruit_ble/uart_server.py b/adafruit_ble/uart_server.py
@@ -28,7 +28,7 @@
 * Author(s): Dan Halbert for Adafruit Industries
 
 """
-from bleio import Attribute, Characteristic, CharacteristicBuffer, Peripheral, Service
+from _bleio import Attribute, Characteristic, CharacteristicBuffer, Peripheral, Service
 from .advertising import ServerAdvertisement
 from .uart import NUS_SERVICE_UUID, NUS_RX_CHAR_UUID, NUS_TX_CHAR_UUID
 
diff --git a/adafruit_ble/uuid.py b/adafruit_ble/uuid.py
@@ -29,7 +29,7 @@
 
 """
 
-from bleio import UUID as bleio_UUID
+from _bleio import UUID as _bleio_UUID
 
-UUID = bleio_UUID
-"""`adafruit_ble.UUID` is the same as `bleio.UUID`"""
+UUID = _bleio_UUID
+"""`adafruit_ble.UUID` is the same as `_bleio.UUID`"""
diff --git a/docs/conf.py b/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 = ["bleio"]
+autodoc_mock_imports = ["_bleio"]
 
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
