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

docs/library/ubluetooth.rst: Update read request IRQ docs. 

Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
This commit is contained in:
Jim Mussared 2020-11-24 23:09:10 +11:00 committed by Damien George
parent 60830bcba4
commit 5e20f689ad
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/library/ubluetooth.rst
View File

@ -119,9 +119,9 @@ Event Handling
# A client has written to this characteristic or descriptor. # A client has written to this characteristic or descriptor.
conn_handle, attr_handle = data conn_handle, attr_handle = data
elif event == _IRQ_GATTS_READ_REQUEST: elif event == _IRQ_GATTS_READ_REQUEST:
# A client has issued a read. Note: this is a hard IRQ. # A client has issued a read. Note: this is only supported on STM32.
# Return None to deny the read. # Return a non-zero integer to deny the read (see below), or zero (or None)
# Note: This event is not supported on ESP32. # to accept the read.
conn_handle, attr_handle = data conn_handle, attr_handle = data
elif event == _IRQ_SCAN_RESULT: elif event == _IRQ_SCAN_RESULT:
# A single scan result. # A single scan result.
@ -234,6 +234,15 @@ The event codes are::
_IRQ_L2CAP_SEND_READY = const(26) _IRQ_L2CAP_SEND_READY = const(26)
_IRQ_CONNECTION_UPDATE = const(27) _IRQ_CONNECTION_UPDATE = const(27)
For the ``_IRQ_GATTS_READ_REQUEST`` event, the available return codes are::
_GATTS_NO_ERROR = const(0x00)
_GATTS_ERROR_READ_NOT_PERMITTED = const(0x02)
_GATTS_ERROR_WRITE_NOT_PERMITTED = const(0x03)
_GATTS_ERROR_INSUFFICIENT_AUTHENTICATION = const(0x05)
_GATTS_ERROR_INSUFFICIENT_AUTHORIZATION = const(0x08)
_GATTS_ERROR_INSUFFICIENT_ENCRYPTION = const(0x0f)
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:`ubluetooth` 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.
@ -420,6 +429,8 @@ writes from a client to a given characteristic, use
_FLAG_WRITE_AUTHENTICATED = const(0x2000) _FLAG_WRITE_AUTHENTICATED = const(0x2000)
_FLAG_WRITE_AUTHORIZED = const(0x4000) _FLAG_WRITE_AUTHORIZED = const(0x4000)
As for the IRQs above, any required constants should be added to your Python code.
.. method:: BLE.gatts_read(value_handle, /) .. method:: BLE.gatts_read(value_handle, /)
Reads the local value for this handle (which has either been written by Reads the local value for this handle (which has either been written by