Add protobuf (#74)

**Background**

We need protobuf for BLE

**Changes**

- Add protobuf package and set up as java module

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "components/bridge/protobuf/flipperzero-protobuf"]
+	path = components/bridge/protobuf/flipperzero-protobuf
+	url = [email protected]:flipperdevices/flipperzero-protobuf.git

buildSrc/build.gradle.kts

@@ -13,4 +13,5 @@ dependencies {
     implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:1.5.21")
     implementation("com.android.tools.build:gradle:7.0.2")
     implementation("com.squareup.anvil:gradle-plugin:2.3.4")
+    implementation("com.google.protobuf:protobuf-gradle-plugin:0.8.17")
 }

buildSrc/src/main/java/Dependencies.kt

@@ -36,6 +36,8 @@ object Versions {
 
     const val IMAGE_SLIDER = "1.4.0"
     const val GLIDE = "4.12.0"
+
+    const val PROTOBUF = "3.18.1"
 }
 
 object GradlePlugins {
@@ -91,6 +93,9 @@ object Libs {
 
     const val IMAGE_SLIDER = "com.github.smarteist:Android-Image-Slider:${Versions.IMAGE_SLIDER}"
     const val GLIDE = "com.github.bumptech.glide:glide:${Versions.GLIDE}"
+
+    const val PROTOBUF_JAVA = "com.google.protobuf:protobuf-java:${Versions.PROTOBUF}"
+    const val PROTOBUF_PROTOC = "com.google.protobuf:protoc:${Versions.PROTOBUF}"
 }
 
 object TestingLib {

components/bottombar/src/main/java/com/flipper/bottombar/api/BottomNavigationActivityApiImpl.kt

@@ -17,8 +17,8 @@ class BottomNavigationActivityApiImpl @Inject constructor(private val context: C
         context.startActivity(
             Intent(context, BottomNavigationActivity::class.java).apply {
                 flags = FLAG_ACTIVITY_CLEAR_TOP or
-                        FLAG_ACTIVITY_CLEAR_TOP or
-                        FLAG_ACTIVITY_NEW_TASK
+                    FLAG_ACTIVITY_CLEAR_TOP or
+                    FLAG_ACTIVITY_NEW_TASK
             }
         )
     }

components/bridge/api/.gitignore

@@ -0,0 +1 @@
+build

components/bridge/api/build.gradle.kts

@@ -0,0 +1,17 @@
+plugins {
+    id("com.android.library")
+    id("kotlin-android")
+    id("kotlin-parcelize")
+}
+apply<com.flipper.gradle.ConfigurationPlugin>()
+
+dependencies {
+    implementation(project(":components:core"))
+
+    implementation(Libs.KOTLIN_COROUTINES)
+    implementation(Libs.NORDIC_BLE_COMMON)
+    implementation(Libs.NORDIC_BLE_SCAN)
+    implementation(Libs.NORDIC_BLE_KTX)
+
+    implementation(Libs.APPCOMPAT)
+}

components/bridge/api/src/main/AndroidManifest.xml

@@ -0,0 +1,5 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+        package="com.flipper.bridge.api">
+
+    <uses-permission android:name="android.permission.BLUETOOTH" />
+</manifest>

components/bridge/src/main/java/com/flipper/bridge/api/device/FlipperDeviceApi.kt → components/bridge/api/src/main/java/com/flipper/bridge/api/device/FlipperDeviceApi.kt

@@ -1,6 +1,6 @@
 package com.flipper.bridge.api.device
 
-import com.flipper.bridge.impl.manager.FlipperBleManager
+import com.flipper.bridge.api.manager.FlipperBleManager
 
 /**
  * Provide API to Flipper Device

components/bridge/api/src/main/java/com/flipper/bridge/api/di/FlipperBleComponentInterface.kt

@@ -0,0 +1,9 @@
+package com.flipper.bridge.api.di
+
+import com.flipper.bridge.api.pair.FlipperPairApi
+import com.flipper.bridge.api.scanner.FlipperScanner
+
+interface FlipperBleComponentInterface {
+    val flipperScanner: FlipperScanner
+    val flipperPairApi: FlipperPairApi
+}

components/bridge/api/src/main/java/com/flipper/bridge/api/manager/FlipperBleManager.kt

@@ -0,0 +1,16 @@
+package com.flipper.bridge.api.manager
+
+import android.bluetooth.BluetoothDevice
+import com.flipper.bridge.api.model.FlipperGATTInformation
+import kotlinx.coroutines.flow.StateFlow
+import no.nordicsemi.android.ble.ktx.state.ConnectionState
+
+interface FlipperBleManager {
+    val isDeviceConnected: Boolean
+    fun getInformationStateFlow(): StateFlow<FlipperGATTInformation>
+    fun getEchoStateFlow(): StateFlow<ByteArray>
+    fun sendEcho(text: String)
+    fun getConnectionStateFlow(): StateFlow<ConnectionState>
+    fun connectToDevice(device: BluetoothDevice)
+    fun disconnectDevice()
+}

components/bridge/src/main/java/com/flipper/bridge/model/FlipperGATTInformation.kt → components/bridge/api/src/main/java/com/flipper/bridge/api/model/FlipperGATTInformation.kt

@@ -1,4 +1,4 @@
-package com.flipper.bridge.model
+package com.flipper.bridge.api.model
 
 /**
  * Data class which represent information via flipper

components/bridge/src/main/java/com/flipper/bridge/utils/Constants.kt → components/bridge/api/src/main/java/com/flipper/bridge/api/utils/Constants.kt

@@ -1,4 +1,4 @@
-package com.flipper.bridge.utils
+package com.flipper.bridge.api.utils
 
 import java.util.UUID
 import java.util.concurrent.TimeUnit

components/bridge/src/main/java/com/flipper/bridge/utils/DeviceFeatureHelper.kt → components/bridge/api/src/main/java/com/flipper/bridge/api/utils/DeviceFeatureHelper.kt

@@ -1,4 +1,4 @@
-package com.flipper.bridge.utils
+package com.flipper.bridge.api.utils
 
 import android.content.Context
 import android.content.pm.PackageManager

components/bridge/src/main/java/com/flipper/bridge/utils/PermissionHelper.kt → components/bridge/api/src/main/java/com/flipper/bridge/api/utils/PermissionHelper.kt

@@ -1,4 +1,4 @@
-package com.flipper.bridge.utils
+package com.flipper.bridge.api.utils
 
 import android.Manifest
 import android.bluetooth.BluetoothAdapter

components/bridge/build.gradle.kts → components/bridge/impl/build.gradle.kts

@@ -2,22 +2,23 @@ plugins {
     id("com.android.library")
     id("kotlin-android")
     id("kotlin-kapt")
-    id("kotlin-parcelize")
 }
 
 apply<com.flipper.gradle.ConfigurationPlugin>()
 
 dependencies {
     implementation(project(":components:core"))
+    implementation(project(":components:bridge:api"))
+    implementation(project(":components:bridge:protobuf"))
 
-    api(Libs.KOTLIN_COROUTINES)
+    implementation(Libs.KOTLIN_COROUTINES)
     implementation(Libs.ANNOTATIONS)
     implementation(Libs.CORE_KTX)
     implementation(Libs.APPCOMPAT)
 
     implementation(Libs.NORDIC_BLE_SCAN)
-    api(Libs.NORDIC_BLE)
-    api(Libs.NORDIC_BLE_KTX)
+    implementation(Libs.NORDIC_BLE)
+    implementation(Libs.NORDIC_BLE_KTX)
     implementation(Libs.NORDIC_BLE_COMMON)
 
     implementation(Libs.DAGGER)

components/bridge/src/main/java/com/flipper/bridge/di/FlipperBleComponent.kt → components/bridge/impl/src/main/java/com/flipper/bridge/di/FlipperBleComponent.kt

@@ -1,15 +1,9 @@
 package com.flipper.bridge.di
 
-import com.flipper.bridge.api.pair.FlipperPairApi
-import com.flipper.bridge.api.scanner.FlipperScanner
+import com.flipper.bridge.api.di.FlipperBleComponentInterface
 import dagger.Component
 import javax.inject.Singleton
 
-interface FlipperBleComponentInterface {
-    val flipperScanner: FlipperScanner
-    val flipperPairApi: FlipperPairApi
-}
-
 @Singleton
 @Component(modules = [NordicBleModule::class, FlipperBleModule::class, AndroidBleModule::class])
 interface FlipperBleComponent : FlipperBleComponentInterface

components/bridge/impl/src/main/java/com/flipper/bridge/impl/device/FlipperDeviceApiImpl.kt

@@ -0,0 +1,13 @@
+package com.flipper.bridge.impl.device
+
+import com.flipper.bridge.api.device.FlipperDeviceApi
+import com.flipper.bridge.impl.manager.FlipperBleManagerImpl
+
+class FlipperDeviceApiImpl(
+    private val bleManagerImpl: FlipperBleManagerImpl,
+    override val address: String
+) : FlipperDeviceApi {
+    override fun getBleManager(): FlipperBleManagerImpl {
+        return bleManagerImpl
+    }
+}

components/bridge/src/main/java/com/flipper/bridge/impl/manager/FlipperBleManager.kt → components/bridge/impl/src/main/java/com/flipper/bridge/impl/manager/FlipperBleManagerImpl.kt

@@ -1,29 +1,44 @@
 package com.flipper.bridge.impl.manager
 
+import android.bluetooth.BluetoothDevice
 import android.bluetooth.BluetoothGatt
 import android.bluetooth.BluetoothGattCharacteristic
 import android.content.Context
-import com.flipper.bridge.model.FlipperGATTInformation
-import com.flipper.bridge.utils.Constants
+import com.flipper.bridge.api.manager.FlipperBleManager
+import com.flipper.bridge.api.model.FlipperGATTInformation
+import com.flipper.bridge.api.utils.Constants
 import kotlinx.coroutines.DelicateCoroutinesApi
 import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.update
 import kotlinx.coroutines.launch
 import no.nordicsemi.android.ble.BleManager
+import no.nordicsemi.android.ble.ktx.state.ConnectionState
+import no.nordicsemi.android.ble.ktx.stateAsFlow
 import timber.log.Timber
 import java.util.UUID
 
-class FlipperBleManager(context: Context) : BleManager(context) {
+class FlipperBleManagerImpl(context: Context) : BleManager(context), FlipperBleManager {
     private val informationState = MutableStateFlow(FlipperGATTInformation())
     private val echoText = MutableStateFlow(ByteArray(0))
     private val infoCharacteristics = mutableMapOf<UUID, BluetoothGattCharacteristic>()
     private var serialTxCharacteristic: BluetoothGattCharacteristic? = null
     private var serialRxCharacteristic: BluetoothGattCharacteristic? = null
+    override val isDeviceConnected = super.isConnected()
+
+    override fun getInformationStateFlow(): StateFlow<FlipperGATTInformation> = informationState
+    override fun getEchoStateFlow(): StateFlow<ByteArray> = echoText
+    override fun getConnectionStateFlow(): StateFlow<ConnectionState> = stateAsFlow()
+    override fun disconnectDevice() = disconnect().enqueue()
+    override fun connectToDevice(device: BluetoothDevice) {
+        connect(device).retry(
+            Constants.BLE.RECONNECT_COUNT,
+            Constants.BLE.RECONNECT_TIME_MS.toInt()
+        ).useAutoConnect(true)
+            .enqueue()
+    }
 
-    fun getInformationState(): StateFlow<FlipperGATTInformation> = informationState
-    fun getEchoState(): StateFlow<ByteArray> = echoText
     override fun log(priority: Int, message: String) {
         Timber.d(message)
     }
@@ -35,7 +50,7 @@ class FlipperBleManager(context: Context) : BleManager(context) {
     override fun getGattCallback(): BleManagerGattCallback =
         FlipperBleManagerGattCallback()
 
-    fun sendEcho(text: String) {
+    override fun sendEcho(text: String) {
         writeCharacteristic(serialTxCharacteristic, text.toByteArray()).enqueue()
     }
 

components/bridge/src/main/java/com/flipper/bridge/impl/pair/FlipperPairApiImpl.kt → components/bridge/impl/src/main/java/com/flipper/bridge/impl/pair/FlipperPairApiImpl.kt

@@ -6,11 +6,11 @@ import android.content.Context
 import com.flipper.bridge.api.device.FlipperDeviceApi
 import com.flipper.bridge.api.pair.FlipperPairApi
 import com.flipper.bridge.api.scanner.FlipperScanner
+import com.flipper.bridge.api.utils.Constants
+import com.flipper.bridge.api.utils.DeviceFeatureHelper
+import com.flipper.bridge.api.utils.PermissionHelper
 import com.flipper.bridge.impl.device.FlipperDeviceApiImpl
-import com.flipper.bridge.impl.manager.FlipperBleManager
-import com.flipper.bridge.utils.Constants
-import com.flipper.bridge.utils.DeviceFeatureHelper
-import com.flipper.bridge.utils.PermissionHelper
+import com.flipper.bridge.impl.manager.FlipperBleManagerImpl
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.withTimeout
@@ -32,7 +32,7 @@ class FlipperPairApiImpl @Inject constructor(
             return deviceApi
         }
 
-        val manager = FlipperBleManager(context)
+        val manager = FlipperBleManagerImpl(context)
         return FlipperDeviceApiImpl(manager, deviceId)
     }
 
@@ -42,7 +42,7 @@ class FlipperPairApiImpl @Inject constructor(
         flipperDeviceApi: FlipperDeviceApi
     ) {
         // If we already connected to device, just ignore it
-        if (flipperDeviceApi.getBleManager().isConnected) {
+        if (flipperDeviceApi.getBleManager().isDeviceConnected) {
             return
         }
         // If Bluetooth disable, return exception
@@ -61,13 +61,10 @@ class FlipperPairApiImpl @Inject constructor(
     }
 
     override fun scheduleConnect(flipperDeviceApi: FlipperDeviceApi, device: BluetoothDevice) {
-        if (flipperDeviceApi.getBleManager().isConnected) {
+        if (flipperDeviceApi.getBleManager().isDeviceConnected) {
             return
         }
-        flipperDeviceApi.getBleManager().connect(device)
-            .retry(Constants.BLE.RECONNECT_COUNT, Constants.BLE.RECONNECT_TIME_MS.toInt())
-            .useAutoConnect(true)
-            .enqueue()
+        flipperDeviceApi.getBleManager().connectToDevice(device)
     }
 
     private fun connectWithBondedDevice(flipperDeviceApi: FlipperDeviceApi) {

components/bridge/src/main/java/com/flipper/bridge/impl/scanner/FlipperScannerImpl.kt → components/bridge/impl/src/main/java/com/flipper/bridge/impl/scanner/FlipperScannerImpl.kt

@@ -2,7 +2,7 @@ package com.flipper.bridge.impl.scanner
 
 import com.flipper.bridge.api.scanner.DiscoveredBluetoothDevice
 import com.flipper.bridge.api.scanner.FlipperScanner
-import com.flipper.bridge.utils.Constants
+import com.flipper.bridge.api.utils.Constants
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.filter

components/bridge/protobuf/build.gradle.kts

@@ -0,0 +1,41 @@
+import com.google.protobuf.gradle.generateProtoTasks
+import com.google.protobuf.gradle.id
+import com.google.protobuf.gradle.proto
+import com.google.protobuf.gradle.protobuf
+import com.google.protobuf.gradle.protoc
+
+plugins {
+    id("com.android.library")
+    id("kotlin-android")
+    id("com.google.protobuf")
+}
+apply<com.flipper.gradle.ConfigurationPlugin>()
+
+dependencies {
+    implementation(project(":components:core"))
+    api(Libs.PROTOBUF_JAVA)
+}
+
+protobuf {
+    protoc {
+        artifact = Libs.PROTOBUF_PROTOC
+    }
+
+    generateProtoTasks {
+        all().forEach {
+            it.builtins {
+                id("java") {
+                    option("lite")
+                }
+            }
+        }
+    }
+}
+
+android {
+    sourceSets {
+        (getByName("main") as com.android.build.gradle.api.AndroidSourceSet).proto {
+            srcDir("$projectDir/flipperzero-protobuf")
+        }
+    }
+}

components/bridge/protobuf/src/main/AndroidManifest.xml

@@ -0,0 +1 @@
+<manifest package="com.flipper.bridge.protobuf" />

components/bridge/provider/.gitignore

@@ -0,0 +1 @@
+build

components/bridge/provider/build.gradle.kts

@@ -0,0 +1,10 @@
+plugins {
+    id("com.android.library")
+    id("kotlin-android")
+}
+apply<com.flipper.gradle.ConfigurationPlugin>()
+
+dependencies {
+    api(project(":components:bridge:api"))
+    implementation(project(":components:bridge:impl"))
+}

components/bridge/provider/src/main/AndroidManifest.xml

@@ -0,0 +1 @@
+<manifest package="com.flipper.bridge.provider" />

components/bridge/provider/src/main/java/com/flipper/bridge/provider/FlipperApi.kt

@@ -0,0 +1,8 @@
+package com.flipper.bridge.provider
+
+import com.flipper.bridge.api.di.FlipperBleComponentInterface
+
+/**
+ * Entry point for Flipper Api
+ */
+object FlipperApi : FlipperBleComponentInterface by FlipperBleComponentProvider.component