package com.geeksville.mesh.service import android.annotation.SuppressLint import android.bluetooth.BluetoothAdapter import android.bluetooth.BluetoothGattCharacteristic import android.bluetooth.BluetoothGattService import android.bluetooth.BluetoothManager import android.companion.CompanionDeviceManager import android.content.Context import androidx.core.content.edit 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 com.geeksville.util.toRemoteExceptions 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. meshMyNodeCharacteristic("ea9f3f82-8dc4-4733-9452-1f6da28892a2", BLECharacteristic::PROPERTY_READ) mynode - read/write this to access a MyNodeInfo protobuf meshNodeInfoCharacteristic("d31e02e0-c8ab-4d3f-9cc9-0b8466bdabe8", BLECharacteristic::PROPERTY_WRITE | BLECharacteristic::PROPERTY_READ), nodeinfo - read this to get a series of node infos (ending with a null empty record), write to this to restart the read statemachine that returns all the node infos meshRadioCharacteristic("b56786c8-839a-44a1-b98e-a1724c4a0262", BLECharacteristic::PROPERTY_WRITE | BLECharacteristic::PROPERTY_READ), radio - read/write this to access a RadioConfig protobuf meshOwnerCharacteristic("6ff1d8b6-e2de-41e3-8c0b-8fa384f64eb6", BLECharacteristic::PROPERTY_WRITE | BLECharacteristic::PROPERTY_READ) owner - read/write this to access a User protobuf 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 BluetoothInterfaceService : InterfaceService() { 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") /// If our service is currently running, this pointer can be used to reach it (in case setBondedDeviceAddress is called) private var runningService: BluetoothInterfaceService? = null /// 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 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 = 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 } */ /** * 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 service 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 /// Send a packet/command out the radio link override fun handleSendToRadio(p: ByteArray) { try { debug("sending to radio") doWrite( BTM_TORADIO_CHARACTER, p ) // Do a synchronous write, so that we can then do our reads if needed if (logSends) { sentPacketsLog.write(p) sentPacketsLog.flush() } if (isFirstSend) { isFirstSend = false doReadFromRadio(false) } } catch (ex: Exception) { errormsg("Ignoring sendToRadio exception: $ex") } } /// Attempt to read from the fromRadio mailbox, if data is found broadcast it to android apps private fun doReadFromRadio(firstRead: Boolean) { if (!isConnected) warn("Abandoning fromradio read because we are not connected") else { val fromRadio = getCharacteristic(BTM_FROMRADIO_CHARACTER) safe!!.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") 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) { errormsg( "error during doReadFromRadio", ex ) serviceScope.handledLaunch { retryDueToException() } } } } } @SuppressLint("NewApi") override fun setBondedDeviceAddress(addr: String?) { // Record that this use has configured a radio GeeksvilleApplication.analytics.track( "mesh_bond" ) // Ignore any errors that happen while closing old device ignoreException { Companion.info("shutting down old service") setEnabled(false) // nasty, needed to force the next setEnabled call to reconnect } debug("Setting bonded device to $addr") if (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) { Companion.debug("Forgetting old BLE association $old") deviceManager.disassociate(old) } } } } else { getPrefs(this).edit(commit = true) { if (addr == null) this.remove(DEVADDR_KEY) else putString(DEVADDR_KEY, addr) } } // Force the service to reconnect if (addr != null) { info("Setting enable on the running radio service") setEnabled(true) } } /** * 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 private fun startWatchingFromNum() { safe!!.setNotify(fromNum, true) { 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 private var shouldSetMtu = true /// For testing 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? 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 must set this to true before broadcasting connectionChanged isConnected = true // We treat the first send by a client as special isFirstSend = true // Now tell clients they can (finally use the api) 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) { // 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 serviceScope.handledLaunch { retryDueToException() } } } else doDiscoverServicesAndInit() } /** * If the user turns on bluetooth after we start, make sure to try and reconnected then */ private val bluetoothStateReceiver = BluetoothStateReceiver { enabled -> if (enabled) setEnabled(true) } override fun onCreate() { runningService = this super.onCreate() registerReceiver(bluetoothStateReceiver, bluetoothStateReceiver.intent) } override fun onDestroy() { unregisterReceiver(bluetoothStateReceiver) runningService = null super.onDestroy() } /// 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 = { onDisconnect(isPermanent = false) }) } /// Open or close a bluetooth connection to our device override fun setEnabled(on: Boolean) { super.setEnabled(on) if (on) { if (safe != null) { info("Skipping radio enable, it is already on") } else { val address = getBondedDeviceAddress(this) if (address == null) errormsg("No bonded mesh radio, can't start service") else { // Note: this call does no comms, it just creates the device object (even if the // device is off/not connected) val device = getBluetoothAdapter(this)?.getRemoteDevice(address) if (device != null) { info("Creating radio interface service. device=${address.anonymize}") // Note this constructor also does no comm val s = SafeBluetooth(this, device) safe = s startConnect() } else { errormsg("Bluetooth adapter not found, assuming running on the emulator!") } } } } else { 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") } } } /** * do a synchronous write operation */ private fun doWrite(uuid: UUID, a: ByteArray) = toRemoteExceptions { if (!isConnected) throw RadioNotConnectedException() else { 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 safe!!.writeCharacteristic(toRadio) debug("write of ${a.size} bytes completed") } } /** * Get a chracteristic, but in a safe manner because some buggy BLE implementations might return null */ private fun getCharacteristic(uuid: UUID) = service.getCharacteristic(uuid) ?: throw BLEException("Can't get characteristic $uuid") }