mirror of
https://github.com/meshtastic/Meshtastic-Android.git
synced 2026-04-20 22:23:37 +00:00
445 lines
18 KiB
Kotlin
445 lines
18 KiB
Kotlin
package com.geeksville.mesh.service
|
|
|
|
import android.bluetooth.BluetoothAdapter
|
|
import android.bluetooth.BluetoothGattCharacteristic
|
|
import android.bluetooth.BluetoothGattService
|
|
import android.bluetooth.BluetoothManager
|
|
import android.content.Context
|
|
import com.geeksville.analytics.DataPair
|
|
import com.geeksville.android.GeeksvilleApplication
|
|
import com.geeksville.android.Logging
|
|
import com.geeksville.concurrent.handledLaunch
|
|
import com.geeksville.util.anonymize
|
|
import com.geeksville.util.exceptionReporter
|
|
import com.geeksville.util.ignoreException
|
|
import kotlinx.coroutines.delay
|
|
import java.lang.reflect.Method
|
|
import java.util.*
|
|
|
|
|
|
/* Info for the esp32 device side code. See that source for the 'gold' standard docs on this interface.
|
|
|
|
MeshBluetoothService UUID 6ba1b218-15a8-461f-9fa8-5dcae273eafd
|
|
|
|
FIXME - notify vs indication for fromradio output. Using notify for now, not sure if that is best
|
|
FIXME - in the esp32 mesh management code, occasionally mirror the current net db to flash, so that if we reboot we still have a good guess of users who are out there.
|
|
FIXME - make sure this protocol is guaranteed robust and won't drop packets
|
|
|
|
"According to the BLE specification the notification length can be max ATT_MTU - 3. The 3 bytes subtracted is the 3-byte header(OP-code (operation, 1 byte) and the attribute handle (2 bytes)).
|
|
In BLE 4.1 the ATT_MTU is 23 bytes (20 bytes for payload), but in BLE 4.2 the ATT_MTU can be negotiated up to 247 bytes."
|
|
|
|
MAXPACKET is 256? look into what the lora lib uses. FIXME
|
|
|
|
Characteristics:
|
|
UUID
|
|
properties
|
|
description
|
|
|
|
8ba2bcc2-ee02-4a55-a531-c525c5e454d5
|
|
read
|
|
fromradio - contains a newly received packet destined towards the phone (up to MAXPACKET bytes? per packet).
|
|
After reading the esp32 will put the next packet in this mailbox. If the FIFO is empty it will put an empty packet in this
|
|
mailbox.
|
|
|
|
f75c76d2-129e-4dad-a1dd-7866124401e7
|
|
write
|
|
toradio - write ToRadio protobufs to this charstic to send them (up to MAXPACKET len)
|
|
|
|
ed9da18c-a800-4f66-a670-aa7547e34453
|
|
read|notify|write
|
|
fromnum - the current packet # in the message waiting inside fromradio, if the phone sees this notify it should read messages
|
|
until it catches up with this number.
|
|
The phone can write to this register to go backwards up to FIXME packets, to handle the rare case of a fromradio packet was dropped after the esp32
|
|
callback was called, but before it arrives at the phone. If the phone writes to this register the esp32 will discard older packets and put the next packet >= fromnum in fromradio.
|
|
When the esp32 advances fromnum, it will delay doing the notify by 100ms, in the hopes that the notify will never actally need to be sent if the phone is already pulling from fromradio.
|
|
Note: that if the phone ever sees this number decrease, it means the esp32 has rebooted.
|
|
|
|
Re: queue management
|
|
Not all messages are kept in the fromradio queue (filtered based on SubPacket):
|
|
* only the most recent Position and User messages for a particular node are kept
|
|
* all Data SubPackets are kept
|
|
* No WantNodeNum / DenyNodeNum messages are kept
|
|
A variable keepAllPackets, if set to true will suppress this behavior and instead keep everything for forwarding to the phone (for debugging)
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/**
|
|
* Handles the bluetooth link with a mesh radio device. Does not cache any device state,
|
|
* just does bluetooth comms etc...
|
|
*
|
|
* This service is not exposed outside of this process.
|
|
*
|
|
* Note - this class intentionally dumb. It doesn't understand protobuf framing etc...
|
|
* It is designed to be simple so it can be stubbed out with a simulated version as needed.
|
|
*/
|
|
class BluetoothInterface(val service: RadioInterfaceService, val address: String) : IRadioInterface,
|
|
Logging {
|
|
|
|
companion object : Logging {
|
|
|
|
/// this service UUID is publically visible for scanning
|
|
val BTM_SERVICE_UUID = UUID.fromString("6ba1b218-15a8-461f-9fa8-5dcae273eafd")
|
|
|
|
val BTM_FROMRADIO_CHARACTER =
|
|
UUID.fromString("8ba2bcc2-ee02-4a55-a531-c525c5e454d5")
|
|
val BTM_TORADIO_CHARACTER =
|
|
UUID.fromString("f75c76d2-129e-4dad-a1dd-7866124401e7")
|
|
val BTM_FROMNUM_CHARACTER =
|
|
UUID.fromString("ed9da18c-a800-4f66-a670-aa7547e34453")
|
|
|
|
/// Get our bluetooth adapter (should always succeed except on emulator
|
|
private fun getBluetoothAdapter(context: Context): BluetoothAdapter? {
|
|
val bluetoothManager =
|
|
context.getSystemService(Context.BLUETOOTH_SERVICE) as BluetoothManager
|
|
return bluetoothManager.adapter
|
|
}
|
|
|
|
/** Return true if this address is still acceptable. For BLE that means, still bonded */
|
|
fun addressValid(context: Context, address: String): Boolean {
|
|
val allPaired =
|
|
getBluetoothAdapter(context)?.bondedDevices.orEmpty().map { it.address }.toSet()
|
|
|
|
return if (!allPaired.contains(address)) {
|
|
warn("Ignoring stale bond to ${address.anonymize}")
|
|
false
|
|
} else
|
|
true
|
|
}
|
|
|
|
|
|
/// Return the device we are configured to use, or null for none
|
|
/*
|
|
@SuppressLint("NewApi")
|
|
fun getBondedDeviceAddress(context: Context): String? =
|
|
if (hasCompanionDeviceApi(context)) {
|
|
// Use new companion API
|
|
|
|
val deviceManager = context.getSystemService(CompanionDeviceManager::class.java)
|
|
val associations = deviceManager.associations
|
|
val result = associations.firstOrNull()
|
|
debug("reading bonded devices: $result")
|
|
result
|
|
} else {
|
|
// Use classic API and a preferences string
|
|
|
|
val allPaired =
|
|
getBluetoothAdapter(context)?.bondedDevices.orEmpty().map { it.address }.toSet()
|
|
|
|
// If the user has unpaired our device, treat things as if we don't have one
|
|
val address = InterfaceService.getPrefs(context).getString(DEVADDR_KEY, null)
|
|
|
|
if (address != null && !allPaired.contains(address)) {
|
|
warn("Ignoring stale bond to ${address.anonymize}")
|
|
null
|
|
} else
|
|
address
|
|
}
|
|
*/
|
|
|
|
/// Can we use the modern BLE scan API?
|
|
fun hasCompanionDeviceApi(context: Context): Boolean = false /* ALAS - not ready for production yet
|
|
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
|
|
val res =
|
|
context.packageManager.hasSystemFeature(PackageManager.FEATURE_COMPANION_DEVICE_SETUP)
|
|
debug("CompanionDevice API available=$res")
|
|
res
|
|
} else {
|
|
warn("CompanionDevice API not available, falling back to classic scan")
|
|
false
|
|
} */
|
|
|
|
/** FIXME - when adding companion device support back in, use this code to set companion device from setBondedDevice
|
|
* if (BluetoothInterface.hasCompanionDeviceApi(this)) {
|
|
// We only keep an association to one device at a time...
|
|
if (addr != null) {
|
|
val deviceManager = getSystemService(CompanionDeviceManager::class.java)
|
|
|
|
deviceManager.associations.forEach { old ->
|
|
if (addr != old) {
|
|
BluetoothInterface.debug("Forgetting old BLE association $old")
|
|
deviceManager.disassociate(old)
|
|
}
|
|
}
|
|
}
|
|
*/
|
|
|
|
/**
|
|
* this is created in onCreate()
|
|
* We do an ugly hack of keeping it in the singleton so we can share it for the rare software update case
|
|
*/
|
|
var safe: SafeBluetooth? = null
|
|
}
|
|
|
|
|
|
/// Our BLE device
|
|
val device get() = safe?.gatt ?: throw RadioNotConnectedException("No GATT")
|
|
|
|
/// Our service - note - it is possible to get back a null response for getService if the device services haven't yet been found
|
|
val bservice
|
|
get(): BluetoothGattService = device.getService(BTM_SERVICE_UUID)
|
|
?: throw RadioNotConnectedException("BLE service not found")
|
|
|
|
private lateinit var fromNum: BluetoothGattCharacteristic
|
|
|
|
/**
|
|
* With the new rev2 api, our first send is to start the configure readbacks. In that case,
|
|
* rather than waiting for FromNum notifies - we try to just aggressively read all of the responses.
|
|
*/
|
|
private var isFirstSend = true
|
|
|
|
init {
|
|
// Note: this call does no comms, it just creates the device object (even if the
|
|
// device is off/not connected)
|
|
val device = getBluetoothAdapter(service)?.getRemoteDevice(address)
|
|
if (device != null) {
|
|
info("Creating radio interface service. device=${address.anonymize}")
|
|
|
|
// Note this constructor also does no comm
|
|
val s = SafeBluetooth(service, device)
|
|
safe = s
|
|
|
|
startConnect()
|
|
} else {
|
|
errormsg("Bluetooth adapter not found, assuming running on the emulator!")
|
|
}
|
|
}
|
|
|
|
|
|
/// Send a packet/command out the radio link
|
|
override fun handleSendToRadio(a: ByteArray) {
|
|
try {
|
|
safe?.let { s ->
|
|
val uuid = BTM_TORADIO_CHARACTER
|
|
debug("queuing ${a.size} bytes to $uuid")
|
|
|
|
// Note: we generate a new characteristic each time, because we are about to
|
|
// change the data and we want the data stored in the closure
|
|
val toRadio = getCharacteristic(uuid)
|
|
toRadio.value = a
|
|
|
|
s.asyncWriteCharacteristic(toRadio) { r ->
|
|
try {
|
|
r.getOrThrow()
|
|
debug("write of ${a.size} bytes completed")
|
|
|
|
if (isFirstSend) {
|
|
isFirstSend = false
|
|
doReadFromRadio(false)
|
|
}
|
|
} catch (ex: Exception) {
|
|
warn("error during asyncWriteCharacteristic - disconnecting, ${ex.message}")
|
|
service.serviceScope.handledLaunch { retryDueToException() }
|
|
}
|
|
}
|
|
}
|
|
} catch (ex: BLEException) {
|
|
warn("error during handleSendToRadio - disconnecting, ${ex.message}")
|
|
service.serviceScope.handledLaunch { retryDueToException() }
|
|
}
|
|
}
|
|
|
|
|
|
/// Attempt to read from the fromRadio mailbox, if data is found broadcast it to android apps
|
|
private fun doReadFromRadio(firstRead: Boolean) {
|
|
safe?.let { s ->
|
|
val fromRadio = getCharacteristic(BTM_FROMRADIO_CHARACTER)
|
|
s.asyncReadCharacteristic(fromRadio) {
|
|
try {
|
|
val b = it.getOrThrow()
|
|
.value.clone() // We clone the array just in case, I'm not sure if they keep reusing the array
|
|
|
|
if (b.isNotEmpty()) {
|
|
debug("Received ${b.size} bytes from radio")
|
|
service.handleFromRadio(b)
|
|
|
|
// Queue up another read, until we run out of packets
|
|
doReadFromRadio(firstRead)
|
|
} else {
|
|
debug("Done reading from radio, fromradio is empty")
|
|
if (firstRead) // If we just finished our initial download, now we want to start listening for notifies
|
|
startWatchingFromNum()
|
|
}
|
|
} catch (ex: BLEException) {
|
|
warn("error during doReadFromRadio - disconnecting, ${ex.message}")
|
|
service.serviceScope.handledLaunch { retryDueToException() }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Android caches old services. But our service is still changing often, so force it to reread the service definitions every
|
|
* time
|
|
*/
|
|
private fun forceServiceRefresh() {
|
|
exceptionReporter {
|
|
// BluetoothGatt gatt
|
|
val gatt = safe!!.gatt!!
|
|
val refresh: Method = gatt.javaClass.getMethod("refresh")
|
|
refresh.invoke(gatt)
|
|
}
|
|
}
|
|
|
|
/// We only force service refresh the _first_ time we connect to the device. Thereafter it is assumed the firmware didn't change
|
|
private var hasForcedRefresh = false
|
|
|
|
@Volatile
|
|
var fromNumChanged = false
|
|
|
|
private fun startWatchingFromNum() {
|
|
safe!!.setNotify(fromNum, true) {
|
|
// We might get multiple notifies before we get around to reading from the radio - so just set one flag
|
|
fromNumChanged = true
|
|
debug("fromNum changed")
|
|
service.serviceScope.handledLaunch {
|
|
if (fromNumChanged) {
|
|
fromNumChanged = false
|
|
debug("fromNum changed, so we are reading new messages")
|
|
doReadFromRadio(false)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Some buggy BLE stacks can fail on initial connect, with either missing services or missing characteristics. If that happens we
|
|
* disconnect and try again when the device reenumerates.
|
|
*/
|
|
private suspend fun retryDueToException() {
|
|
// Track how often in the field we need this hack
|
|
GeeksvilleApplication.analytics.track(
|
|
"ble_reconnect_hack",
|
|
DataPair(1)
|
|
)
|
|
|
|
/// We gracefully handle safe being null because this can occur if someone has unpaired from our device - just abandon the reconnect attempt
|
|
val s = safe
|
|
if (s != null) {
|
|
warn("Forcing disconnect and hopefully device will comeback (disabling forced refresh)")
|
|
hasForcedRefresh = true
|
|
ignoreException {
|
|
s.closeConnection()
|
|
}
|
|
delay(1000) // Give some nasty time for buggy BLE stacks to shutdown (500ms was not enough)
|
|
warn("Attempting reconnect")
|
|
startConnect()
|
|
} else {
|
|
warn("Abandoning reconnect because safe==null, someone must have closed the device")
|
|
}
|
|
}
|
|
|
|
/// We only try to set MTU once, because some buggy implementations fail
|
|
@Volatile
|
|
private var shouldSetMtu = true
|
|
|
|
/// For testing
|
|
@Volatile
|
|
private var isFirstTime = true
|
|
|
|
private fun doDiscoverServicesAndInit() {
|
|
// FIXME - no need to discover services more than once - instead use lazy() to use them in future attempts
|
|
safe!!.asyncDiscoverServices { discRes ->
|
|
discRes.getOrThrow() // FIXME, instead just try to reconnect?
|
|
|
|
service.serviceScope.handledLaunch {
|
|
try {
|
|
debug("Discovered services!")
|
|
delay(1000) // android BLE is buggy and needs a 500ms sleep before calling getChracteristic, or you might get back null
|
|
|
|
/* if (isFirstTime) {
|
|
isFirstTime = false
|
|
throw BLEException("Faking a BLE failure")
|
|
} */
|
|
|
|
fromNum = getCharacteristic(BTM_FROMNUM_CHARACTER)
|
|
|
|
// We treat the first send by a client as special
|
|
isFirstSend = true
|
|
|
|
// Now tell clients they can (finally use the api)
|
|
service.broadcastConnectionChanged(true, isPermanent = false)
|
|
|
|
// Immediately broadcast any queued packets sitting on the device
|
|
doReadFromRadio(true)
|
|
} catch (ex: BLEException) {
|
|
errormsg(
|
|
"Unexpected error in initial device enumeration, forcing disconnect",
|
|
ex
|
|
)
|
|
retryDueToException()
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
private fun onConnect(connRes: Result<Unit>) {
|
|
// This callback is invoked after we are connected
|
|
|
|
connRes.getOrThrow()
|
|
info("Connected to radio!")
|
|
|
|
if (!hasForcedRefresh) {
|
|
// FIXME - for some reason we need to refresh _everytime_. It is almost as if we've cached wrong descriptor fieldnums forever
|
|
// hasForcedRefresh = true
|
|
forceServiceRefresh()
|
|
}
|
|
|
|
// we begin by setting our MTU size as high as it can go (if we can)
|
|
if (shouldSetMtu)
|
|
safe!!.asyncRequestMtu(512) { mtuRes ->
|
|
try {
|
|
mtuRes.getOrThrow() // FIXME - why sometimes is the result Unit!?!
|
|
debug("MTU change attempted")
|
|
|
|
// throw BLEException("Test MTU set failed")
|
|
|
|
doDiscoverServicesAndInit()
|
|
} catch (ex: BLEException) {
|
|
errormsg(
|
|
"Giving up on setting MTUs, forcing disconnect",
|
|
ex
|
|
)
|
|
shouldSetMtu = false
|
|
service.serviceScope.handledLaunch { retryDueToException() }
|
|
}
|
|
}
|
|
else
|
|
doDiscoverServicesAndInit()
|
|
}
|
|
|
|
|
|
override fun close() {
|
|
if (safe != null) {
|
|
info("Closing radio interface service")
|
|
val s = safe
|
|
safe =
|
|
null // We do this first, because if we throw we still want to mark that we no longer have a valid connection
|
|
|
|
s?.close()
|
|
} else {
|
|
debug("Radio was not connected, skipping disable")
|
|
}
|
|
}
|
|
|
|
/// Start a connection attempt
|
|
private fun startConnect() {
|
|
// we pass in true for autoconnect - so we will autoconnect whenever the radio
|
|
// comes in range (even if we made this connect call long ago when we got powered on)
|
|
// see https://stackoverflow.com/questions/40156699/which-correct-flag-of-autoconnect-in-connectgatt-of-ble for
|
|
// more info
|
|
safe!!.asyncConnect(true, // FIXME, sometimes this seems to not work or take a very long time!
|
|
cb = ::onConnect,
|
|
lostConnectCb = { service.onDisconnect(isPermanent = false) })
|
|
}
|
|
|
|
|
|
/**
|
|
* Get a chracteristic, but in a safe manner because some buggy BLE implementations might return null
|
|
*/
|
|
private fun getCharacteristic(uuid: UUID) =
|
|
bservice.getCharacteristic(uuid) ?: throw BLEException("Can't get characteristic $uuid")
|
|
|
|
}
|