feat: Bose Frames Rondo support #134
Conversation
…mplementing UserHeadingProvider, CalibratableDevice and added connection menu to DeviceViewController
…rivate developer account
…writing sensor config,subscribing to sensor data and decoding. Also flow to register BLE device and a manager to control the device (CalibratableDevice, UserHeadingProvider). Time to test
…but Testflight requires a paid account... Also added a notification about calibration cancelled when disconnecting (if device was currently calibrating)
…ix DeviceViewController and the views in order...
…oved state management for Bose in the DeviceViewController
…EDevice. Notifies delegate instead of requireing subscription to change in the variable. Updated BoseMotionManager and DeviceViewController accordingly. Code cleanup
…Soundscape-EARS. Bugfixes...
…mplementing UserHeadingProvider, CalibratableDevice and added connection menu to DeviceViewController
…rivate developer account
…writing sensor config,subscribing to sensor data and decoding. Also flow to register BLE device and a manager to control the device (CalibratableDevice, UserHeadingProvider). Time to test
…ix DeviceViewController and the views in order...
…oved state management for Bose in the DeviceViewController
…EDevice. Notifies delegate instead of requireing subscription to change in the variable. Updated BoseMotionManager and DeviceViewController accordingly. Code cleanup
#Conflicts: # apps/ios/GuideDogs.xcodeproj/project.pbxproj # apps/ios/GuideDogs/Assets/Localization/en-GB.lproj/Localizable.strings # apps/ios/GuideDogs/Assets/Localization/sv-SE.lproj/Localizable.strings
feat: Bose Frames Rondo support
|
Thanks for doing all this work! Sorry if it takes us a while to get round to merging it. We can't merge without first reverting the unrelated changes such as the app name and entitlements. I see this is from your main branch which you might want to keep as is. I would suggest creating another branch for the PR to keep it separate. You could either create a branch off soundscape-community/soundscape main and then cherry-pick the relevant commits, or branch from your main and revert the unwanted changes. I think the second option would be easier. |
|
I did a quick skim of the diff. I'm not going to comment on the added code; you have a lot more expertise in swift than me. There's only a couple of tiny things I noticed:
It doesn't modify any other functionality of the app, so apart from these minor issues I don't see any problem with merging it. |
1 similar comment
|
I did a quick skim of the diff. I'm not going to comment on the added code; you have a lot more expertise in swift than me. There's only a couple of tiny things I noticed:
It doesn't modify any other functionality of the app, so apart from these minor issues I don't see any problem with merging it. |
|
sorry about the multiple comments, there was a github error every time I pressed submit. |
There was a problem hiding this comment.
Whoa, thanks for all of this! Without a pair of Bose Frames, I can't validate for myself, so I can only provide a few stylistic comments/places where localized strings belong. I'm in agreement with @RDMurray that we can merge after a little cleanup.
| callouts.append(StringCallout(.arHeadset, "Bose frames are connected (TODO: Add localized string for this!)")) | ||
| } else { | ||
| callouts.append(StringCallout(.arHeadset, "Bose frames are not connected (TODO: Add localized string for this!")) //"devices.callouts.check_audio.airpods.disconnected"))) | ||
| } |
There was a problem hiding this comment.
We should address these TODOs before merging, just a few calls to GDLocalizedString.
| // Now, await notification of reading the config value and set new state from there | ||
|
|
||
|
|
||
| /* | ||
| for service in services { | ||
| if (service.uuid == BOSE_FRAMES_SERVICE_CONSTANTS.CBUUID_HEADTRACKING_SERVICE) { | ||
| for c in service.characteristics! { | ||
| switch c.uuid { | ||
| case BOSE_FRAMES_SERVICE_CONSTANTS.CBUUID_HEADTRACKING_CONFIG_CHARACTERISTIC: | ||
| GDLogBLEInfo("Found Bose Config Characteristic") | ||
| self.boseCharacteristicSensorConfig = c | ||
| self.peripheral.readValue(for: c) | ||
|
|
||
| case BOSE_FRAMES_SERVICE_CONSTANTS.CBUUID_HEADTRACKING_DATA_CHARACTERISTIC: | ||
| GDLogBLEInfo("Found Bose Data Characteristic") | ||
| self.boseCharacteristicSensorData = c | ||
| self.peripheral.setNotifyValue(true, for: c) | ||
| continue | ||
|
|
||
| default: | ||
| () // Noop | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| guard boseCharacteristicSensorData != nil && boseCharacteristicSensorConfig != nil else { | ||
| GDLogBLEError("Bose: onConnectionComplete ERROR. Did not find both Config and Data Characteristic. This will not work...") | ||
| return | ||
| } | ||
| */ |
There was a problem hiding this comment.
Can remove this commented-out block.
| /* | ||
| func ping(timeoutInterval: TimeInterval, completion: @escaping ReachabilityCompletion) { | ||
| GDLogHeadphoneMotionInfo("[PING] BoseMotionReachability.ping started") | ||
|
|
||
| guard isActive == false else { | ||
| completion(false) | ||
| return | ||
| } | ||
|
|
||
| isActive = true | ||
| self.completionHandler = completion | ||
|
|
||
| let bleManager = AppContext.shared.bleManager | ||
|
|
||
| bleManager.startScan(for: BoseFramesBLEDevice.self, delegate: boseStateDelegate!) | ||
|
|
||
| // Start timeout on main thread | ||
| DispatchQueue.main.async { [weak self] in | ||
| guard let `self` = self else { | ||
| return | ||
| } | ||
|
|
||
| GDLogHeadphoneMotionInfo("[PING] Awaiting Bose BLE connection...") | ||
| self.timer = Timer.scheduledTimer(withTimeInterval: timeoutInterval, repeats: false) { [weak self] _ in | ||
| guard let `self` = self else { | ||
| return | ||
| } | ||
|
|
||
| GDLogHeadphoneMotionInfo("[PING] Scheduled timer for Bose connection did fire") | ||
| // Timer fired before bose connected `headphoneMotionManagerDidConnect` | ||
| self.cleanup(isReachable: false) | ||
| } | ||
| } | ||
| } | ||
| */ |
There was a problem hiding this comment.
Can remove this commented-out block.
| /* | ||
| fileprivate class BoseDeviceStateDelegate: BLEManagerScanDelegate { | ||
| var boseDevice: BoseFramesBLEDevice? | ||
| var pingHandler: (Bool) -> Void | ||
| init(livePingHandler: @escaping (Bool) -> Void) { | ||
| pingHandler = livePingHandler | ||
| } | ||
|
|
||
| deinit { | ||
| // Stop and reset motion manager | ||
| boseDevice?.stopHeadTracking() | ||
| boseDevice = nil | ||
| } | ||
|
|
||
| func onDeviceStateChanged(_ device: BLEDevice) { | ||
| if let boseDev = device as? BoseFramesBLEDevice { | ||
| if(boseDev.state == .ready) { | ||
| GDLogHeadphoneMotionInfo("[PING] Bose Frames are ready, starting to sample the sensor") | ||
| boseDevice = boseDev | ||
| AppContext.shared.bleManager.stopScan() | ||
| boseDev.headingUpdateDelegate = self | ||
| boseDev.startHeadTracking() | ||
| } else { | ||
| GDLogHeadphoneMotionInfo("[PING] Bose Frames state changed, but still not ready (\(device.state))") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func onDeviceNameChanged(_ device: BLEDevice, _ name: String) { | ||
|
|
||
| } | ||
|
|
||
| func onDevicesChanged(_ discovered: [BLEDevice]) { | ||
| if boseDevice == nil { | ||
| for i in 0..<discovered.count { | ||
| if(discovered[i] is BoseFramesBLEDevice) { | ||
| boseDevice = (discovered[i] as! BoseFramesBLEDevice) | ||
| boseDevice?.stateDidChangeDelegate = self | ||
| return | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| extension BoseDeviceStateDelegate: BoseBLEStateChangeDelegate { | ||
| func onBoseDeviceStateChange(oldState: BLEDeviceState, newState: BLEDeviceState) { | ||
| <#code#> | ||
| } | ||
|
|
||
| func onBoseDeviceReady() { | ||
| GDLogHeadphoneMotionInfo("[PING] Bose Frames are ready (but doing nothing, as I think this was handled above)") | ||
| } | ||
|
|
||
| func onBoseDeviceDisconnected() { | ||
|
|
||
| } | ||
|
|
||
|
|
||
| } | ||
| extension BoseDeviceStateDelegate: BoseHeadingUpdateDelegate { | ||
| func onHeadingUpdate(newHeading: HeadingValue!) { | ||
| GDLogHeadphoneMotionInfo("[PING] BoseMotionReachability received a heading update") | ||
| self.pingHandler(true) | ||
| } | ||
| } | ||
| */ |
There was a problem hiding this comment.
Can remove this commented-out block.
| /* | ||
| case self.currentSensorConfig?.accelerometerId: | ||
| GDLogBLEInfo("Got an accellerometer data update, read 10 bytes: \(valueAsArr)") | ||
| processVectorData(vectorByteArray: valueAsArr) | ||
| return | ||
|
|
||
| case self.currentSensorConfig?.gyroscopeId: | ||
| GDLogBLEInfo("Got an gyroscope data update, read 10 bytes: \(valueAsArr)") | ||
| processVectorData(vectorByteArray: valueAsArr) | ||
| return | ||
|
|
||
|
|
||
| case self.currentSensorConfig?.gamerotationId: | ||
| GDLogBLEInfo("Got an gameRotation data update, read 11(!) bytes: \(valueAsArr)") | ||
| processQuaternionData(quaternionByteArray: valueAsArr, hasAccuracy: false) | ||
| return | ||
|
|
||
| default: | ||
| GDLogBLEError("READ: Unknown sensor!") | ||
| return | ||
| */ |
There was a problem hiding this comment.
Can remove this commented-out block.
| // I think this one was wrong... | ||
| /* var vecX: [Int16] = [_matrix.elements[0], _matrix.elements[4], _matrix.elements[8]] | ||
| var vecY: [Int16] = [_matrix.elements[1], _matrix.elements[5], _matrix.elements[9]] | ||
| var vecZ: [Int16] = [_matrix.elements[2], _matrix.elements[6], _matrix.elements[10]] | ||
| */ | ||
|
|
There was a problem hiding this comment.
Can remove this commented-out block.
| case .ready: | ||
| return GDLocalizedString("settings.bluetooth.forget") | ||
| default: | ||
| return "What should we put here? What can the device state be when View.state is .paired" |
There was a problem hiding this comment.
Maybe return GDLocalizationUnnecessary("")?
Glad that our work can be of use. And no worries about taking time to merge. On our side, we're deploying from our develop-branch, so we're not blocked. Take your time :)
We were planning to use Thanks for the quick feedback! We'll address the comments shortly! |
This pull request adds support for Bose Frames Rondo.
A few notes:
accuracy_calibration_required_threshold)