From ca3d4c84e4722edefde586d7978f5a216c8febad Mon Sep 17 00:00:00 2001 From: Jim Mussared Date: Mon, 28 Oct 2019 17:29:08 +1100 Subject: [PATCH] docs/library/ubluetooth: Add docs for gatts_set_buffer. --- docs/library/ubluetooth.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/library/ubluetooth.rst b/docs/library/ubluetooth.rst index 831c64a95f..5d44ffdb29 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 `, the value will + be cleared after reading. This feature is useful when implementing something + like the Nordic UART Service. + Central Role (GATT Client) --------------------------