summaryrefslogtreecommitdiff
path: root/shared-bindings/_bleio
diff options
context:
space:
mode:
Diffstat (limited to 'shared-bindings/_bleio')
-rw-r--r--shared-bindings/_bleio/Adapter.c5
-rw-r--r--shared-bindings/_bleio/Address.c9
-rw-r--r--shared-bindings/_bleio/Attribute.c6
-rw-r--r--shared-bindings/_bleio/Characteristic.c9
-rw-r--r--shared-bindings/_bleio/CharacteristicBuffer.c7
-rw-r--r--shared-bindings/_bleio/Connection.c14
-rw-r--r--shared-bindings/_bleio/Descriptor.c6
-rw-r--r--shared-bindings/_bleio/PacketBuffer.c26
-rw-r--r--shared-bindings/_bleio/ScanEntry.c9
-rw-r--r--shared-bindings/_bleio/ScanResults.c7
-rw-r--r--shared-bindings/_bleio/Service.c7
-rw-r--r--shared-bindings/_bleio/UUID.c9
-rw-r--r--shared-bindings/_bleio/__init__.c26
13 files changed, 29 insertions, 111 deletions
diff --git a/shared-bindings/_bleio/Adapter.c b/shared-bindings/_bleio/Adapter.c
index 6fb5c323d..4816294f7 100644
--- a/shared-bindings/_bleio/Adapter.c
+++ b/shared-bindings/_bleio/Adapter.c
@@ -48,10 +48,7 @@
#define WINDOW_DEFAULT (0.1f)
//| class Adapter:
-//| """.. currentmodule:: _bleio
-//|
-//| :class:`Adapter` --- BLE adapter
-//| ----------------------------------------------------
+//| """BLE adapter
//|
//| The Adapter manages the discovery and connection to other nearby Bluetooth Low Energy devices.
//| This part of the Bluetooth Low Energy Specification is known as Generic Access Profile (GAP).
diff --git a/shared-bindings/_bleio/Address.c b/shared-bindings/_bleio/Address.c
index 2071bd3b2..ccbab1b9d 100644
--- a/shared-bindings/_bleio/Address.c
+++ b/shared-bindings/_bleio/Address.c
@@ -35,12 +35,7 @@
#include "shared-module/_bleio/Address.h"
//| class Address:
-//| """.. currentmodule:: _bleio
-//|
-//| :class:`Address` -- BLE address
-//| =========================================================
-//|
-//| Encapsulates the address of a BLE device."""
+//| """Encapsulates the address of a BLE device."""
//|
//| def __init__(self, address: buf, address_type: Any):
@@ -97,7 +92,7 @@ STATIC mp_obj_t bleio_address_make_new(const mp_obj_type_t *type, size_t n_args,
//| >>> _bleio.adapter.address
//| <Address c8:1d:f5:ed:a8:35>
//| >>> _bleio.adapter.address.address_bytes
-//| b'5\xa8\xed\xf5\x1d\xc8'"""
+//| b'5\\xa8\\xed\\xf5\\x1d\\xc8'"""
//|
STATIC mp_obj_t bleio_address_get_address_bytes(mp_obj_t self_in) {
bleio_address_obj_t *self = MP_OBJ_TO_PTR(self_in);
diff --git a/shared-bindings/_bleio/Attribute.c b/shared-bindings/_bleio/Attribute.c
index 72fd13d1c..6c47c87ba 100644
--- a/shared-bindings/_bleio/Attribute.c
+++ b/shared-bindings/_bleio/Attribute.c
@@ -30,12 +30,8 @@
#include "shared-bindings/_bleio/UUID.h"
//| class Attribute:
-//| """.. currentmodule:: _bleio
+//| """Definitions associated with all BLE attributes: characteristics, descriptors, etc.
//|
-//| :class:`Attribute` -- BLE Attribute
-//| =========================================================
-//|
-//| Definitions associated with all BLE attributes: characteristics, descriptors, etc.
//| :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."""
diff --git a/shared-bindings/_bleio/Characteristic.c b/shared-bindings/_bleio/Characteristic.c
index f8f18d0bd..785b677d6 100644
--- a/shared-bindings/_bleio/Characteristic.c
+++ b/shared-bindings/_bleio/Characteristic.c
@@ -34,13 +34,8 @@
#include "shared-bindings/_bleio/UUID.h"
//| class Characteristic:
-//| """.. currentmodule:: _bleio
-//|
-//| :class:`Characteristic` -- BLE service characteristic
-//| =========================================================
-//|
-//| Stores information about a BLE service characteristic and allows reading
-//| and writing of the characteristic's value."""
+//| """Stores information about a BLE service characteristic and allows reading
+//| and writing of the characteristic's value."""
//|
//| def __init__(self, ):
//| """There is no regular constructor for a Characteristic. A new local Characteristic can be created
diff --git a/shared-bindings/_bleio/CharacteristicBuffer.c b/shared-bindings/_bleio/CharacteristicBuffer.c
index f38f650d9..6cbd587c6 100644
--- a/shared-bindings/_bleio/CharacteristicBuffer.c
+++ b/shared-bindings/_bleio/CharacteristicBuffer.c
@@ -42,12 +42,7 @@ STATIC void raise_error_if_not_connected(bleio_characteristic_buffer_obj_t *self
}
//| class CharacteristicBuffer:
-//| """.. currentmodule:: _bleio
-//|
-//| :class:`CharacteristicBuffer` -- BLE Service incoming values buffer.
-//| =====================================================================
-//|
-//| Accumulates a Characteristic's incoming values in a FIFO buffer."""
+//| """Accumulates a Characteristic's incoming values in a FIFO buffer."""
//|
//| def __init__(self, characteristic: Characteristic, *, timeout: int = 1, buffer_size: int = 64):
//|
diff --git a/shared-bindings/_bleio/Connection.c b/shared-bindings/_bleio/Connection.c
index 93600e76d..0a96d8a11 100644
--- a/shared-bindings/_bleio/Connection.c
+++ b/shared-bindings/_bleio/Connection.c
@@ -43,12 +43,7 @@
#include "shared-bindings/_bleio/Service.h"
//| class Connection:
-//| """.. currentmodule:: _bleio
-//|
-//| :class:`Connection` -- A BLE connection
-//| =========================================================
-//|
-//| A BLE connection to another device. Used to discover and interact with services on the other
+//| """A BLE connection to another device. Used to discover and interact with services on the other
//| device.
//|
//| Usage::
@@ -211,15 +206,14 @@ STATIC mp_obj_t bleio_connection_get_connection_interval(mp_obj_t self_in) {
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(bleio_connection_get_connection_interval_obj, bleio_connection_get_connection_interval);
-//| .. attribute:: max_packet_length
-//|
-//| The maximum number of data bytes that can be sent in a single transmission,
+//| attribute: Any = ...
+//| """The maximum number of data bytes that can be sent in a single transmission,
//| not including overhead bytes.
//|
//| This is the maximum number of bytes that can be sent in a notification,
//| which must be sent in a single packet.
//| But for a regular characteristic read or write, may be sent in multiple packets,
-//| so this limit does not apply.
+//| so this limit does not apply."""
//|
STATIC mp_obj_t bleio_connection_get_max_packet_length(mp_obj_t self_in) {
bleio_connection_obj_t *self = MP_OBJ_TO_PTR(self_in);
diff --git a/shared-bindings/_bleio/Descriptor.c b/shared-bindings/_bleio/Descriptor.c
index 00b3bacf5..9d7020849 100644
--- a/shared-bindings/_bleio/Descriptor.c
+++ b/shared-bindings/_bleio/Descriptor.c
@@ -34,12 +34,8 @@
#include "shared-bindings/_bleio/UUID.h"
//| class Descriptor:
-//| """.. currentmodule:: _bleio
+//| """Stores information about a BLE descriptor.
//|
-//| :class:`Descriptor` -- BLE descriptor
-//| =========================================================
-//|
-//| Stores information about a BLE descriptor.
//| Descriptors are attached to BLE characteristics and provide contextual
//| information about the characteristic."""
//|
diff --git a/shared-bindings/_bleio/PacketBuffer.c b/shared-bindings/_bleio/PacketBuffer.c
index 80beadb15..907bfabd2 100644
--- a/shared-bindings/_bleio/PacketBuffer.c
+++ b/shared-bindings/_bleio/PacketBuffer.c
@@ -36,12 +36,7 @@
#include "shared-bindings/util.h"
//| class PacketBuffer:
-//| """.. currentmodule:: _bleio
-//|
-//| :class:`PacketBuffer` -- Packet-oriented characteristic usage.
-//| =====================================================================
-//|
-//| Accumulates a Characteristic's incoming packets in a FIFO buffer and facilitates packet aware
+//| """Accumulates a Characteristic's incoming packets in a FIFO buffer and facilitates packet aware
//| outgoing writes. A packet's size is either the characteristic length or the maximum transmission
//| unit (MTU) minus overhead, whichever is smaller. The MTU can change so check `incoming_packet_length`
//| and `outgoing_packet_length` before creating a buffer to store data.
@@ -60,7 +55,7 @@
//| 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 buffer_size: Size of ring buffer (in packets of the Characteristic's maximum
-//| length) that stores incoming packets coming from the peer.
+//| length) that stores incoming packets coming from the peer."""
//| ...
//|
STATIC mp_obj_t bleio_packet_buffer_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
@@ -126,11 +121,11 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_2(bleio_packet_buffer_readinto_obj, bleio_packet_
//| """Writes all bytes from data into the same outgoing packet. The bytes from header are included
//| before data when the pending packet is currently empty.
//|
-//| This does not block until the data is sent. It only blocks until the data is pending."""
-//| ...
+//| This does not block until the data is sent. It only blocks until the data is pending.
//|
-//| :return: number of bytes written. May include header bytes when packet is empty.
-//| :rtype: int
+//| :return: number of bytes written. May include header bytes when packet is empty.
+//| :rtype: int"""
+//| ...
//|
// TODO: Add a kwarg `merge=False` to dictate whether subsequent writes are merged into a pending
// one.
@@ -174,7 +169,7 @@ STATIC mp_obj_t bleio_packet_buffer_write(mp_uint_t n_args, const mp_obj_t *pos_
}
STATIC MP_DEFINE_CONST_FUN_OBJ_KW(bleio_packet_buffer_write_obj, 1, bleio_packet_buffer_write);
-//| def deinit(self, ) -> Any:
+//| def deinit(self) -> Any:
//| """Disable permanently."""
//| ...
STATIC mp_obj_t bleio_packet_buffer_deinit(mp_obj_t self_in) {
@@ -184,7 +179,7 @@ STATIC mp_obj_t bleio_packet_buffer_deinit(mp_obj_t self_in) {
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(bleio_packet_buffer_deinit_obj, bleio_packet_buffer_deinit);
-//| packet_size: Any = ...
+//| packet_size: int = ...
//| """`packet_size` is the same as `incoming_packet_length`.
//| The name `packet_size` is deprecated and
//| will be removed in CircuitPython 6.0.0."""
@@ -210,9 +205,8 @@ const mp_obj_property_t bleio_packet_buffer_incoming_packet_length_obj = {
(mp_obj_t)&mp_const_none_obj },
};
-//| .. attribute:: outgoing_packet_length
-//|
-//| Maximum length in bytes of a packet we are writing.
+//| outgoing_packet_length: int = ...
+//| """Maximum length in bytes of a packet we are writing."""
//|
STATIC mp_obj_t bleio_packet_buffer_get_outgoing_packet_length(mp_obj_t self_in) {
bleio_packet_buffer_obj_t *self = MP_OBJ_TO_PTR(self_in);
diff --git a/shared-bindings/_bleio/ScanEntry.c b/shared-bindings/_bleio/ScanEntry.c
index a92b247be..905bea81d 100644
--- a/shared-bindings/_bleio/ScanEntry.c
+++ b/shared-bindings/_bleio/ScanEntry.c
@@ -36,12 +36,7 @@
#include "shared-module/_bleio/ScanEntry.h"
//| class ScanEntry:
-//| """.. currentmodule:: _bleio
-//|
-//| :class:`ScanEntry` -- BLE scan data
-//| =========================================================
-//|
-//| Encapsulates information about a device that was received during scanning. It can be
+//| """Encapsulates information about a device that was received during scanning. It can be
//| advertisement or scan response data. This object may only be created by a `_bleio.ScanResults`:
//| it has no user-visible constructor."""
//|
@@ -68,7 +63,7 @@ STATIC mp_obj_t bleio_scanentry_matches(mp_uint_t n_args, const mp_obj_t *pos_ar
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
-
+
mp_buffer_info_t bufinfo;
mp_get_buffer_raise(args[ARG_prefixes].u_obj, &bufinfo, MP_BUFFER_READ);
return mp_obj_new_bool(common_hal_bleio_scanentry_matches(self, bufinfo.buf, bufinfo.len, args[ARG_all].u_bool));
diff --git a/shared-bindings/_bleio/ScanResults.c b/shared-bindings/_bleio/ScanResults.c
index 4b274fc68..6077dcbda 100644
--- a/shared-bindings/_bleio/ScanResults.c
+++ b/shared-bindings/_bleio/ScanResults.c
@@ -33,12 +33,7 @@
#include "shared-bindings/_bleio/ScanResults.h"
//| class ScanResults:
-//| """.. currentmodule:: _bleio
-//|
-//| :class:`ScanResults` -- An Iterator over BLE scanning results
-//| ===============================================================
-//|
-//| Iterates over advertising data received while scanning. This object is always created
+//| """Iterates over advertising data received while scanning. This object is always created
//| by a `_bleio.Adapter`: it has no user-visible constructor."""
//|
STATIC mp_obj_t scanresults_iternext(mp_obj_t self_in) {
diff --git a/shared-bindings/_bleio/Service.c b/shared-bindings/_bleio/Service.c
index 3526ce189..5ca7504f2 100644
--- a/shared-bindings/_bleio/Service.c
+++ b/shared-bindings/_bleio/Service.c
@@ -33,12 +33,7 @@
#include "shared-bindings/_bleio/UUID.h"
//| class Service:
-//| """.. currentmodule:: _bleio
-//|
-//| :class:`Service` -- BLE GATT Service
-//| =========================================================
-//|
-//| Stores information about a BLE service and its characteristics."""
+//| """Stores information about a BLE service and its characteristics."""
//|
//| def __init__(self, uuid: UUID, *, secondary: bool = False):
//| """Create a new Service identified by the specified UUID. It can be accessed by all
diff --git a/shared-bindings/_bleio/UUID.c b/shared-bindings/_bleio/UUID.c
index d4b0f84ca..78161b956 100644
--- a/shared-bindings/_bleio/UUID.c
+++ b/shared-bindings/_bleio/UUID.c
@@ -34,12 +34,7 @@
#include "shared-bindings/_bleio/UUID.h"
//| class UUID:
-//| """.. currentmodule:: _bleio
-//|
-//| :class:`UUID` -- BLE UUID
-//| =========================================================
-//|
-//| A 16-bit or 128-bit UUID. Can be used for services, characteristics, descriptors and more."""
+//| """A 16-bit or 128-bit UUID. Can be used for services, characteristics, descriptors and more."""
//|
//| def __init__(self, value: Any):
//| """Create a new UUID or UUID object encapsulating the uuid value.
@@ -207,7 +202,7 @@ STATIC mp_obj_t bleio_uuid_pack_into(mp_uint_t n_args, const mp_obj_t *pos_args,
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
-
+
mp_buffer_info_t bufinfo;
mp_get_buffer_raise(args[ARG_buffer].u_obj, &bufinfo, MP_BUFFER_WRITE);
diff --git a/shared-bindings/_bleio/__init__.c b/shared-bindings/_bleio/__init__.c
index da7bfdd81..90b185f79 100644
--- a/shared-bindings/_bleio/__init__.c
+++ b/shared-bindings/_bleio/__init__.c
@@ -41,13 +41,7 @@
#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
@@ -58,24 +52,6 @@
//| provides higher-level convenience functionality, including predefined beacons, clients,
//| servers.
//|
-//| Libraries
-//|
-//| .. toctree::
-//| :maxdepth: 3
-//|
-//| Address
-//| Adapter
-//| Attribute
-//| Characteristic
-//| CharacteristicBuffer
-//| Connection
-//| Descriptor
-//| PacketBuffer
-//| ScanEntry
-//| ScanResults
-//| Service
-//| UUID
-//|
//| .. attribute:: adapter
//|
//| BLE Adapter used to manage device discovery and connections.
generated by cgit v1.2.3 (git 2.39.1) at 2026-08-08 14:31:43 +0000