Log and refine TC66 Bluetooth discovery · 73ef759

Log and refine TC66 Bluetooth discovery
Browse files

bogdan committed a month ago

main

1 parent 09f72da

commit 73ef759

Showing 4 changed files with 143 additions and 17 deletions

+123 -11

USB Meter/Model/BluetoothManager.swift

+                     //
+                     import CoreBluetooth
+                    +import OSLog
+                    +private let bluetoothDiscoveryLogger = Logger(subsystem: "ro.xdev.USB-Meter", category: "BluetoothDiscovery")
+                     class BluetoothManager : NSObject, ObservableObject {
+                         private var manager: CBCentralManager?
+                         private var isStarting = false
+                         private var advertisementDataCache = AdvertisementDataCache()
+                    +    private var lastDiscoveryLog = [String: Date]()
+                         @Published var managerState = CBManagerState.unknown
+                         @Published private(set) var scanStartedAt: Date?
+                                 return
+                             //manager.scanForPeripherals(withServices: allBluetoothRadioServices(), options: [ CBCentralManagerScanOptionAllowDuplicatesKey: true ])
+                    -        manager.scanForPeripherals(withServices: allBluetoothRadioServices(), options: [ CBCentralManagerScanOptionAllowDuplicatesKey: true ])
+                    +        let serviceUUIDs = allBluetoothRadioServices()
+                    +        track("Scanning for USB meters with services: \(serviceUUIDs.map(\.uuidString).joined(separator: ", "))")
+                    +        manager.scanForPeripherals(withServices: serviceUUIDs, options: [ CBCentralManagerScanOptionAllowDuplicatesKey: true ])
+                         func discoveredMeter(peripheral: CBPeripheral, advertising advertismentData: [String : Any], rssi RSSI: NSNumber) {
+                    -        guard let peripheralName = resolvedPeripheralName(for: peripheral, advertising: advertismentData) else {
+                    -            return
+                    -        }
+                    -        guard let manufacturerData = resolvedManufacturerData(from: advertismentData), manufacturerData.count > 2 else {
+                    +        logDiscoveryCandidate(peripheral: peripheral, advertising: advertismentData, rssi: RSSI)
+                    +        let peripheralName = resolvedPeripheralName(for: peripheral, advertising: advertismentData)
+                    +        guard let match = resolvedModel(for: peripheralName, advertising: advertismentData) else {
+                    +            let reason: String
+                    +            if let peripheralName {
+                    +                reason = "unrecognized peripheral name '\(peripheralName)'; known names: \(Model.knownPeripheralNames.joined(separator: ", "))"
+                    +            } else {
+                    +                reason = "missing peripheral name/local name"
+                    +            }
+                    +            logDiscoveryRejection(
+                    +                peripheral: peripheral,
+                    +                reason: reason,
+                    +                advertising: advertismentData,
+                    +                rssi: RSSI
+                    +            )
+                                 return
+                    -        guard let model = Model.byPeripheralName[peripheralName] else {
+                    +        let model = match.model
+                    +        let radio = match.radio
+                    +        let advertisedName = match.advertisedName
+                    +        guard let macAddress = resolvedMACAddress(from: advertismentData) else {
+                    +            logDiscoveryRejection(
+                    +                peripheral: peripheral,
+                    +                reason: "missing or short manufacturer data for '\(advertisedName)'",
+                    +                advertising: advertismentData,
+                    +                rssi: RSSI
+                    +            )
+                                 return
+                    -        let macAddress = MACAddress(from: manufacturerData.suffix(from: 2))
+                             let macAddressString = macAddress.description
+                    -        appData.registerMeter(macAddress: macAddressString, modelName: model.canonicalName, advertisedName: peripheralName)
+                    +        appData.registerMeter(macAddress: macAddressString, modelName: model.canonicalName, advertisedName: advertisedName)
+                             appData.noteMeterSeen(at: Date(), macAddress: macAddressString)
+                             if appData.meters[peripheral.identifier] == nil {
+                    -            track("adding new USB Meter named '\(peripheralName)' with MAC Address: '\(macAddress)'")
+                    -            let btSerial = BluetoothSerial(peripheral: peripheral, radio: model.radio, with: macAddress, managedBy: manager!, RSSI: RSSI.intValue)
+                    +            logDiscovery("BLE discovery accepted: model='\(model.canonicalName)', radio='\(radio)', advertisedName='\(advertisedName)', match='\(match.reason)', macAddress='\(macAddressString)'. \(discoveryDescription(peripheral: peripheral, advertising: advertismentData, rssi: RSSI))")
+                    +            track("adding new USB Meter named '\(advertisedName)' with MAC Address: '\(macAddress)'")
+                    +            let btSerial = BluetoothSerial(peripheral: peripheral, radio: radio, with: macAddress, managedBy: manager!, RSSI: RSSI.intValue)
+                                 var m = appData.meters
+                                 let meter = Meter(model: model, with: btSerial)
+                                 m[peripheral.identifier] = meter
+                    +    private func resolvedModel(for peripheralName: String?, advertising advertismentData: [String: Any]) -> (model: Model, advertisedName: String, radio: BluetoothRadio, reason: String)? {
+                    +        if let peripheralName {
+                    +            if let model = Model.model(forPeripheralName: peripheralName) {
+                    +                return (model, peripheralName, radio(for: model, peripheralName: peripheralName), "recognized peripheral name")
+                    +            }
+                    +        }
+                    +        return nil
+                    +    }
+                    +    private func radio(for model: Model, peripheralName: String) -> BluetoothRadio {
+                    +        guard model == .TC66C else {
+                    +            return model.radio
+                    +        }
+                    +        if peripheralName.caseInsensitiveCompare("BT24-M") == .orderedSame {
+                    +            return .BT24M
+                    +        }
+                    +        return model.radio
+                    +    }
+                    +    private func resolvedMACAddress(from advertismentData: [String: Any]) -> MACAddress? {
+                    +        guard let manufacturerData = resolvedManufacturerData(from: advertismentData), manufacturerData.count > 2 else {
+                    +            return nil
+                    +        }
+                    +        return MACAddress(from: manufacturerData.suffix(from: 2))
+                    +    }
+                    +    private func logDiscoveryCandidate(peripheral: CBPeripheral, advertising advertismentData: [String: Any], rssi RSSI: NSNumber) {
+                    +        guard shouldLogDiscoveryDetails(for: peripheral.identifier) else { return }
+                    +        logDiscovery("BLE discovery candidate: \(discoveryDescription(peripheral: peripheral, advertising: advertismentData, rssi: RSSI))")
+                    +    }
+                    +    private func logDiscoveryRejection(
+                    +        peripheral: CBPeripheral,
+                    +        reason: String,
+                    +        advertising advertismentData: [String: Any],
+                    +        rssi RSSI: NSNumber
+                    +    ) {
+                    +        guard shouldLogDiscoveryRejection(for: peripheral.identifier, reason: reason) else { return }
+                    +        logDiscovery("BLE discovery rejected: \(reason). \(discoveryDescription(peripheral: peripheral, advertising: advertismentData, rssi: RSSI))")
+                    +    }
+                    +    private func logDiscovery(_ message: String) {
+                    +        track(message)
+                    +        bluetoothDiscoveryLogger.notice("\(message, privacy: .public)")
+                    +    }
+                    +    private func shouldLogDiscoveryDetails(for identifier: UUID) -> Bool {
+                    +        guard ProcessInfo.processInfo.environment["USB_METER_VERBOSE_LOGS"] == "1" else {
+                    +            return false
+                    +        }
+                    +        return shouldLogDiscoveryDetails(for: identifier.uuidString)
+                    +    }
+                    +    private func shouldLogDiscoveryRejection(for identifier: UUID, reason: String) -> Bool {
+                    +        shouldLogDiscoveryDetails(for: "\(identifier.uuidString):\(reason)")
+                    +    }
+                    +    private func shouldLogDiscoveryDetails(for key: String) -> Bool {
+                    +        let now = Date()
+                    +        if let lastLoggedAt = lastDiscoveryLog[key], now.timeIntervalSince(lastLoggedAt) < 5 {
+                    +            return false
+                    +        }
+                    +        lastDiscoveryLog[key] = now
+                    +        return true
+                    +    }
+                    +    private func discoveryDescription(peripheral: CBPeripheral, advertising advertismentData: [String: Any], rssi RSSI: NSNumber) -> String {
+                    +        let localName = advertismentData[CBAdvertisementDataLocalNameKey] as? String
+                    +        let services = serviceUUIDs(from: advertismentData, key: CBAdvertisementDataServiceUUIDsKey).map(\.uuidString).joined(separator: ", ")
+                    +        let overflowServices = serviceUUIDs(from: advertismentData, key: CBAdvertisementDataOverflowServiceUUIDsKey).map(\.uuidString).joined(separator: ", ")
+                    +        let solicitedServices = serviceUUIDs(from: advertismentData, key: CBAdvertisementDataSolicitedServiceUUIDsKey).map(\.uuidString).joined(separator: ", ")
+                    +        let manufacturerData = resolvedManufacturerData(from: advertismentData)
+                    +        let manufacturerSummary = manufacturerData.map { "\($0.count)b \($0.hexEncodedStringValue)" } ?? "nil"
+                    +        let txPower = advertismentData[CBAdvertisementDataTxPowerLevelKey].map { "\($0)" } ?? "nil"
+                    +        let connectable = advertismentData[CBAdvertisementDataIsConnectable].map { "\($0)" } ?? "nil"
+                    +        return "id='\(peripheral.identifier)', peripheralName='\(peripheral.name ?? "nil")', localName='\(localName ?? "nil")', resolvedName='\(resolvedPeripheralName(for: peripheral, advertising: advertismentData) ?? "nil")', rssi=\(RSSI), connectable=\(connectable), txPower=\(txPower), services=[\(services)], overflowServices=[\(overflowServices)], solicitedServices=[\(solicitedServices)], manufacturerData=\(manufacturerSummary)"
+                    +    }
+                         private func resolvedPeripheralName(for peripheral: CBPeripheral, advertising advertismentData: [String : Any]) -> String? {
+                             let candidates = [
+                             return nil
+                    +    private func serviceUUIDs(from advertismentData: [String : Any], key: String) -> [CBUUID] {
+                    +        advertismentData[key] as? [CBUUID] ?? []
+                    +    }
+                         private func resolvedManufacturerData(from advertismentData: [String : Any]) -> Data? {
+                             if let data = advertismentData[CBAdvertisementDataManufacturerDataKey] as? Data {

+9 -3

USB Meter/Model/BluetoothRadio.swift

View

@@ -15,10 +15,13 @@ import CoreBluetooth
  - Code [HM10 Bluetooth Serial iOS](https://github.com/hoiberg/HM10-BluetoothSerial-iOS)
  # PW0316
  - Documentation [PW0316 BLE4.0 User Manual](http://www.phangwei.com/o/PW0316_User_Manual_V2.9.pdf)
+ # BT24-M
+ - Seen in newer TC66C units as a transparent BLE serial module on `FFE0`
  */
 enum BluetoothRadio : CaseIterable {
     case BT18
     case PW0316
+    case BT24M
     case UNKNOWN
 }
 
@@ -27,7 +30,8 @@ enum BluetoothRadio : CaseIterable {
  */
 var BluetoothRadioServicesUUIDS: [BluetoothRadio:[CBUUID]] = [
     .BT18 : [CBUUID(string: "FFE0")],
-    .PW0316 : [CBUUID(string: "FFE0"), CBUUID(string: "FFE5")]
+    .PW0316 : [CBUUID(string: "FFE0"), CBUUID(string: "FFE5")],
+    .BT24M : [CBUUID(string: "FFE0")]
 ]
 
 /**
@@ -40,7 +44,8 @@ var BluetoothRadioServicesUUIDS: [BluetoothRadio:[CBUUID]] = [
  */
 var BluetoothRadioNotifyUUIDs: [BluetoothRadio:[CBUUID]] = [
     .BT18 : [CBUUID(string: "FFE1")],
-    .PW0316 : [CBUUID(string: "FFE4")]
+    .PW0316 : [CBUUID(string: "FFE4")],
+    .BT24M : [CBUUID(string: "FFE1")]
 ]
 
 /**
@@ -52,7 +57,8 @@ var BluetoothRadioNotifyUUIDs: [BluetoothRadio:[CBUUID]] = [
  */
 var BluetoothRadioWriteUUIDs: [BluetoothRadio:[CBUUID]] = [
     .BT18 : [CBUUID(string: "FFE2"), CBUUID(string: "FFE1")],
-    .PW0316 : [CBUUID(string: "FFE9")]
+    .PW0316 : [CBUUID(string: "FFE9")],
+    .BT24M : [CBUUID(string: "FFE1")]
 ]
 
 /**


+2 -2

USB Meter/Model/BluetoothSerial.swift

View

@@ -304,7 +304,7 @@ extension BluetoothSerial : CBPeripheralDelegate {
             track( "Error: \(error!)" )
         }
         switch radio {
-        case .BT18:
+        case .BT18, .BT24M:
             for service in peripheral.services! {
                 switch service.uuid {
                 case CBUUID(string: "FFE0"):
@@ -336,7 +336,7 @@ extension BluetoothSerial : CBPeripheralDelegate {
         }
         track("\(String(describing: service.characteristics))")
         switch radio {
-        case .BT18:
+        case .BT18, .BT24M:
             updateBT18Characteristics(for: service)
         case .PW0316:
             updatePW0316Characteristics(for: service)


+9 -1

USB Meter/Model/MeterCapabilities.swift

View

@@ -110,6 +110,14 @@ extension Model {
         }
     )
 
+    static var knownPeripheralNames: [String] {
+        allCases.flatMap(\.peripheralNames).sorted()
+    }
+
+    static func model(forPeripheralName peripheralName: String) -> Model? {
+        byPeripheralName[peripheralName] ?? byPeripheralName[peripheralName.uppercased()]
+    }
+
     var radio: BluetoothRadio {
         switch self {
         case .UM25C, .UM34C:
@@ -126,7 +134,7 @@ extension Model {
         case .UM34C:
             return ["UM34C"]
         case .TC66C:
-            return ["TC66C", "PW0316"]
+            return ["TC66C", "BT24-M"]
         }
     }
 


	@@ -304,7 +304,7 @@ extension BluetoothSerial : CBPeripheralDelegate {
304	304	track( "Error: \(error!)" )
305	305	}
306	306	switch radio {
307		- case .BT18:
	307	+ case .BT18, .BT24M:
308	308	for service in peripheral.services! {
309	309	switch service.uuid {
310	310	case CBUUID(string: "FFE0"):
	@@ -336,7 +336,7 @@ extension BluetoothSerial : CBPeripheralDelegate {
336	336	}
337	337	track("\(String(describing: service.characteristics))")
338	338	switch radio {
339		- case .BT18:
	339	+ case .BT18, .BT24M:
340	340	updateBT18Characteristics(for: service)
341	341	case .PW0316:
342	342	updatePW0316Characteristics(for: service)

	@@ -110,6 +110,14 @@ extension Model {
110	110	}
111	111	)
112	112
	113	+ static var knownPeripheralNames: [String] {
	114	+ allCases.flatMap(\.peripheralNames).sorted()
	115	+ }
	116	+
	117	+ static func model(forPeripheralName peripheralName: String) -> Model? {
	118	+ byPeripheralName[peripheralName] ?? byPeripheralName[peripheralName.uppercased()]
	119	+ }
	120	+
113	121	var radio: BluetoothRadio {
114	122	switch self {
115	123	case .UM25C, .UM34C:
	@@ -126,7 +134,7 @@ extension Model {
126	134	case .UM34C:
127	135	return ["UM34C"]
128	136	case .TC66C:
129		- return ["TC66C", "PW0316"]
	137	+ return ["TC66C", "BT24-M"]
130	138	}
131	139	}
132	140

	@@ -15,10 +15,13 @@ import CoreBluetooth
15	15	- Code [HM10 Bluetooth Serial iOS](https://github.com/hoiberg/HM10-BluetoothSerial-iOS)
16	16	# PW0316
17	17	- Documentation [PW0316 BLE4.0 User Manual](http://www.phangwei.com/o/PW0316_User_Manual_V2.9.pdf)
	18	+ # BT24-M
	19	+ - Seen in newer TC66C units as a transparent BLE serial module on `FFE0`
18	20	*/
19	21	enum BluetoothRadio : CaseIterable {
20	22	case BT18
21	23	case PW0316
	24	+ case BT24M
22	25	case UNKNOWN
23	26	}
24	27
	@@ -27,7 +30,8 @@ enum BluetoothRadio : CaseIterable {
27	30	*/
28	31	var BluetoothRadioServicesUUIDS: [BluetoothRadio:[CBUUID]] = [
29	32	.BT18 : [CBUUID(string: "FFE0")],
30		- .PW0316 : [CBUUID(string: "FFE0"), CBUUID(string: "FFE5")]
	33	+ .PW0316 : [CBUUID(string: "FFE0"), CBUUID(string: "FFE5")],
	34	+ .BT24M : [CBUUID(string: "FFE0")]
31	35	]
32	36
33	37	/**
	@@ -40,7 +44,8 @@ var BluetoothRadioServicesUUIDS: [BluetoothRadio:[CBUUID]] = [
40	44	*/
41	45	var BluetoothRadioNotifyUUIDs: [BluetoothRadio:[CBUUID]] = [
42	46	.BT18 : [CBUUID(string: "FFE1")],
43		- .PW0316 : [CBUUID(string: "FFE4")]
	47	+ .PW0316 : [CBUUID(string: "FFE4")],
	48	+ .BT24M : [CBUUID(string: "FFE1")]
44	49	]
45	50
46	51	/**
	@@ -52,7 +57,8 @@ var BluetoothRadioNotifyUUIDs: [BluetoothRadio:[CBUUID]] = [
52	57	*/
53	58	var BluetoothRadioWriteUUIDs: [BluetoothRadio:[CBUUID]] = [
54	59	.BT18 : [CBUUID(string: "FFE2"), CBUUID(string: "FFE1")],
55		- .PW0316 : [CBUUID(string: "FFE9")]
	60	+ .PW0316 : [CBUUID(string: "FFE9")],
	61	+ .BT24M : [CBUUID(string: "FFE1")]
56	62	]
57	63
58	64	/**