adafruit / adafruit_circuitpython_ble_apple_notification_center

BLE library for the Apple Notification Center on iOS

Introduction

BLE library for the Apple Notification Center

Dependencies

This driver depends on:

• Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

Note

This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-ble-apple-notification-center

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-ble-apple-notification-center

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-ble-apple-notification-center

Usage Example

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

adafruit_circuitpython_ble_apple_notification_center's Issues

Non Implemented Error

When running the example code the error message below shows up.

"NotImplementedError: Advertising not implemented"

I am attempting to run this code on a RaspberryPi 4B.

esp32c3 board compatibility

Hi,
I'm trying to run one of the examples (ble_apple_notification_center_simpletest.py) on a xiao esp32c3 board and I get this error:

code.py output: Waiting for connection Connected Traceback (most recent call last): File "code.py", line 27, in <module> File "adafruit_ble/__init__.py", line 91, in __contains__ File "adafruit_ble/__init__.py", line 68, in _discover_remote _bleio.BluetoothError: Unknown BLE error: 7
Board:
Seeed Studio XIAO ESP32C3
Version:
Circuit Python: 8.1.0

Is the 'adafruit_ble' library only compatible on adafruit's boards?

Missing Type Annotations

There are missing type annotations for some functions in this library.

The typing module does not exist on CircuitPython devices so the import needs to be wrapped in try/except to catch the error for missing import. There is an example of how that is done here:

try:
    from typing import List, Tuple
except ImportError:
    pass

Once imported the typing annotations for the argument type(s), and return type(s) can be added to the function signature. Here is an example of a function that has had this done already:

def wrap_text_to_pixels(
    string: str, max_width: int, font=None, indent0: str = "", indent1: str = ""
) -> List[str]:

If you are new to Git or Github we have a guide about contributing to our projects here: https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github

There is also a guide that covers our CI utilities and how to run them locally to ensure they will pass in Github Actions here: https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/check-your-code In particular the pages: Sharing docs on ReadTheDocs and Check your code with pre-commit contain the tools to install and commands to run locally to run the checks.

If you are attempting to resolve this issue and need help, you can post a comment on this issue and tag both @FoamyGuy and @kattni or reach out to us on Discord: https://adafru.it/discord in the #circuitpython-dev channel.

The following locations are reported by mypy to be missing type annotations:

• adafruit_ble_apple_notification_center.py:32
• adafruit_ble_apple_notification_center.py:36
• adafruit_ble_apple_notification_center.py:104
• adafruit_ble_apple_notification_center.py:143
• adafruit_ble_apple_notification_center.py:209
• adafruit_ble_apple_notification_center.py:240

Reconnect error on Feather nRF52840 Express

I am running the sample "ble_apple_notification_center_new.py" on a Feather nRF52840 Express. The code runs without issue until I try reconnecting after:

1. I lose bluetooth signal
   or
2. I restart my phone.

This is the exception that is thrown when trying to reconnect after restarting the script:
Traceback (most recent call last):
File "code.py", line 33, in
File "adafruit_ble/init.py", line 88, in getitem
File "adafruit_ble/init.py", line 52, in _discover_remote
ConnectionError: Connection has been disconnected and can no longer be used. Create a new connection.

Restarting the script does not help. Disabling / Re-enabling bluetooth does not help.

I have reproduced the issue using:
CircuitPython - 6.3.0
CircuitPython - 7.0.0-alpha.6
iOS 14.7
iOS 15 Public Beta 5

The only temporary solution I have found so far is to unpair/re-pair the feather via iOS. This solves the issue until the next disconnect occurs.