fix doc build; fix advertising; new examples; a few bugs

Author: dhalbert

adafruit_ble_adafruit/adafruit_service.py

@@ -64,11 +64,16 @@
 
 class AdafruitServerAdvertisement(Advertisement):
     """Advertise the Adafruit company ID and the board USB PID.
-
-    :param pid: The USB PID (product id) for this board
     """
 
-    prefix = struct.pack("<BBH", 0x3, _MANUFACTURING_DATA_ADT, _ADAFRUIT_COMPANY_ID)
+    prefix = struct.pack(
+        "<BBHBH",
+        0x6,
+        _MANUFACTURING_DATA_ADT,
+        _ADAFRUIT_COMPANY_ID,
+        struct.calcsize("<HH"),
+        _PID_DATA_ID,
+    )
     manufacturer_data = LazyObjectField(
         ManufacturerData,
         "manufacturer_data",
@@ -77,13 +82,17 @@ class AdafruitServerAdvertisement(Advertisement):
         key_encoding="<H",
     )
     pid = ManufacturerDataField(_PID_DATA_ID, "<H")
+    """The USB PID (product id) for this board."""
 
-    def __init__(self, pid):
+    def __init__(self):
         super().__init__()
         self.connectable = True
         self.flags.general_discovery = True
         self.flags.le_only = True
-        self.pid = pid
+
+    @classmethod
+    def matches(cls, entry):
+        return entry.matches(cls.prefix, all=False)
 
 
 class AdafruitService(Service):

adafruit_ble_adafruit/color_sensor.py renamed to adafruit_ble_adafruit/color_sensor_service.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`adafruit_ble_adafruit.humdity_service`
+`adafruit_ble_adafruit.humidity_service`
 ================================================================================
 
 BLE access to humidity data.

adafruit_ble_adafruit/humidity_service.py

@@ -56,11 +56,11 @@ class QuaternionService(AdafruitService):  # pylint: disable=too-few-public-meth
         properties=(Characteristic.READ | Characteristic.NOTIFY),
         write_perm=Attribute.NO_ACCESS,
     )
-    """9-tuple of floats sent to client for calibration calculation:
-    (acceleration x, y, z,  # in m/s^2
-     gyro x, y, z,   # in rad/s
-     magnetic x, y, z,   # in microteslas
-    )
+    """
+    9-tuple of floats sent to client for calibration calculation:
+    acceleration x, y, z,  # in m/s^2
+    gyro x, y, z,   # in rad/s
+    magnetic x, y, z,   # in microteslas
     """
 
     calibration_out = StructCharacteristic(
@@ -69,13 +69,13 @@ class QuaternionService(AdafruitService):  # pylint: disable=too-few-public-meth
         properties=(Characteristic.WRITE),
         read_perm=Attribute.NO_ACCESS,
     )
-    """19-tuple of floats sent back to server after calibration calculation
-    (acceleration_zerog x, y, z,  # in m/s^2
-     gyro_zerorate x, y, z,   # in rad/s
-     magnetic_hardiron x, y, z,   # in microteslas
-     magnetic_field f,  # in microteslas
-     magnetic_softiron v1, v2, v3, v4, v5, v6, v7, v8, v9,   # unitless
-    )
+    """
+    19-tuple of floats sent back to server after calibration calculation:
+    acceleration_zerog x, y, z,  # in m/s^2
+    gyro_zerorate x, y, z,   # in rad/s
+    magnetic_hardiron x, y, z,   # in microteslas
+    magnetic_field f,  # in microteslas
+    magnetic_softiron v1, v2, v3, v4, v5, v6, v7, v8, v9,   # unitless
     """
 
     # TO DO: Calibration calculations and storage

adafruit_ble_adafruit/quaternion_service.py

@@ -1,2 +1,49 @@
-.. automodule:: adafruit_ble_adafruit
+.. If you created a package, create one automodule per module in the package.
+
+.. automodule:: adafruit_ble_adafruit.accelerometer_service
+   :members:
+
+.. automodule:: adafruit_ble_adafruit.adafruit_service
+   :members:
+
+.. automodule:: adafruit_ble_adafruit.addressable_pixel_service
+   :members:
+
+.. automodule:: adafruit_ble_adafruit.barometric_pressure_service
+   :members:
+
+.. automodule:: adafruit_ble_adafruit.button_service
+   :members:
+
+.. automodule:: adafruit_ble_adafruit.color_sensor_service
+   :members:
+
+.. automodule:: adafruit_ble_adafruit.gesture_service
+   :members:
+
+.. automodule:: adafruit_ble_adafruit.gyroscope_service
+   :members:
+
+.. automodule:: adafruit_ble_adafruit.humidity_service
+   :members:
+
+.. automodule:: adafruit_ble_adafruit.light_sensor_service
+   :members:
+
+.. automodule:: adafruit_ble_adafruit.magnetometer_service
+   :members:
+
+.. automodule:: adafruit_ble_adafruit.microphone_service
+   :members:
+
+.. automodule:: adafruit_ble_adafruit.proximity_service
+   :members:
+
+.. automodule:: adafruit_ble_adafruit.quaternion_service
+   :members:
+
+.. automodule:: adafruit_ble_adafruit.temperature_service
+   :members:
+
+.. automodule:: adafruit_ble_adafruit.tone_service
    :members:

docs/api.rst

@@ -17,22 +17,10 @@
     "sphinx.ext.todo",
 ]
 
-# TODO: Please Read!
 # 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",
-    "adafruit_ble_adafruit",
-    "board",
-    "digitalio",
-    "busio",
-    "ulab",
-    "micropython",
-    "adafruit_clue",
-    "neopixel_write",
-    "adafruit_circuitplayground",
-]
+autodoc_mock_imports = ["microcontroller"]
 
 
 intersphinx_mapping = {

docs/conf.py

@@ -56,7 +56,8 @@
 # in the advertisement. That data uses the USB PID as a unique ID.
 # Adafruit Circuit Playground Bluefruit USB PID:
 # Arduino: 0x8045,  CircuitPython: 0x8046, app supports either
-adv = AdafruitServerAdvertisement(0x8046)
+adv = AdafruitServerAdvertisement()
+adv.pin = 0x8046
 
 while True:
     # Advertise when not connected.

examples/ble_adafruit_circuitplayground_bluefruit.py

@@ -76,7 +76,8 @@
 # in the advertisement. That data uses the USB PID as a unique ID.
 # Adafruit CLUE USB PID:
 # Arduino: 0x8071,  CircuitPython: 0x8072, app supports either
-adv = AdafruitServerAdvertisement(0x8072)
+adv = AdafruitServerAdvertisement()
+adv.pin = 0x8072
 
 while True:
     # Advertise when not connected.

examples/ble_adafruit_clue.py

@@ -1,4 +1,5 @@
-# Bluefruit Playground server program, to run on CLUE
+# Bluefruit Playground and Web Bluetooth Dashboard server program, to
+# run on Feather Bluefruit Sense
 
 import time
 
@@ -95,7 +96,8 @@
 # Feather Bluefruit Sense USB PID:
 # This board is not yet support on the app.
 # Arduino: 0x8087,  CircuitPython: 0x8088
-adv = AdafruitServerAdvertisement(0x8088)
+adv = AdafruitServerAdvertisement()
+adv.pin = 0x8088
 
 while True:
     # Advertise when not connected.

examples/ble_adafruit_feather_bluefruit_sense.py

@@ -0,0 +1,39 @@
+# Use with Web Bluetooth Dashboard, or with ble_adafruit_simpletest_client.py
+
+import time
+
+import microcontroller
+
+from adafruit_ble import BLERadio
+
+from adafruit_ble_adafruit.adafruit_service import AdafruitServerAdvertisement
+from adafruit_ble_adafruit.temperature_service import TemperatureService
+
+temp_svc = TemperatureService()
+temp_svc.measurement_period = 100
+temp_last_update = 0
+
+ble = BLERadio()
+
+# Unknown USB PID, since we don't know what board we're on
+adv = AdafruitServerAdvertisement()
+adv.pid = 0x0000
+
+while True:
+    # Advertise when not connected.
+    print(adv)
+    print(bytes(adv))
+    ble.start_advertising(adv)
+    while not ble.connected:
+        pass
+    ble.stop_advertising()
+
+    while ble.connected:
+        now_msecs = time.monotonic_ns() // 1000000  # pylint: disable=no-member
+
+        if now_msecs - temp_last_update >= temp_svc.measurement_period:
+            temp_svc.temperature = (
+                microcontroller.cpu.temperature  # pylint: disable=no-member
+            )
+
+            temp_last_update = now_msecs

examples/ble_adafruit_simpletest.py

@@ -0,0 +1,26 @@
+import time
+
+import adafruit_ble
+from adafruit_ble_adafruit.adafruit_service import AdafruitServerAdvertisement
+from adafruit_ble_adafruit.temperature_service import TemperatureService
+
+# PyLint can't find BLERadio for some reason so special case it here.
+ble = adafruit_ble.BLERadio()  # pylint: disable=no-member
+
+connection = None
+
+while True:
+    print("Scanning for an Adafruit Server advertisement...")
+    for adv in ble.start_scan(AdafruitServerAdvertisement, timeout=5):
+        connection = ble.connect(adv)
+        print("Connected")
+        break
+
+    # Stop scanning whether or not we are connected.
+    ble.stop_scan()
+
+    if connection and connection.connected:
+        temp_service = connection[TemperatureService]
+        while connection.connected:
+            print("Temperature:", temp_service.temperature)
+            time.sleep(1)

examples/ble_adafruit_simpletest_client.py

@@ -21,7 +21,7 @@
     name="adafruit-circuitpython-ble-adafruit",
     use_scm_version=True,
     setup_requires=["setuptools_scm"],
-    description="Description ",
+    description="Access to sensors and hardware on or connected to BLE-capable boards",
     long_description=long_description,
     long_description_content_type="text/x-rst",
     # The project's main homepage.
@@ -47,7 +47,5 @@
     keywords="adafruit blinka circuitpython micropython circuitplayground bluefruit CLUE ble",
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
-    # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
-    #       CHANGE `py_modules=['...']` TO `packages=['...']`
     packages=["adafruit_ble_adafruit"],
 )