Switching to the new match_prefixes for Advertisement matching which replaces prefix.

Changing to matching using the library rather than the match_locally enabled code and a few fixes around that dusty code path.
match_prefixes came up in the review adafruit#1185

Author: Kevin J Walters

CLUE_Rock_Paper_Scissors/advanced/rps_advertisements.py

@@ -63,16 +63,19 @@ class RpsEncDataAdvertisement(Advertisement):
        """
     flags = None
 
-    _PREFIX_FMT = "<B" "BHBH"
+    _PREFIX_FMT = "<BHBH"
     _DATA_FMT_ENC_DATA = "8s"
 
-    prefix = struct.pack(
-        _PREFIX_FMT,
-        struct.calcsize(_PREFIX_FMT) - 1,
-        MANUFACTURING_DATA_ADT,
-        ADAFRUIT_COMPANY_ID,
-        struct.calcsize("<H" + _DATA_FMT_ENC_DATA),
-        RPS_ENC_DATA_ID
+    # match_prefixes tuple replaces deprecated prefix
+    # comma for 1 element is very important!
+    match_prefixes = (
+        struct.pack(
+            _PREFIX_FMT,
+            MANUFACTURING_DATA_ADT,
+            ADAFRUIT_COMPANY_ID,
+            struct.calcsize("<H" + _DATA_FMT_ENC_DATA),
+            RPS_ENC_DATA_ID
+        ),
     )
     manufacturer_data = LazyObjectField(
         ManufacturerData,
@@ -111,20 +114,19 @@ class RpsKeyDataAdvertisement(Advertisement):
        """
     flags = None
 
-    _PREFIX_FMT = "<B" "BHBH"
+    _PREFIX_FMT = "<BHBH"
     _DATA_FMT_KEY_DATA = "8s"
 
-    # prefix appears to be used to determine whether an incoming
-    # packet matches this class
-    # The second struct.calcsize needs to include the _DATA_FMT for some
-    # reason I either don't know or can't remember
-    prefix = struct.pack(
-        _PREFIX_FMT,
-        struct.calcsize(_PREFIX_FMT) - 1,
-        MANUFACTURING_DATA_ADT,
-        ADAFRUIT_COMPANY_ID,
-        struct.calcsize("<H" + _DATA_FMT_KEY_DATA),
-        RPS_KEY_DATA_ID
+    # match_prefixes tuple replaces deprecated prefix
+    # comma for 1 element is very important!
+    match_prefixes = (
+        struct.pack(
+            _PREFIX_FMT,
+            MANUFACTURING_DATA_ADT,
+            ADAFRUIT_COMPANY_ID,
+            struct.calcsize("<H" + _DATA_FMT_KEY_DATA),
+            RPS_KEY_DATA_ID
+        ),
     )
     manufacturer_data = LazyObjectField(
         ManufacturerData,
@@ -164,15 +166,18 @@ class RpsRoundEndAdvertisement(Advertisement):
        """
     flags = None
 
-    _PREFIX_FMT = "<B" "BHBH"
-
-    prefix = struct.pack(
-        _PREFIX_FMT,
-        struct.calcsize(_PREFIX_FMT) - 1,
-        MANUFACTURING_DATA_ADT,
-        ADAFRUIT_COMPANY_ID,
-        struct.calcsize("<H" + _DATA_FMT_ROUND),
-        RPS_ROUND_ID
+    _PREFIX_FMT = "<BHBH"
+
+    # match_prefixes tuple replaces deprecated prefix
+    # comma for 1 element is very important!
+    match_prefixes = (
+        struct.pack(
+            _PREFIX_FMT,
+            MANUFACTURING_DATA_ADT,
+            ADAFRUIT_COMPANY_ID,
+            struct.calcsize("<H" + _DATA_FMT_ROUND),
+            RPS_ROUND_ID
+        ),
     )
     manufacturer_data = LazyObjectField(
         ManufacturerData,
@@ -207,18 +212,19 @@ class JoinGameAdvertisement(Advertisement):
        """
     flags = None
 
-    _PREFIX_FMT = "<B" "BHBH"
+    _PREFIX_FMT = "<BHBH"
     _DATA_FMT = "8s"  # this NUL pads for 8s if necessary
 
-    prefix = struct.pack(
-        _PREFIX_FMT,
-        struct.calcsize(_PREFIX_FMT) - 1,
-        MANUFACTURING_DATA_ADT,
-        ADAFRUIT_COMPANY_ID,
-        ##struct.calcsize("<H" + _SEQ_FMT + _DATA_FMT),
-        struct.calcsize("<H" + _DATA_FMT),
-        ##struct.calcsize("<H"),
-        GM_JOIN_ID
+    # match_prefixes tuple replaces deprecated prefix
+    # comma for 1 element is very important!
+    match_prefixes = (
+        struct.pack(
+            _PREFIX_FMT,
+            MANUFACTURING_DATA_ADT,
+            ADAFRUIT_COMPANY_ID,
+            struct.calcsize("<H" + _DATA_FMT),
+            GM_JOIN_ID
+        ),
     )
     manufacturer_data = LazyObjectField(
         ManufacturerData,

CLUE_Rock_Paper_Scissors/advanced/rps_comms.py

@@ -133,10 +133,10 @@ def startScan(radio, send_ad, send_advertising,
         # If using application Advertisement type matching then
         # check the Advertisement's prefix and continue for loop if it
         # does not match
+        adv = None
+        d_print(5, "RXed RTA", match_locally, addr_text, repr(adv_ss))
         if match_locally:
-            d_print(5, "RXed RTA", addr_text, repr(adv_ss))
             adv_ss_as_bytes = adafruit_ble.advertising.standard.encode_data(adv_ss.data_dict)
-            adv = None
             for cls in rx_ad_classes:
                 prefix = cls.prefix
                 # This DOES NOT IMPLEMENT PROPER MATCHING
@@ -151,15 +151,17 @@ def startScan(radio, send_ad, send_advertising,
                     d_print(4, "RXed mm RTA", addr_text, adv)
                     break
 
-            if adv is None:
-                if endscan_cb is not None and endscan_cb(addr_text, adv_ss.address, adv_ss):
-                    complete = True
-                    break
-                else:
-                    continue
         else:
-            adv = adv_ss
-            d_print(4, "RXed RTA", addr_text, adv)
+            if any(isinstance(adv_ss, cls) for cls in rx_ad_classes):
+                adv = adv_ss
+
+        # Continue loop after an endscan callback if ad is not of interest
+        if adv is None:  # this means adv was not in rx_ad_classes
+            if endscan_cb is not None and endscan_cb(addr_text, adv_ss.address, adv_ss):
+                complete = True
+                break
+            else:
+                continue
 
         # Must be a match if this is reached
         matching_ads += 1
@@ -233,7 +235,7 @@ def broadcastAndReceive(radio,
                         minimum_rssi=-90,
                         receive_n=0,
                         seq_tx=None,
-                        match_locally=True,
+                        match_locally=False,
                         scan_response_request=False,
                         ad_cb=None,
                         ads_by_addr={},
@@ -274,6 +276,8 @@ def broadcastAndReceive(radio,
 
     if match_locally:
         ss_rx_ad_classes = (Advertisement,)
+    elif scan_response_request:
+        ss_rx_ad_classes = rx_ad_classes + (Advertisement,)
     else:
         ss_rx_ad_classes = rx_ad_classes
 

CLUE_Rock_Paper_Scissors/simple/clue-simple-rpsgame.py

@@ -1,4 +1,4 @@
-# clue-simple-rpsgame v1.1
+# clue-simple-rpsgame v1.2
 # CircuitPython rock paper scissors game over Bluetooth LE
 
 # Tested with CLUE and Circuit Playground Bluefruit Alpha with TFT Gizmo
@@ -233,16 +233,19 @@ class RpsAdvertisement(Advertisement):
 
     flags = None
 
-    _PREFIX_FMT = "<B" "BHBH"
+    _PREFIX_FMT = "<BHBH"
     _DATA_FMT = "8s"  # this NUL pads if necessary
 
-    prefix = struct.pack(
-        _PREFIX_FMT,
-        struct.calcsize(_PREFIX_FMT) - 1,
-        MANUFACTURING_DATA_ADT,
-        ADAFRUIT_COMPANY_ID,
-        struct.calcsize("<H" + _DATA_FMT),
-        RPS_DATA_ID
+    # match_prefixes tuple replaces deprecated prefix
+    # comma for 1 element is very important!
+    match_prefixes = (
+        struct.pack(
+            _PREFIX_FMT,
+            MANUFACTURING_DATA_ADT,
+            ADAFRUIT_COMPANY_ID,
+            struct.calcsize("<H" + _DATA_FMT),
+            RPS_DATA_ID
+        ),
     )
     manufacturer_data = LazyObjectField(
         ManufacturerData,