Skip to content

Fix documentation of params #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 28, 2022
Merged

Fix documentation of params #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions adafruit_bluefruitspi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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")
Expand Down