djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/library/bluetooth: Rename to "ubluetooth".

This commit is contained in:
Jim Mussared 2019-10-22 17:05:36 +11:00 committed by Damien George
parent b02d7e612d
commit 19e87742c4
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/library/index.rst
View File

@ -74,13 +74,13 @@ it will fallback to loading the built-in ``ujson`` module.
:maxdepth: 1 :maxdepth: 1
builtins.rst builtins.rst
bluetooth.rst
cmath.rst cmath.rst
gc.rst gc.rst
math.rst math.rst
sys.rst sys.rst
uarray.rst uarray.rst
ubinascii.rst ubinascii.rst
ubluetooth.rst
ucollections.rst ucollections.rst
uerrno.rst uerrno.rst
uhashlib.rst uhashlib.rst

18
docs/library/bluetooth.rst → docs/library/ubluetooth.rst
View File

@ -1,7 +1,7 @@
:mod:`bluetooth` --- low-level Bluetooth :mod:`ubluetooth` --- low-level Bluetooth
======================================== =========================================
.. module:: bluetooth .. module:: ubluetooth
:synopsis: Low-level Bluetooth radio functionality :synopsis: Low-level Bluetooth radio functionality
This module provides an interface to a Bluetooth controller on a board. 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) _IRQ_GATTC_INDICATE = const(1 << 14)
In order to save space in the firmware, these constants are not included on the 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. program.
@ -203,8 +203,8 @@ writes from a central to a given characteristic, use
value. value.
The **flags** are a bitwise-OR combination of the The **flags** are a bitwise-OR combination of the
:data:`bluetooth.FLAGS_READ`, :data:`bluetooth.FLAGS_WRITE` and :data:`ubluetooth.FLAGS_READ`, :data:`bluetooth.FLAGS_WRITE` and
:data:`bluetooth.FLAGS_NOTIFY` values defined below. :data:`ubluetooth.FLAGS_NOTIFY` values defined below.
The return value is a list (one element per service) of tuples (each element The return value is a list (one element per service) of tuples (each element
is a value handle). Characteristics and descriptor handles are flattened is a value handle). Characteristics and descriptor handles are flattened
@ -321,6 +321,6 @@ Constructor
Constants Constants
--------- ---------
.. data:: bluetooth.FLAG_READ .. data:: ubluetooth.FLAG_READ
bluetooth.FLAG_WRITE ubluetooth.FLAG_WRITE
bluetooth.FLAG_NOTIFY ubluetooth.FLAG_NOTIFY