Trio/FreeAPS/Sources/APS/CGM/BluetoothTransmitter.swift

import CoreBluetooth
import Foundation
import os

/// Generic bluetoothtransmitter class that handles scanning, connect, discover services, discover characteristics, subscribe to receive characteristic, reconnect.
///
/// - the connection will be set up and a subscribe to a characteristic will be done
/// - a heartbeat function is called each time there's a disconnect (needed for Dexcom) or if there's data received on the receive characteristic
/// - the class does nothing with the data itself
class BluetoothTransmitter: NSObject, CBCentralManagerDelegate, CBPeripheralDelegate {
    // MARK: - private properties

    /// the address of the transmitter.
    private let deviceAddress: String

    /// services to be discovered
    private let servicesCBUUIDs: [CBUUID]

    /// receive characteristic to which we should subcribe in order to awake the app when the tarnsmitter sends data
    private let CBUUID_ReceiveCharacteristic: String

    /// centralManager
    private var centralManager: CBCentralManager?

    /// the receive Characteristic
    private var receiveCharacteristic: CBCharacteristic?

    /// peripheral, gets value during connect
    private(set) var peripheral: CBPeripheral?

    /// to be called when data is received or if there's a disconnect, this is the actual heartbeat.
    private let heartbeat: () -> Void

    // MARK: - Initialization

    /// - parameters:
    ///     - deviceAddress : the bluetooth Mac address
    ///     - one serviceCBUUID: as string, this is the service to be discovered
    ///     - CBUUID_Receive: receive characteristic uuid as string, to which subscribe should be done
    ///     - heartbeat  : function to call when data is received on the receive characteristic or when there's a disconnect
    init(deviceAddress: String, servicesCBUUID: String, CBUUID_Receive: String, heartbeat: @escaping () -> Void) {
        servicesCBUUIDs = [CBUUID(string: servicesCBUUID)]

        CBUUID_ReceiveCharacteristic = CBUUID_Receive

        self.deviceAddress = deviceAddress

        self.heartbeat = heartbeat

        let cBCentralManagerOptionRestoreIdentifierKeyToUse = "Loop-" + deviceAddress

        super.init()

        debug(.deviceManager, "in initialize, creating centralManager for peripheral with address \(deviceAddress)")

        centralManager = CBCentralManager(
            delegate: self,
            queue: nil,
            options: [
                CBCentralManagerOptionShowPowerAlertKey: true,
                CBCentralManagerOptionRestoreIdentifierKey: cBCentralManagerOptionRestoreIdentifierKeyToUse
            ]
        )

        // connect to the device
        connect()
    }

    // MARK: - De-initialization

    deinit {
        debug(.deviceManager, "deinit called")

        // disconnect the device
        disconnect()
    }

    // MARK: - public functions

    /// will try to connect to the device, first by calling retrievePeripherals, if peripheral not known, then by calling startScanning
    func connect() {
        if !retrievePeripherals(centralManager!) {
            startScanning()
        }
    }

    /// disconnect the device
    func disconnect() {
        if let peripheral = peripheral {
            var name = "unknown"
            if let peripheralName = peripheral.name {
                name = peripheralName
            }

            debug(.deviceManager, "disconnecting from peripheral with name \(name)")

            centralManager!.cancelPeripheralConnection(peripheral)
        }
    }

    /// stops scanning
    func stopScanning() {
        debug(.deviceManager, "in stopScanning")

        centralManager!.stopScan()
    }

    /// calls setNotifyValue for characteristic with value enabled
    func setNotifyValue(_ enabled: Bool, for characteristic: CBCharacteristic) {
        if let peripheral = peripheral {
            debug(
                .deviceManager,
                "setNotifyValue, for peripheral with name \(peripheral.name ?? "'unknown'"), setting notify for characteristic \(characteristic.uuid.uuidString), to \(enabled.description)"
            )
            peripheral.setNotifyValue(enabled, for: characteristic)

        } else {
            debug(
                .deviceManager,
                "setNotifyValue, for peripheral with name \(peripheral?.name ?? "'unknown'"), failed to set notify for characteristic \(characteristic.uuid.uuidString), to \(enabled.description)"
            )
        }
    }

    // MARK: - fileprivate functions

    /// start bluetooth scanning for device
    fileprivate func startScanning() {
        if centralManager!.state == .poweredOn {
            debug(.deviceManager, "in startScanning")

            centralManager!.scanForPeripherals(withServices: nil, options: nil)

        } else {
            debug(.deviceManager, "in startScanning. Not started, state is not poweredOn")
        }
    }

    /// stops scanning and connect. To be called after diddiscover
    fileprivate func stopScanAndconnect(to peripheral: CBPeripheral) {
        centralManager!.stopScan()

        self.peripheral = peripheral

        peripheral.delegate = self

        if peripheral.state == .disconnected {
            debug(.deviceManager, "    trying to connect")

            centralManager!.connect(peripheral, options: nil)

        } else {
            debug(.deviceManager, "    calling centralManager(newCentralManager, didConnect: peripheral")

            centralManager(centralManager!, didConnect: peripheral)
        }
    }

    /// try to connect to peripheral to which connection was successfully done previously, and that has a uuid that matches the stored deviceAddress. If such peripheral exists, then try to connect, it's not necessary to start scanning. iOS will connect as soon as the peripheral comes in range, or bluetooth status is switched on, whatever is necessary
    ///
    /// the result of the attempt to try to find such device, is returned
    fileprivate func retrievePeripherals(_ central: CBCentralManager) -> Bool {
        debug(.deviceManager, "in retrievePeripherals, deviceaddress is \(deviceAddress)")

        if let uuid = UUID(uuidString: deviceAddress) {
            debug(.deviceManager, "    uuid is not nil")

            let peripheralArr = central.retrievePeripherals(withIdentifiers: [uuid])

            if !peripheralArr.isEmpty {
                peripheral = peripheralArr[0]

                if let peripheral = peripheral {
                    debug(.deviceManager, "    trying to connect")

                    peripheral.delegate = self

                    central.connect(peripheral, options: nil)

                    return true

                } else {
                    debug(.deviceManager, "     peripheral is nil")
                }
            } else {
                debug(.deviceManager, "    uuid is not nil, but central.retrievePeripherals returns 0 peripherals")
            }

        } else {
            debug(.deviceManager, "    uuid is nil")
        }

        return false
    }

    // MARK: - methods from protocols CBCentralManagerDelegate, CBPeripheralDelegate

    func centralManager(
        _: CBCentralManager,
        didDiscover peripheral: CBPeripheral,
        advertisementData _: [String: Any],
        rssi _: NSNumber
    ) {
        // devicename needed unwrapped for logging
        var deviceName = "unknown"
        if let temp = peripheral.name {
            deviceName = temp
        }

        debug(.deviceManager, "Did discover peripheral with name: \(deviceName)")

        // check if stored address not nil, in which case we already connected before and we expect a full match with the already known device name
        if peripheral.identifier.uuidString == deviceAddress {
            debug(.deviceManager, "    stored address matches peripheral address, will try to connect")

            stopScanAndconnect(to: peripheral)

        } else {
            debug(.deviceManager, "    stored address does not match peripheral address, ignoring this device")
        }
    }

    func centralManager(_: CBCentralManager, didConnect peripheral: CBPeripheral) {
        debug(.deviceManager, "connected to peripheral with name \(peripheral.name ?? "'unknown'")")

        peripheral.discoverServices(servicesCBUUIDs)
    }

    func centralManager(_: CBCentralManager, didFailToConnect peripheral: CBPeripheral, error: Error?) {
        if let error = error {
            debug(
                .deviceManager,
                "failed to connect, for peripheral with name \(peripheral.name ?? "'unknown'"), with error: \(error.localizedDescription), will try again"
            )

        } else {
            debug(.deviceManager, "failed to connect, for peripheral with name \(peripheral.name ?? "'unknown'"), will try again")
        }

        centralManager!.connect(peripheral, options: nil)
    }

    func centralManagerDidUpdateState(_ central: CBCentralManager) {
        debug(
            .deviceManager,
            "in centralManagerDidUpdateState, for peripheral with name \(peripheral?.name ?? "'unknown'"), new state is \(central.state.rawValue)"
        )

        /// in case status changed to powered on and if device address known then try to retrieveperipherals
        if central.state == .poweredOn {
            /// try to connect to device to which connection was successfully done previously, this attempt is done by callling retrievePeripherals(central)
            _ = retrievePeripherals(central)
        }
    }

    func centralManager(_: CBCentralManager, didDisconnectPeripheral peripheral: CBPeripheral, error: Error?) {
        debug(.deviceManager, "    didDisconnect peripheral with name \(peripheral.name ?? "'unknown'")")

        // call heartbeat, useful for Dexcom transmitters, after a disconnect, then there's probably a new reading available
        heartbeat()

        if let error = error {
            debug(.deviceManager, "    error: \(error.localizedDescription)")
        }

        // if self.peripheral == nil, then a manual disconnect or something like that has occured, no need to reconnect
        // otherwise disconnect occurred because of other (like out of range), so let's try to reconnect
        if let ownPeripheral = self.peripheral {
            debug(.deviceManager, "    Will try to reconnect")

            centralManager!.connect(ownPeripheral, options: nil)

        } else {
            debug(.deviceManager, "    peripheral is nil, will not try to reconnect")
        }
    }

    func peripheral(_ peripheral: CBPeripheral, didDiscoverServices error: Error?) {
        debug(.deviceManager, "didDiscoverServices for peripheral with name \(peripheral.name ?? "'unknown'")")

        if let error = error {
            debug(.deviceManager, "    didDiscoverServices error: \(error.localizedDescription)")
        }

        if let services = peripheral.services {
            for service in services {
                debug(
                    .deviceManager,
                    "    Call discovercharacteristics for service with uuid \(String(describing: service.uuid))"
                )
                peripheral.discoverCharacteristics(nil, for: service)
            }
        } else {
            disconnect()
        }
    }

    func peripheral(_ peripheral: CBPeripheral, didDiscoverCharacteristicsFor service: CBService, error: Error?) {
        debug(
            .deviceManager,
            "didDiscoverCharacteristicsFor for peripheral with name \(peripheral.name ?? "'unknown'"), for service with uuid \(String(describing: service.uuid))"
        )

        if let error = error {
            debug(.deviceManager, "    didDiscoverCharacteristicsFor error: \(error.localizedDescription)")
        }

        if let characteristics = service.characteristics {
            for characteristic in characteristics {
                debug(.deviceManager, "    characteristic: \(String(describing: characteristic.uuid))")

                if characteristic.uuid == CBUUID(string: CBUUID_ReceiveCharacteristic) {
                    debug(.deviceManager, "    found receiveCharacteristic")

                    receiveCharacteristic = characteristic

                    peripheral.setNotifyValue(true, for: characteristic)
                }
            }

        } else {
            debug(.deviceManager, "    Did discover characteristics, but no characteristics listed. There must be some error.")
        }
    }

    func peripheral(_ peripheral: CBPeripheral, didUpdateNotificationStateFor characteristic: CBCharacteristic, error: Error?) {
        if let error = error {
            debug(
                .deviceManager,
                "didUpdateNotificationStateFor for peripheral with name \(peripheral.name ?? "'unkonwn'"), characteristic \(String(describing: characteristic.uuid)), error =  \(error.localizedDescription)"
            )
        }
    }

    func peripheral(_ peripheral: CBPeripheral, didUpdateValueFor _: CBCharacteristic, error _: Error?) {
        debug(.deviceManager, "didUpdateValueFor for peripheral with name \(peripheral.name ?? "'unknown'")")

        // call heartbeat
        heartbeat()
    }

    func centralManager(
        _: CBCentralManager,
        willRestoreState _: [String: Any]
    ) {
        // willRestoreState must be defined, otherwise the app would crash (because the centralManager was created with a CBCentralManagerOptionRestoreIdentifierKey)
        // even if it's an empty function
        // trace is called here because it allows us to see in the issue reports if there was a restart after app crash or removed from memory - in all other cases (force closed by user) this function is not called

        debug(.deviceManager, "in willRestoreState")
    }
}

// MARK: - UserDefaults

extension UserDefaults {
    public enum BTKey: String {
        /// used as local copy of cgmTransmitterDeviceAddress, will be compared regularly against value in shared UserDefaults
        ///
        /// this is the local stored (ie not shared with xDrip4iOS) copy of the cgm (bluetooth) device address
        case cgmTransmitterDeviceAddress = "com.loopkit.Loop.cgmTransmitterDeviceAddress"
    }

    /// used as local copy of cgmTransmitterDeviceAddress, will be compared regularly against value in shared UserDefaults
    var cgmTransmitterDeviceAddress: String? {
        get {
            string(forKey: BTKey.cgmTransmitterDeviceAddress.rawValue)
        }
        set {
            set(newValue, forKey: BTKey.cgmTransmitterDeviceAddress.rawValue)
        }
    }
}