summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJim Mussared <jim.mussared@gmail.com>2019-10-28 17:29:08 +1100
committerDamien George <damien.p.george@gmail.com>2019-10-29 23:11:11 +1100
commitca3d4c84e4722edefde586d7978f5a216c8febad (patch)
tree83091dc0cad9d5ad7ba3417bd371e93d923b2ea0
parentd16a27da5197e2369611bef4f18b47c183880510 (diff)
docs/library/ubluetooth: Add docs for gatts_set_buffer.
-rw-r--r--docs/library/ubluetooth.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/library/ubluetooth.rst b/docs/library/ubluetooth.rst
index 831c64a95..5d44ffdb2 100644
--- a/docs/library/ubluetooth.rst
+++ b/docs/library/ubluetooth.rst
@@ -246,6 +246,17 @@ writes from a central to a given characteristic, use
of the notification, avoiding the need for a separate read request. Note
that this will not update the local value stored.
+.. method:: BLE.gatts_set_buffer(value_handle, len, append=False)
+
+ Sets the internal buffer size for a value in bytes. This will limit the
+ largest possible write that can be received. The default is 20.
+
+ Setting *append* to ``True`` will make all remote writes append to, rather
+ than replace, the current value. At most *len* bytes can be buffered in
+ this way. When you use :meth:`gatts_read <BLE.gatts_read>`, the value will
+ be cleared after reading. This feature is useful when implementing something
+ like the Nordic UART Service.
+
Central Role (GATT Client)
--------------------------