From 1e2839c07d27941c1908daeda1072698b179772a Mon Sep 17 00:00:00 2001 From: Neradoc Date: Mon, 28 Mar 2022 16:18:06 +0200 Subject: [PATCH] Fix documentation of params --- adafruit_bluefruitspi.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/adafruit_bluefruitspi.py b/adafruit_bluefruitspi.py index ba3b1c1..79b5fed 100644 --- a/adafruit_bluefruitspi.py +++ b/adafruit_bluefruitspi.py @@ -162,6 +162,7 @@ def send_keyboard_code(self, evt): """ Put an AT+BLEKEYBOARDCODE command into the FIFO buffer. Call pop_keyboard_code() to send a single packet to the Bluefruit. + :param evt: bytearray(8) representing keyboard code to send """ evt = ba.hexlify(evt) @@ -188,6 +189,7 @@ def pop_keyboard_code_queue(self): def _create_sdep_raw(dest, payload, more): """ Create an SDEP packet + :param dest: bytearray(20) to place SDEP packet in :param payload: iterable with length <= 16 containing the payload data :param more: True to set the more bit, False otherwise @@ -210,6 +212,7 @@ def _cmd(self, cmd): # pylint: disable=too-many-branches a new-line character. Returns msgtype, rspid, rsp, which are 8-bit int, 16-bit int and a bytearray. + :param cmd: The new-line terminated AT command to execute. """ # Make sure we stay within the 255 byte limit @@ -302,6 +305,7 @@ def connected(self): def uart_tx(self, data): """ Sends the specific bytestring out over BLE UART. + :param data: The bytestring to send. """ return self._cmd(b"AT+BLEUARTTX=" + data + b"\r\n")