Skip to content

Commit

Permalink
docs/library/bluetooth: Rename to "ubluetooth".
Browse files Browse the repository at this point in the history
  • Loading branch information
jimmo authored and dpgeorge committed Oct 22, 2019
1 parent b02d7e6 commit 19e8774
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/library/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 9 additions & 9 deletions docs/library/bluetooth.rst → docs/library/ubluetooth.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.


Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

0 comments on commit 19e8774

Please sign in to comment.