summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJim Mussared <jim.mussared@gmail.com>2019-10-22 17:05:36 +1100
committerDamien George <damien.p.george@gmail.com>2019-10-22 21:58:05 +1100
commit19e87742c41e7732258ea06406039be7a734e890 (patch)
tree9a26dc1ae12a4d03e7b08a77056a9d23a6ba2932
parentb02d7e612d12b507a3a91a95eb30187b24ce21a7 (diff)
docs/library/bluetooth: Rename to "ubluetooth".
-rw-r--r--docs/library/index.rst2
-rw-r--r--docs/library/ubluetooth.rst (renamed from docs/library/bluetooth.rst)18
2 files changed, 10 insertions, 10 deletions
diff --git a/docs/library/index.rst b/docs/library/index.rst
index 223304881..a2d11dee7 100644
--- a/docs/library/index.rst
+++ b/docs/library/index.rst
@@ -74,13 +74,13 @@ it will fallback to loading the built-in ``ujson`` module.
:maxdepth: 1
builtins.rst
- bluetooth.rst
cmath.rst
gc.rst
math.rst
sys.rst
uarray.rst
ubinascii.rst
+ ubluetooth.rst
ucollections.rst
uerrno.rst
uhashlib.rst
diff --git a/docs/library/bluetooth.rst b/docs/library/ubluetooth.rst
index e672cef92..831c64a95 100644
--- a/docs/library/bluetooth.rst
+++ b/docs/library/ubluetooth.rst
@@ -1,7 +1,7 @@
-:mod:`bluetooth` --- low-level Bluetooth
-========================================
+:mod:`ubluetooth` --- low-level Bluetooth
+=========================================
-.. module:: bluetooth
+.. module:: ubluetooth
:synopsis: Low-level Bluetooth radio functionality
This module provides an interface to a Bluetooth controller on a board.
@@ -123,7 +123,7 @@ The event codes are::
_IRQ_GATTC_INDICATE = const(1 << 14)
In order to save space in the firmware, these constants are not included on the
-:mod:`bluetooth` module. Add the ones that you need from the list above to your
+:mod:`ubluetooth` module. Add the ones that you need from the list above to your
program.
@@ -203,8 +203,8 @@ writes from a central to a given characteristic, use
value.
The **flags** are a bitwise-OR combination of the
- :data:`bluetooth.FLAGS_READ`, :data:`bluetooth.FLAGS_WRITE` and
- :data:`bluetooth.FLAGS_NOTIFY` values defined below.
+ :data:`ubluetooth.FLAGS_READ`, :data:`bluetooth.FLAGS_WRITE` and
+ :data:`ubluetooth.FLAGS_NOTIFY` values defined below.
The return value is a list (one element per service) of tuples (each element
is a value handle). Characteristics and descriptor handles are flattened
@@ -321,6 +321,6 @@ Constructor
Constants
---------
-.. data:: bluetooth.FLAG_READ
- bluetooth.FLAG_WRITE
- bluetooth.FLAG_NOTIFY
+.. data:: ubluetooth.FLAG_READ
+ ubluetooth.FLAG_WRITE
+ ubluetooth.FLAG_NOTIFY