ae30a1e5aa
This PR refines the _bleio API. It was originally motivated by the addition of a new CircuitPython service that enables reading and modifying files on the device. Moving the BLE lifecycle outside of the VM motivated a number of changes to remove heap allocations in some APIs. It also motivated unifying connection initiation to the Adapter class rather than the Central and Peripheral classes which have been removed. Adapter now handles the GAP portion of BLE including advertising, which has moved but is largely unchanged, and scanning, which has been enhanced to return an iterator of filtered results. Once a connection is created (either by us (aka Central) or a remote device (aka Peripheral)) it is represented by a new Connection class. This class knows the current connection state and can discover and instantiate remote Services along with their Characteristics and Descriptors. Relates to #586
105 lines
4.4 KiB
C
105 lines
4.4 KiB
C
/*
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2019 Dan Halbert for Adafruit Industries
|
|
* Copyright (c) 2018 Artur Pacholec
|
|
* Copyright (c) 2016 Glenn Ruben Bakke
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
#include "shared-bindings/_bleio/__init__.h"
|
|
#include "shared-bindings/_bleio/Address.h"
|
|
#include "shared-bindings/_bleio/Attribute.h"
|
|
#include "shared-bindings/_bleio/Characteristic.h"
|
|
#include "shared-bindings/_bleio/CharacteristicBuffer.h"
|
|
#include "shared-bindings/_bleio/Connection.h"
|
|
#include "shared-bindings/_bleio/Descriptor.h"
|
|
#include "shared-bindings/_bleio/ScanEntry.h"
|
|
#include "shared-bindings/_bleio/ScanResults.h"
|
|
#include "shared-bindings/_bleio/Service.h"
|
|
#include "shared-bindings/_bleio/UUID.h"
|
|
|
|
//| :mod:`_bleio` --- Bluetooth Low Energy (BLE) communication
|
|
//| ================================================================
|
|
//|
|
|
//| .. module:: _bleio
|
|
//| :synopsis: Bluetooth Low Energy functionality
|
|
//| :platform: nRF
|
|
//|
|
|
//| The `_bleio` module provides necessary low-level functionality for communicating
|
|
//| using Bluetooth Low Energy (BLE). The '_' prefix indicates this module is meant
|
|
//| for internal use by libraries but not by the end user. Its API may change incompatibly
|
|
//| between minor versions of CircuitPython.
|
|
//| Please use the
|
|
//| `adafruit_ble <https://circuitpython.readthedocs.io/projects/ble/en/latest/>`_
|
|
//| CircuitPython library instead, which builds on `_bleio`, and
|
|
//| provides higher-level convenience functionality, including predefined beacons, clients,
|
|
//| servers.
|
|
//|
|
|
//| Libraries
|
|
//|
|
|
//| .. toctree::
|
|
//| :maxdepth: 3
|
|
//|
|
|
//| Address
|
|
//| Adapter
|
|
//| Attribute
|
|
//| Characteristic
|
|
//| CharacteristicBuffer
|
|
//| Connection
|
|
//| Descriptor
|
|
//| ScanEntry
|
|
//| ScanResults
|
|
//| Service
|
|
//| UUID
|
|
//|
|
|
//| .. attribute:: adapter
|
|
//|
|
|
//| BLE Adapter used to manage device discovery and connections.
|
|
//| This object is the sole instance of `_bleio.Adapter`.
|
|
//|
|
|
|
|
STATIC const mp_rom_map_elem_t bleio_module_globals_table[] = {
|
|
{ MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR__bleio) },
|
|
{ MP_ROM_QSTR(MP_QSTR_Adapter), MP_ROM_PTR(&bleio_adapter_type) },
|
|
{ MP_ROM_QSTR(MP_QSTR_Address), MP_ROM_PTR(&bleio_address_type) },
|
|
{ MP_ROM_QSTR(MP_QSTR_Attribute), MP_ROM_PTR(&bleio_attribute_type) },
|
|
{ MP_ROM_QSTR(MP_QSTR_Connection), MP_ROM_PTR(&bleio_connection_type) },
|
|
{ MP_ROM_QSTR(MP_QSTR_Characteristic), MP_ROM_PTR(&bleio_characteristic_type) },
|
|
{ MP_ROM_QSTR(MP_QSTR_CharacteristicBuffer), MP_ROM_PTR(&bleio_characteristic_buffer_type) },
|
|
{ MP_ROM_QSTR(MP_QSTR_Descriptor), MP_ROM_PTR(&bleio_descriptor_type) },
|
|
{ MP_ROM_QSTR(MP_QSTR_ScanEntry), MP_ROM_PTR(&bleio_scanentry_type) },
|
|
{ MP_ROM_QSTR(MP_QSTR_ScanResults), MP_ROM_PTR(&bleio_scanresults_type) },
|
|
{ MP_ROM_QSTR(MP_QSTR_Service), MP_ROM_PTR(&bleio_service_type) },
|
|
{ MP_ROM_QSTR(MP_QSTR_UUID), MP_ROM_PTR(&bleio_uuid_type) },
|
|
|
|
// Properties
|
|
{ MP_ROM_QSTR(MP_QSTR_adapter), MP_ROM_PTR(&common_hal_bleio_adapter_obj) },
|
|
};
|
|
|
|
STATIC MP_DEFINE_CONST_DICT(bleio_module_globals, bleio_module_globals_table);
|
|
|
|
const mp_obj_module_t bleio_module = {
|
|
.base = { &mp_type_module },
|
|
.globals = (mp_obj_dict_t*)&bleio_module_globals,
|
|
};
|