[20211213] as requested by @dhalbert, rename TextPacket to RawTextpacket

Author: TonyLHansen

adafruit_bluefruit_connect/packet.py

@@ -104,12 +104,12 @@ def from_stream(cls, stream):
                 break
 
             # Didn't find a packet start.
-            text_packet_cls = cls._type_to_class.get(b"TX", None)
-            # Is TextPacket registered?
-            # If so, read an entire line and pass that to TextPacket.
-            if text_packet_cls:
+            raw_text_packet_cls = cls._type_to_class.get(b"RT", None)
+            # Is RawTextPacket registered?
+            # If so, read an entire line and pass that to RawTextPacket.
+            if raw_text_packet_cls:
                 packet = bytes(start + stream.readline())
-                return text_packet_cls(packet)
+                return raw_text_packet_cls(packet)
 
             # else loop and try again.
 

adafruit_bluefruit_connect/text_packet.py renamed to adafruit_bluefruit_connect/raw_text_packet.py

@@ -3,17 +3,18 @@
 # SPDX-License-Identifier: MIT
 
 """
-`adafruit_bluefruit_connect.text_packet`
+`adafruit_bluefruit_connect.raw_text_packet`
 ====================================================
 
-Bluefruit Connect App text data packet.
+Bluefruit Connect App raw text data packet.
 
-Note that the text data packet is different from those used by the
+Note that the raw text data packet is different from those used by the
 Controller module (e.g. Accelerometer, Control Pad, and Color Picker).
 Those use the bytes "!x" (where x is specific to the type of packet),
 followed by data specific to the packet, followed by a checksum.
 The UART text sender instead sends the bytes followed by a newline.
-There is no length indicator, no checksum, etc.
+There is no length indicator, no checksum, etc. Of course, that also
+precludes the use of an "!" at the beginning of the string.
 
 Consequently, this packet type is MUCH simpler than the other packet types.
 
@@ -24,13 +25,13 @@
 from .packet import Packet
 
 
-class TextPacket(Packet):
+class RawTextPacket(Packet):
     """A packet containing a text string."""
 
-    _TYPE_HEADER = b"TX"
+    _TYPE_HEADER = b"RT"
 
     def __init__(self, text):
-        """Construct a TextPacket from a binary string."""
+        """Construct a RawTextPacket from a binary string."""
         if isinstance(text, bytes):
             self._text = text.strip()
         else:
@@ -43,4 +44,4 @@ def text(self):
 
 
 # Register this class with the superclass. This allows the user to import only what is needed.
-TextPacket.register_packet_type()
+RawTextPacket.register_packet_type()

docs/examples.rst

@@ -24,3 +24,11 @@ This example demonstrates receiving text from the UART interface.
 .. literalinclude:: ../examples/bluefruitconnect_uart.py
     :caption: examples/bluefruitconnect_uart.py
     :linenos:
+
+This example demonstrates receiving both a color (as in simpletest above)
+and raw text (using RawTextPacket).
+
+.. literalinclude:: ../examples/bluefruitconnect_simpletest.py
+    :caption: examples/bluefruitconnect_simpletest.py
+    :linenos:
+

examples/bluefruitconnect_simpletest2.py

@@ -1,11 +1,11 @@
 # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
 # SPDX-License-Identifier: MIT
 
-# Print out the color data from ColorPackets and text data from TextPackets.
+# Print out the color data from ColorPackets and text data from RawTextPackets.
 # To use, start this program, and start the Adafruit Bluefruit LE Connect app.
 # Connect, and then select colors on the Controller->Color Picker screen.
-# Select text by entering the UART screen and sending in in a string.
-# (Do NOT use a "!" as part of your string.)
+# Select text by entering the UART screen and sending a string.
+# (Do NOT use a "!" at the start of your string.)
 
 from adafruit_ble import BLERadio
 from adafruit_ble.advertising.standard import ProvideServicesAdvertisement
@@ -14,7 +14,7 @@
 
 # Only the packet classes that are imported will be known to Packet.
 from adafruit_bluefruit_connect.color_packet import ColorPacket
-from adafruit_bluefruit_connect.text_packet import TextPacket
+from adafruit_bluefruit_connect.raw_text_packet import RawTextPacket
 
 ble = BLERadio()
 uart_server = UARTService()
@@ -30,6 +30,6 @@
         packet = Packet.from_stream(uart_server)
         if isinstance(packet, ColorPacket):
             print(packet.color)
-        elif isinstance(packet, TextPacket):
-            print("Received Text Packet:")
+        elif isinstance(packet, RawTextPacket):
+            print("Received Raw Text Packet:")
             print(packet.text)