refactor(ble): Replace custom BLE implementation with Nordic #3595
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… BLE library This commit replaces the entire custom Bluetooth Low Energy (BLE) implementation with the modern, coroutine-based Nordic Semiconductor Kotlin BLE library. The legacy implementation, spread across `SafeBluetooth`, `BluetoothWorkQueue`, and `BluetoothInterface`, was complex, prone to race conditions, and difficult to maintain. Specific changes include: - Deleting the legacy BLE classes: `BluetoothInterface`, `SafeBluetooth`, `SafeBluetoothGattCallback`, and `BluetoothWorkQueue`. - Introducing `NordicBleInterface` which leverages the Kotlin BLE library to manage BLE connections, service discovery, and communication. - Adding the `no.nordicsemi.kotlin.ble:client-android` library dependency. - Refactoring `RadioInterfaceService` and related factory/module classes to use the new `NordicBleInterface` instead of the old `BluetoothInterface`. - Simplifying the connection logic by removing manual workarounds like forced service refreshes and complex reconnect scheduling. Signed-off-by: James Rich <[email protected]>
This commit refactors the Nordic BLE interface to improve reliability and performance. The previous implementation is replaced with a more robust event-driven model based on the `FROMNUM` notification characteristic. Key changes: - Switched from subscribing to `FROMRADIO` to subscribing to `FROMNUM` notifications. - Implemented a packet queue draining mechanism that reads from the `FROMRADIO` characteristic after a `FROMNUM` notification is received. - Introduced a `Mutex` to serialize access to the packet queue, preventing race conditions. - Drains the packet queue upon initial connection and after writes to ensure pending data is processed promptly. - Centralized coroutine management under the `RadioInterfaceService`'s scope for better lifecycle control. - Added extensive `Timber` logging and error handling throughout the BLE and radio service code to improve debuggability and prevent crashes. - Moved the Nordic BLE library dependency to `libs.versions.toml`. Signed-off-by: James Rich <[email protected]>
This commit refactors the device connection and configuration logic to improve reliability, particularly over BLE.
- **Two-Stage Configuration:** The configuration process is now split into two distinct stages: `config-only` and `node-info`. This mirrors the implementation in Meshtastic-Apple and helps prevent issues with stale BLE packets during initial connection. Each stage uses a unique nonce (`configOnlyNonce`, `nodeInfoNonce`) for verification.
- **BLE Stability:**
- A heartbeat is now sent between the two configuration stages to keep the BLE link active.
- The `onDisconnect` call in `NordicBleInterface` now passes `false`, preventing automatic reconnection attempts on explicit disconnects or connection failures.
- The delay between packet-queue reads (`INTER_READ_DELAY_MS`) has been reduced from 20ms to 5ms for faster processing.
- **Logging and Debugging:**
- Added more detailed logging for unhandled `FromRadio` protocol buffer variants.
- Cleaned up comments and removed unnecessary code related to the old single-stage config flow.
- Minor exception handling and code style cleanups.
Signed-off-by: James Rich <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Work In Progress - This is not yet functional.
This pull request migrates the Bluetooth radio interface implementation to use the new Nordic BLE client library, replacing the previous custom Bluetooth logic. The main changes include introducing the new
NordicBleInterfaceclass and updating related factories, specs, dependency injection bindings, and service logic to use this new implementation. Additionally, the legacyBluetoothWorkQueueand related classes have been removed, as they are no longer needed with the new BLE library.Migration to Nordic BLE client library:
NordicBleInterfaceclass, which uses the Nordic BLE client library for scanning, connecting, service/characteristic discovery, and data transfer, replacing the previous custom Bluetooth logic. (app/src/main/java/com/geeksville/mesh/repository/radio/NordicBleInterface.kt)app/build.gradle.kts)Refactoring factories, specs, and dependency injection:
NordicBleInterfaceinstead ofBluetoothInterface, updating their names and references throughout the codebase. (app/src/main/java/com/geeksville/mesh/repository/radio/NordicBleInterfaceFactory.kt,app/src/main/java/com/geeksville/mesh/repository/radio/NordicBleInterfaceSpec.kt) [1] [2]NordicBleInterfaceSpecfor the Bluetooth interface ID. (app/src/main/java/com/geeksville/mesh/repository/radio/RadioRepositoryModule.kt)Service logic updates:
NordicBleInterfaceinstead ofBluetoothInterfacefor starting and stopping the radio interface. (app/src/main/java/com/geeksville/mesh/repository/radio/RadioInterfaceService.kt)Removal of legacy Bluetooth work queue:
BluetoothWorkQueueand related work item classes, which are now obsolete due to the migration to the Nordic BLE library. (app/src/main/java/com/geeksville/mesh/service/BluetoothWorkQueue.kt)