diff options
| author | Dan Halbert <halbert@halwitz.org> | 2019-08-29 18:44:27 -0400 |
|---|---|---|
| committer | Dan Halbert <halbert@halwitz.org> | 2019-08-29 18:44:27 -0400 |
| commit | 7a64af92807f012828636c101f4350272f6e929a (patch) | |
| tree | eeaa8a7fc8b2eb32f9f6f639d2b1fb2282d1116e /shared-bindings | |
| parent | b11b7916fd9ed23aa80e8307f7a808b2bbff4f23 (diff) | |
rename bleio module to _bleio
Diffstat (limited to 'shared-bindings')
| -rw-r--r-- | shared-bindings/_bleio/Adapter.c (renamed from shared-bindings/bleio/Adapter.c) | 16 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Adapter.h (renamed from shared-bindings/bleio/Adapter.h) | 2 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Address.c (renamed from shared-bindings/bleio/Address.c) | 14 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Address.h (renamed from shared-bindings/bleio/Address.h) | 2 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Attribute.c (renamed from shared-bindings/bleio/Attribute.c) | 10 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Attribute.h (renamed from shared-bindings/bleio/Attribute.h) | 4 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Central.c (renamed from shared-bindings/bleio/Central.c) | 20 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Central.h (renamed from shared-bindings/bleio/Central.h) | 4 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Characteristic.c (renamed from shared-bindings/bleio/Characteristic.c) | 10 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Characteristic.h (renamed from shared-bindings/bleio/Characteristic.h) | 10 | ||||
| -rw-r--r-- | shared-bindings/_bleio/CharacteristicBuffer.c (renamed from shared-bindings/bleio/CharacteristicBuffer.c) | 8 | ||||
| -rw-r--r-- | shared-bindings/_bleio/CharacteristicBuffer.h (renamed from shared-bindings/bleio/CharacteristicBuffer.h) | 2 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Descriptor.c (renamed from shared-bindings/bleio/Descriptor.c) | 10 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Descriptor.h (renamed from shared-bindings/bleio/Descriptor.h) | 8 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Peripheral.c (renamed from shared-bindings/bleio/Peripheral.c) | 28 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Peripheral.h (renamed from shared-bindings/bleio/Peripheral.h) | 4 | ||||
| -rw-r--r-- | shared-bindings/_bleio/ScanEntry.c (renamed from shared-bindings/bleio/ScanEntry.c) | 14 | ||||
| -rw-r--r-- | shared-bindings/_bleio/ScanEntry.h (renamed from shared-bindings/bleio/ScanEntry.h) | 2 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Scanner.c (renamed from shared-bindings/bleio/Scanner.c) | 10 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Scanner.h (renamed from shared-bindings/bleio/Scanner.h) | 2 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Service.c (renamed from shared-bindings/bleio/Service.c) | 10 | ||||
| -rw-r--r-- | shared-bindings/_bleio/Service.h (renamed from shared-bindings/bleio/Service.h) | 4 | ||||
| -rw-r--r-- | shared-bindings/_bleio/UUID.c (renamed from shared-bindings/bleio/UUID.c) | 4 | ||||
| -rw-r--r-- | shared-bindings/_bleio/UUID.h (renamed from shared-bindings/bleio/UUID.h) | 2 | ||||
| -rw-r--r-- | shared-bindings/_bleio/__init__.c (renamed from shared-bindings/bleio/__init__.c) | 43 | ||||
| -rw-r--r-- | shared-bindings/_bleio/__init__.h (renamed from shared-bindings/bleio/__init__.h) | 6 |
26 files changed, 126 insertions, 123 deletions
diff --git a/shared-bindings/bleio/Adapter.c b/shared-bindings/_bleio/Adapter.c index 2bb7f3465..0caca96b8 100644 --- a/shared-bindings/bleio/Adapter.c +++ b/shared-bindings/_bleio/Adapter.c @@ -26,10 +26,10 @@ */ #include "py/objproperty.h" -#include "shared-bindings/bleio/Address.h" -#include "shared-bindings/bleio/Adapter.h" +#include "shared-bindings/_bleio/Address.h" +#include "shared-bindings/_bleio/Adapter.h" -//| .. currentmodule:: bleio +//| .. currentmodule:: _bleio //| //| :class:`Adapter` --- BLE adapter information //| ---------------------------------------------------- @@ -38,15 +38,15 @@ //| //| Usage:: //| -//| import bleio -//| bleio.adapter.enabled = True -//| print(bleio.adapter.address) +//| import _bleio +//| _bleio.adapter.enabled = True +//| print(_bleio.adapter.address) //| //| .. class:: Adapter() //| -//| You cannot create an instance of `bleio.Adapter`. -//| Use `bleio.adapter` to access the sole instance available. +//| You cannot create an instance of `_bleio.Adapter`. +//| Use `_bleio.adapter` to access the sole instance available. //| //| .. attribute:: adapter.enabled diff --git a/shared-bindings/bleio/Adapter.h b/shared-bindings/_bleio/Adapter.h index 72382616c..932fc9c95 100644 --- a/shared-bindings/bleio/Adapter.h +++ b/shared-bindings/_bleio/Adapter.h @@ -28,7 +28,7 @@ #ifndef MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_ADAPTER_H #define MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_ADAPTER_H -#include "shared-module/bleio/Address.h" +#include "shared-module/_bleio/Address.h" const mp_obj_type_t bleio_adapter_type; diff --git a/shared-bindings/bleio/Address.c b/shared-bindings/_bleio/Address.c index baeb6d7c0..cdee02b5d 100644 --- a/shared-bindings/bleio/Address.c +++ b/shared-bindings/_bleio/Address.c @@ -31,10 +31,10 @@ #include "py/objproperty.h" #include "py/objstr.h" #include "py/runtime.h" -#include "shared-bindings/bleio/Address.h" -#include "shared-module/bleio/Address.h" +#include "shared-bindings/_bleio/Address.h" +#include "shared-module/_bleio/Address.h" -//| .. currentmodule:: bleio +//| .. currentmodule:: _bleio //| //| :class:`Address` -- BLE address //| ========================================================= @@ -88,15 +88,15 @@ STATIC mp_obj_t bleio_address_make_new(const mp_obj_type_t *type, size_t n_args, //| Note that the ``bytes`` object returned is in little-endian order: //| The least significant byte is ``address_bytes[0]``. So the address will //| appear to be reversed if you print the raw ``bytes`` object. If you print -//| or use `str()` on the :py:class:`~bleio.Attribute` object itself, the address will be printed +//| or use `str()` on the :py:class:`~_bleio.Attribute` object itself, the address will be printed //| in the expected order. For example: //| //| .. code-block:: pycon //| -//| >>> import bleio -//| >>> bleio.adapter.address +//| >>> import _bleio +//| >>> _bleio.adapter.address //| <Address c8:1d:f5:ed:a8:35> -//| >>> bleio.adapter.address.address_bytes +//| >>> _bleio.adapter.address.address_bytes //| b'5\xa8\xed\xf5\x1d\xc8' //| STATIC mp_obj_t bleio_address_get_address_bytes(mp_obj_t self_in) { diff --git a/shared-bindings/bleio/Address.h b/shared-bindings/_bleio/Address.h index 5e02ee210..98b6f80e0 100644 --- a/shared-bindings/bleio/Address.h +++ b/shared-bindings/_bleio/Address.h @@ -29,7 +29,7 @@ #define MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_ADDRESS_H #include "py/objtype.h" -#include "shared-module/bleio/Address.h" +#include "shared-module/_bleio/Address.h" #define BLEIO_ADDRESS_TYPE_PUBLIC (0) #define BLEIO_ADDRESS_TYPE_RANDOM_STATIC (1) diff --git a/shared-bindings/bleio/Attribute.c b/shared-bindings/_bleio/Attribute.c index 2cc9ef6d0..2d8b15b9f 100644 --- a/shared-bindings/bleio/Attribute.c +++ b/shared-bindings/_bleio/Attribute.c @@ -26,24 +26,24 @@ #include "py/objproperty.h" #include "py/runtime.h" -#include "shared-bindings/bleio/Characteristic.h" -#include "shared-bindings/bleio/UUID.h" +#include "shared-bindings/_bleio/Characteristic.h" +#include "shared-bindings/_bleio/UUID.h" // -//| .. currentmodule:: bleio +//| .. currentmodule:: _bleio //| //| :class:`Attribute` -- BLE Attribute //| ========================================================= //| //| Definitions associated with all BLE attributes: characteristics, descriptors, etc. -//| :py:class:`~bleio.Attribute` is, notionally, a superclass of +//| :py:class:`~_bleio.Attribute` is, notionally, a superclass of //| :py:class:`~Characteristic` and :py:class:`~Descriptor`, //| but is not defined as a Python superclass of those classes. //| //| .. class:: Attribute() //| -//| You cannot create an instance of :py:class:`~bleio.Attribute`. +//| You cannot create an instance of :py:class:`~_bleio.Attribute`. //| STATIC const mp_rom_map_elem_t bleio_attribute_locals_dict_table[] = { diff --git a/shared-bindings/bleio/Attribute.h b/shared-bindings/_bleio/Attribute.h index 39bef5057..a0ce04500 100644 --- a/shared-bindings/bleio/Attribute.h +++ b/shared-bindings/_bleio/Attribute.h @@ -29,8 +29,8 @@ #include "py/obj.h" -#include "common-hal/bleio/Attribute.h" -#include "shared-module/bleio/Attribute.h" +#include "common-hal/_bleio/Attribute.h" +#include "shared-module/_bleio/Attribute.h" extern const mp_obj_type_t bleio_attribute_type; diff --git a/shared-bindings/bleio/Central.c b/shared-bindings/_bleio/Central.c index 1fc455d8d..084f40cd6 100644 --- a/shared-bindings/bleio/Central.c +++ b/shared-bindings/_bleio/Central.c @@ -34,13 +34,13 @@ #include "py/objproperty.h" #include "py/objstr.h" #include "py/runtime.h" -#include "shared-bindings/bleio/Adapter.h" -#include "shared-bindings/bleio/Address.h" -#include "shared-bindings/bleio/Characteristic.h" -#include "shared-bindings/bleio/Central.h" -#include "shared-bindings/bleio/Service.h" +#include "shared-bindings/_bleio/Adapter.h" +#include "shared-bindings/_bleio/Address.h" +#include "shared-bindings/_bleio/Characteristic.h" +#include "shared-bindings/_bleio/Central.h" +#include "shared-bindings/_bleio/Service.h" -//| .. currentmodule:: bleio +//| .. currentmodule:: _bleio //| //| :class:`Central` -- A BLE central device //| ========================================================= @@ -49,9 +49,9 @@ //| //| Usage:: //| -//| import bleio +//| import _bleio //| -//| scanner = bleio.Scanner() +//| scanner = _bleio.Scanner() //| entries = scanner.scan(2.5) //| //| my_entry = None @@ -63,7 +63,7 @@ //| if not my_entry: //| raise Exception("'InterestingPeripheral' not found") //| -//| central = bleio.Central() +//| central = _bleio.Central() //| central.connect(my_entry.address, 10) # timeout after 10 seconds //| remote_services = central.discover_remote_services() //| @@ -86,7 +86,7 @@ STATIC mp_obj_t bleio_central_make_new(const mp_obj_type_t *type, size_t n_args, //| .. method:: connect(address, timeout, *, service_uuids_whitelist=None) //| Attempts a connection to the remote peripheral. //| -//| :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. //| STATIC mp_obj_t bleio_central_connect(mp_uint_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) { diff --git a/shared-bindings/bleio/Central.h b/shared-bindings/_bleio/Central.h index cbc437087..85d788654 100644 --- a/shared-bindings/bleio/Central.h +++ b/shared-bindings/_bleio/Central.h @@ -29,8 +29,8 @@ #define MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_CENTRAL_H #include "py/objtuple.h" -#include "common-hal/bleio/Central.h" -#include "common-hal/bleio/Service.h" +#include "common-hal/_bleio/Central.h" +#include "common-hal/_bleio/Service.h" extern const mp_obj_type_t bleio_central_type; diff --git a/shared-bindings/bleio/Characteristic.c b/shared-bindings/_bleio/Characteristic.c index 41d81087c..198155589 100644 --- a/shared-bindings/bleio/Characteristic.c +++ b/shared-bindings/_bleio/Characteristic.c @@ -28,12 +28,12 @@ #include "py/objproperty.h" #include "py/runtime.h" -#include "shared-bindings/bleio/Attribute.h" -#include "shared-bindings/bleio/Characteristic.h" -#include "shared-bindings/bleio/Service.h" -#include "shared-bindings/bleio/UUID.h" +#include "shared-bindings/_bleio/Attribute.h" +#include "shared-bindings/_bleio/Characteristic.h" +#include "shared-bindings/_bleio/Service.h" +#include "shared-bindings/_bleio/UUID.h" -//| .. currentmodule:: bleio +//| .. currentmodule:: _bleio //| //| :class:`Characteristic` -- BLE service characteristic //| ========================================================= diff --git a/shared-bindings/bleio/Characteristic.h b/shared-bindings/_bleio/Characteristic.h index 52df87b36..a816c6050 100644 --- a/shared-bindings/bleio/Characteristic.h +++ b/shared-bindings/_bleio/Characteristic.h @@ -28,11 +28,11 @@ #ifndef MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_CHARACTERISTIC_H #define MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_CHARACTERISTIC_H -#include "shared-bindings/bleio/Attribute.h" -#include "shared-bindings/bleio/Descriptor.h" -#include "shared-module/bleio/Characteristic.h" -#include "common-hal/bleio/Characteristic.h" -#include "common-hal/bleio/Service.h" +#include "shared-bindings/_bleio/Attribute.h" +#include "shared-bindings/_bleio/Descriptor.h" +#include "shared-module/_bleio/Characteristic.h" +#include "common-hal/_bleio/Characteristic.h" +#include "common-hal/_bleio/Service.h" extern const mp_obj_type_t bleio_characteristic_type; diff --git a/shared-bindings/bleio/CharacteristicBuffer.c b/shared-bindings/_bleio/CharacteristicBuffer.c index 26f9e012b..9cc708eb7 100644 --- a/shared-bindings/bleio/CharacteristicBuffer.c +++ b/shared-bindings/_bleio/CharacteristicBuffer.c @@ -30,8 +30,8 @@ #include "py/runtime.h" #include "py/stream.h" -#include "shared-bindings/bleio/CharacteristicBuffer.h" -#include "shared-bindings/bleio/UUID.h" +#include "shared-bindings/_bleio/CharacteristicBuffer.h" +#include "shared-bindings/_bleio/UUID.h" #include "shared-bindings/util.h" STATIC void raise_error_if_not_connected(bleio_characteristic_buffer_obj_t *self) { @@ -40,7 +40,7 @@ STATIC void raise_error_if_not_connected(bleio_characteristic_buffer_obj_t *self } } -//| .. currentmodule:: bleio +//| .. currentmodule:: _bleio //| //| :class:`CharacteristicBuffer` -- BLE Service incoming values buffer. //| ===================================================================== @@ -52,7 +52,7 @@ STATIC void raise_error_if_not_connected(bleio_characteristic_buffer_obj_t *self //| Monitor the given Characteristic. Each time a new value is written to the Characteristic //| add the newly-written bytes to a FIFO buffer. //| -//| :param bleio.Characteristic characteristic: The Characteristic to monitor. +//| :param Characteristic characteristic: The Characteristic to monitor. //| It may be a local Characteristic provided by a Peripheral Service, or a remote Characteristic //| in a remote Service that a Central has connected to. //| :param int timeout: the timeout in seconds to wait for the first character and between subsequent characters. diff --git a/shared-bindings/bleio/CharacteristicBuffer.h b/shared-bindings/_bleio/CharacteristicBuffer.h index b45835ff3..83e6fef02 100644 --- a/shared-bindings/bleio/CharacteristicBuffer.h +++ b/shared-bindings/_bleio/CharacteristicBuffer.h @@ -27,7 +27,7 @@ #ifndef MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_CHARACTERISTICBUFFER_H #define MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_CHARACTERISTICBUFFER_H -#include "common-hal/bleio/CharacteristicBuffer.h" +#include "common-hal/_bleio/CharacteristicBuffer.h" extern const mp_obj_type_t bleio_characteristic_buffer_type; diff --git a/shared-bindings/bleio/Descriptor.c b/shared-bindings/_bleio/Descriptor.c index eba2ea1a8..0ab9fe8e9 100644 --- a/shared-bindings/bleio/Descriptor.c +++ b/shared-bindings/_bleio/Descriptor.c @@ -28,12 +28,12 @@ #include "py/objproperty.h" #include "py/runtime.h" -#include "shared-bindings/bleio/Attribute.h" -#include "shared-bindings/bleio/Characteristic.h" -#include "shared-bindings/bleio/Descriptor.h" -#include "shared-bindings/bleio/UUID.h" +#include "shared-bindings/_bleio/Attribute.h" +#include "shared-bindings/_bleio/Characteristic.h" +#include "shared-bindings/_bleio/Descriptor.h" +#include "shared-bindings/_bleio/UUID.h" -//| .. currentmodule:: bleio +//| .. currentmodule:: _bleio //| //| :class:`Descriptor` -- BLE descriptor //| ========================================================= diff --git a/shared-bindings/bleio/Descriptor.h b/shared-bindings/_bleio/Descriptor.h index d12ebaab9..7544bdb17 100644 --- a/shared-bindings/bleio/Descriptor.h +++ b/shared-bindings/_bleio/Descriptor.h @@ -28,10 +28,10 @@ #ifndef MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_DESCRIPTOR_H #define MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_DESCRIPTOR_H -#include "shared-module/bleio/Attribute.h" -#include "common-hal/bleio/Characteristic.h" -#include "common-hal/bleio/Descriptor.h" -#include "common-hal/bleio/UUID.h" +#include "shared-module/_bleio/Attribute.h" +#include "common-hal/_bleio/Characteristic.h" +#include "common-hal/_bleio/Descriptor.h" +#include "common-hal/_bleio/UUID.h" extern const mp_obj_type_t bleio_descriptor_type; diff --git a/shared-bindings/bleio/Peripheral.c b/shared-bindings/_bleio/Peripheral.c index 206f1c9a8..0bf292744 100644 --- a/shared-bindings/bleio/Peripheral.c +++ b/shared-bindings/_bleio/Peripheral.c @@ -35,14 +35,14 @@ #include "py/objstr.h" #include "py/runtime.h" -#include "shared-bindings/bleio/Adapter.h" -#include "shared-bindings/bleio/Characteristic.h" -#include "shared-bindings/bleio/Peripheral.h" -#include "shared-bindings/bleio/Service.h" -#include "shared-bindings/bleio/UUID.h" -#include "shared-module/bleio/ScanEntry.h" +#include "shared-bindings/_bleio/Adapter.h" +#include "shared-bindings/_bleio/Characteristic.h" +#include "shared-bindings/_bleio/Peripheral.h" +#include "shared-bindings/_bleio/Service.h" +#include "shared-bindings/_bleio/UUID.h" +#include "shared-module/_bleio/ScanEntry.h" -#include "common-hal/bleio/Peripheral.h" +#include "common-hal/_bleio/Peripheral.h" #define ADV_INTERVAL_MIN (0.0020f) #define ADV_INTERVAL_MIN_STRING "0.0020" @@ -51,7 +51,7 @@ // 20ms is recommended by Apple #define ADV_INTERVAL_DEFAULT (0.1f) -//| .. currentmodule:: bleio +//| .. currentmodule:: _bleio //| //| :class:`Peripheral` -- A BLE peripheral device //| ========================================================= @@ -61,18 +61,18 @@ //| //| Usage:: //| -//| from bleio import Characteristic, Peripheral, Service +//| from _bleio import Characteristic, Peripheral, Service //| from adafruit_ble.advertising import ServerAdvertisement //| //| # Create a peripheral and start it up. -//| peripheral = bleio.Peripheral() +//| peripheral = _bleio.Peripheral() //| //| # Create a Service and add it to this Peripheral. -//| service = Service.add_to_peripheral(peripheral, bleio.UUID(0x180f)) +//| service = Service.add_to_peripheral(peripheral, _bleio.UUID(0x180f)) //| //| # Create a Characteristic and add it to the Service. -//| characteristic = Characterist.add_to_service(service, -//| bleio.UUID(0x2919), properties=Characteristic.READ | Characteristic.NOTIFY) +//| characteristic = Characteristic.add_to_service(service, +//| _bleio.UUID(0x2919), properties=Characteristic.READ | Characteristic.NOTIFY) //| //| adv = ServerAdvertisement(peripheral) //| peripheral.start_advertising(adv.advertising_data_bytes, scan_response=adv.scan_response_bytes) @@ -86,7 +86,7 @@ //| Create a new Peripheral object. //| //| :param str name: The name used when advertising this peripheral. If name is None, -//| bleio.adapter.default_name will be used. +//| _bleio.adapter.default_name will be used. //| STATIC mp_obj_t bleio_peripheral_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) { enum { ARG_name }; diff --git a/shared-bindings/bleio/Peripheral.h b/shared-bindings/_bleio/Peripheral.h index a4bc9542b..bc56a9338 100644 --- a/shared-bindings/bleio/Peripheral.h +++ b/shared-bindings/_bleio/Peripheral.h @@ -29,8 +29,8 @@ #define MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_PERIPHERAL_H #include "py/objtuple.h" -#include "common-hal/bleio/Peripheral.h" -#include "common-hal/bleio/Service.h" +#include "common-hal/_bleio/Peripheral.h" +#include "common-hal/_bleio/Service.h" extern const mp_obj_type_t bleio_peripheral_type; diff --git a/shared-bindings/bleio/ScanEntry.c b/shared-bindings/_bleio/ScanEntry.c index 6eb02c716..bec380d03 100644 --- a/shared-bindings/bleio/ScanEntry.c +++ b/shared-bindings/_bleio/ScanEntry.c @@ -29,24 +29,24 @@ #include <string.h> #include "py/objproperty.h" -#include "shared-bindings/bleio/Address.h" -#include "shared-bindings/bleio/ScanEntry.h" -#include "shared-bindings/bleio/UUID.h" -#include "shared-module/bleio/ScanEntry.h" +#include "shared-bindings/_bleio/Address.h" +#include "shared-bindings/_bleio/ScanEntry.h" +#include "shared-bindings/_bleio/UUID.h" +#include "shared-module/_bleio/ScanEntry.h" -//| .. currentmodule:: bleio +//| .. currentmodule:: _bleio //| //| :class:`ScanEntry` -- BLE scan response entry //| ========================================================= //| //| Encapsulates information about a device that was received as a //| response to a BLE scan request. This object may only be created -//| by a `bleio.Scanner`: it has no user-visible constructor. +//| by a `_bleio.Scanner`: it has no user-visible constructor. //| //| .. attribute:: address //| -//| The address of the device (read-only), of type `bleio.Address`. +//| The address of the device (read-only), of type `_bleio.Address`. //| STATIC mp_obj_t bleio_scanentry_get_address(mp_obj_t self_in) { bleio_scanentry_obj_t *self = MP_OBJ_TO_PTR(self_in); diff --git a/shared-bindings/bleio/ScanEntry.h b/shared-bindings/_bleio/ScanEntry.h index 77e93175f..8af1f050a 100644 --- a/shared-bindings/bleio/ScanEntry.h +++ b/shared-bindings/_bleio/ScanEntry.h @@ -30,7 +30,7 @@ #define MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_SCANENTRY_H #include "py/obj.h" -#include "shared-module/bleio/ScanEntry.h" +#include "shared-module/_bleio/ScanEntry.h" extern const mp_obj_type_t bleio_scanentry_type; diff --git a/shared-bindings/bleio/Scanner.c b/shared-bindings/_bleio/Scanner.c index 269c42591..94cec9752 100644 --- a/shared-bindings/bleio/Scanner.c +++ b/shared-bindings/_bleio/Scanner.c @@ -27,8 +27,8 @@ #include "py/objproperty.h" #include "py/runtime.h" -#include "shared-bindings/bleio/ScanEntry.h" -#include "shared-bindings/bleio/Scanner.h" +#include "shared-bindings/_bleio/ScanEntry.h" +#include "shared-bindings/_bleio/Scanner.h" #define INTERVAL_DEFAULT (0.1f) #define INTERVAL_MIN (0.0025f) @@ -37,7 +37,7 @@ #define INTERVAL_MAX_STRING "40.959375" #define WINDOW_DEFAULT (0.1f) -//| .. currentmodule:: bleio +//| .. currentmodule:: _bleio //| //| :class:`Scanner` -- scan for nearby BLE devices //| ========================================================= @@ -46,8 +46,8 @@ //| //| Usage:: //| -//| import bleio -//| scanner = bleio.Scanner() +//| import _bleio +//| scanner = _bleio.Scanner() //| entries = scanner.scan(2.5) # Scan for 2.5 seconds //| diff --git a/shared-bindings/bleio/Scanner.h b/shared-bindings/_bleio/Scanner.h index 3a0ce7eae..cbaa77866 100644 --- a/shared-bindings/bleio/Scanner.h +++ b/shared-bindings/_bleio/Scanner.h @@ -29,7 +29,7 @@ #define MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_SCANNER_H #include "py/objtype.h" -#include "common-hal/bleio/Scanner.h" +#include "common-hal/_bleio/Scanner.h" extern const mp_obj_type_t bleio_scanner_type; diff --git a/shared-bindings/bleio/Service.c b/shared-bindings/_bleio/Service.c index f3bfebb7b..da5633f2a 100644 --- a/shared-bindings/bleio/Service.c +++ b/shared-bindings/_bleio/Service.c @@ -28,12 +28,12 @@ #include "py/objproperty.h" #include "py/runtime.h" -#include "shared-bindings/bleio/Characteristic.h" -#include "shared-bindings/bleio/Peripheral.h" -#include "shared-bindings/bleio/Service.h" -#include "shared-bindings/bleio/UUID.h" +#include "shared-bindings/_bleio/Characteristic.h" +#include "shared-bindings/_bleio/Peripheral.h" +#include "shared-bindings/_bleio/Service.h" +#include "shared-bindings/_bleio/UUID.h" -//| .. currentmodule:: bleio +//| .. currentmodule:: _bleio //| //| :class:`Service` -- BLE service //| ========================================================= diff --git a/shared-bindings/bleio/Service.h b/shared-bindings/_bleio/Service.h index ce4e51417..e061bcffc 100644 --- a/shared-bindings/bleio/Service.h +++ b/shared-bindings/_bleio/Service.h @@ -28,8 +28,8 @@ #ifndef MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_SERVICE_H #define MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_SERVICE_H -#include "common-hal/bleio/Peripheral.h" -#include "common-hal/bleio/Service.h" +#include "common-hal/_bleio/Peripheral.h" +#include "common-hal/_bleio/Service.h" const mp_obj_type_t bleio_service_type; diff --git a/shared-bindings/bleio/UUID.c b/shared-bindings/_bleio/UUID.c index dca7ea010..3c0889aad 100644 --- a/shared-bindings/bleio/UUID.c +++ b/shared-bindings/_bleio/UUID.c @@ -31,9 +31,9 @@ #include "py/objproperty.h" #include "py/objstr.h" #include "py/runtime.h" -#include "shared-bindings/bleio/UUID.h" +#include "shared-bindings/_bleio/UUID.h" -//| .. currentmodule:: bleio +//| .. currentmodule:: _bleio //| //| :class:`UUID` -- BLE UUID //| ========================================================= diff --git a/shared-bindings/bleio/UUID.h b/shared-bindings/_bleio/UUID.h index caf039aec..46ac54ff3 100644 --- a/shared-bindings/bleio/UUID.h +++ b/shared-bindings/_bleio/UUID.h @@ -28,7 +28,7 @@ #ifndef MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_UUID_H #define MICROPY_INCLUDED_SHARED_BINDINGS_BLEIO_UUID_H -#include "common-hal/bleio/UUID.h" +#include "common-hal/_bleio/UUID.h" void bleio_uuid_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind); diff --git a/shared-bindings/bleio/__init__.c b/shared-bindings/_bleio/__init__.c index 739f461a5..f207be8cf 100644 --- a/shared-bindings/bleio/__init__.c +++ b/shared-bindings/_bleio/__init__.c @@ -26,30 +26,33 @@ * THE SOFTWARE. */ -#include "shared-bindings/bleio/__init__.h" -#include "shared-bindings/bleio/Address.h" -#include "shared-bindings/bleio/Attribute.h" -#include "shared-bindings/bleio/Central.h" -#include "shared-bindings/bleio/Characteristic.h" -#include "shared-bindings/bleio/CharacteristicBuffer.h" -#include "shared-bindings/bleio/Descriptor.h" -#include "shared-bindings/bleio/Peripheral.h" -#include "shared-bindings/bleio/ScanEntry.h" -#include "shared-bindings/bleio/Scanner.h" -#include "shared-bindings/bleio/Service.h" -#include "shared-bindings/bleio/UUID.h" +#include "shared-bindings/_bleio/__init__.h" +#include "shared-bindings/_bleio/Address.h" +#include "shared-bindings/_bleio/Attribute.h" +#include "shared-bindings/_bleio/Central.h" +#include "shared-bindings/_bleio/Characteristic.h" +#include "shared-bindings/_bleio/CharacteristicBuffer.h" +#include "shared-bindings/_bleio/Descriptor.h" +#include "shared-bindings/_bleio/Peripheral.h" +#include "shared-bindings/_bleio/ScanEntry.h" +#include "shared-bindings/_bleio/Scanner.h" +#include "shared-bindings/_bleio/Service.h" +#include "shared-bindings/_bleio/UUID.h" -//| :mod:`bleio` --- Bluetooth Low Energy (BLE) communication +//| :mod:`_bleio` --- Bluetooth Low Energy (BLE) communication //| ================================================================ //| -//| .. module:: bleio +//| .. module:: _bleio //| :synopsis: Bluetooth Low Energy functionality //| :platform: nRF //| -//| The `bleio` module provides necessary low-level functionality for communicating -//| using Bluetooth Low Energy (BLE). We recommend you use `bleio` in conjunction -//| with the `adafruit_ble <https://circuitpython.readthedocs.io/projects/ble/en/latest/>`_ -//| CircuitPython library, which builds on `bleio`, and +//| 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. //| @@ -75,11 +78,11 @@ //| //| BLE Adapter information, such as enabled state as well as MAC //| address. -//| This object is the sole instance of `bleio.Adapter`. +//| 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___name__), MP_ROM_QSTR(MP_QSTR__bleio) }, { 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_Central), MP_ROM_PTR(&bleio_central_type) }, diff --git a/shared-bindings/bleio/__init__.h b/shared-bindings/_bleio/__init__.h index c84895068..67379ae2e 100644 --- a/shared-bindings/bleio/__init__.h +++ b/shared-bindings/_bleio/__init__.h @@ -31,10 +31,10 @@ #include "py/objlist.h" -#include "shared-bindings/bleio/Adapter.h" +#include "shared-bindings/_bleio/Adapter.h" -#include "common-hal/bleio/__init__.h" -#include "common-hal/bleio/Adapter.h" +#include "common-hal/_bleio/__init__.h" +#include "common-hal/_bleio/Adapter.h" extern const super_adapter_obj_t common_hal_bleio_adapter_obj; |
