summaryrefslogtreecommitdiff
path: root/shared-bindings/bleio/CharacteristicBuffer.c
diff options
context:
space:
mode:
authorDan Halbert <halbert@halwitz.org>2019-07-02 22:34:54 -0400
committerDan Halbert <halbert@halwitz.org>2019-07-02 22:34:54 -0400
commitbf8a35b2f835fbc97d54867f8e21b486a46c245b (patch)
tree97c52950ec6840fca9bca6eeb844217c6efa93c4 /shared-bindings/bleio/CharacteristicBuffer.c
parent6ea01ea9b0334a175419f9d449be25a5838627da (diff)
WIP: CharacteristicBuffer for Central; not working: need to set remote Characteristic Service
Diffstat (limited to 'shared-bindings/bleio/CharacteristicBuffer.c')
-rw-r--r--shared-bindings/bleio/CharacteristicBuffer.c9
1 files changed, 6 insertions, 3 deletions
diff --git a/shared-bindings/bleio/CharacteristicBuffer.c b/shared-bindings/bleio/CharacteristicBuffer.c
index 827f4947b..26f9e012b 100644
--- a/shared-bindings/bleio/CharacteristicBuffer.c
+++ b/shared-bindings/bleio/CharacteristicBuffer.c
@@ -49,10 +49,13 @@ STATIC void raise_error_if_not_connected(bleio_characteristic_buffer_obj_t *self
//|
//| .. class:: CharacteristicBuffer(characteristic, *, timeout=1, buffer_size=64)
//|
-//| Create a new Characteristic object identified by the specified UUID.
+//| Monitor the given Characteristic. Each time a new value is written to the Characteristic
+//| add the newly-written bytes to a FIFO buffer.
//|
-//| :param bleio.Characteristic characteristic: The characteristic to monitor
-//| :param int timeout: the timeout in seconds to wait for the first character and between subsequent characters.//|
+//| :param bleio.Characteristic characteristic: The Characteristic to monitor.
+//| It may be a local Characteristic provided by a Peripheral Service, or a remote Characteristic
+//| in a remote Service that a Central has connected to.
+//| :param int timeout: the timeout in seconds to wait for the first character and between subsequent characters.
//| :param int buffer_size: Size of ring buffer that stores incoming data coming from client.
//| Must be >= 1.
//|