Skip to content

Add the RawTextPacket class to the documentation #35

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion adafruit_bluefruit_connect/packet.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,10 @@ def from_stream(cls, stream):
set on stream, using its own preset timeout.
Return None if there was no input, otherwise return an instance
of one of the packet classes registered with ``Packet``.
Raise an Error if the packet was not recognized or was malformed
Raise an Error if the packet was not recognized or was malformed.

If a packet of type "RT" (like ``RawTextPacket``) is registered, it will be
used to return the raw data line when no packet type was recognized.

:param stream stream: an input stream that provides standard stream read operations,
such as ``ble.UARTServer`` or ``busio.UART``.
Expand Down
3 changes: 3 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,6 @@

.. automodule:: adafruit_bluefruit_connect.quaternion_packet
:members:

.. automodule:: adafruit_bluefruit_connect.raw_text_packet
:members: