Add option to make tap on entity state complication toggle the corres…

…ponding device.

Currently, tapping a complication only refreshes the entity state. This PR adds a "forward tap to device" option to the complication configuration page. When this option is enabled, tapping on the complication triggers a call to the #onPressed method of the corresponding device entity, which in turns executes a RPC to the corresponding service. This lets users quickly toggle home assistant devices with a single click on their watch face.

common/src/main/java/io/homeassistant/companion/android/database/AppDatabase.kt

@@ -97,7 +97,7 @@ import io.homeassistant.companion.android.common.R as commonR
         Server::class,
         Setting::class
     ],
-    version = 45,
+    version = 46,
     autoMigrations = [
         AutoMigration(from = 24, to = 25),
         AutoMigration(from = 25, to = 26),
@@ -118,7 +118,8 @@ import io.homeassistant.companion.android.common.R as commonR
         AutoMigration(from = 41, to = 42),
         AutoMigration(from = 42, to = 43),
         AutoMigration(from = 43, to = 44),
-        AutoMigration(from = 44, to = 45)
+        AutoMigration(from = 44, to = 45),
+        AutoMigration(from = 45, to = 46)
     ]
 )
 @TypeConverters(
@@ -193,7 +194,8 @@ abstract class AppDatabase : RoomDatabase() {
                     MIGRATION_21_22,
                     MIGRATION_22_23,
                     MIGRATION_23_24,
-                    Migration40to41(context.assets)
+                    Migration40to41(context.assets),
+                    MIGRATION_45_46
                 )
                 .fallbackToDestructiveMigration()
                 .build()
@@ -906,6 +908,12 @@ abstract class AppDatabase : RoomDatabase() {
             }
         }
 
+        private val MIGRATION_45_46 = object : Migration(45, 46) {
+            override fun migrate(database: SupportSQLiteDatabase) {
+                database.execSQL("ALTER TABLE `entity_state_complications` ADD `forward_taps` INTEGER NOT NULL DEFAULT 0")
+            }
+        }
+
         private fun createNotificationChannel() {
             if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
                 val notificationManager = appContext.getSystemService<NotificationManager>()!!

common/src/main/java/io/homeassistant/companion/android/database/wear/EntityStateComplications.kt

@@ -17,5 +17,7 @@ data class EntityStateComplications(
     @ColumnInfo(name = "show_title", defaultValue = "1")
     val showTitle: Boolean,
     @ColumnInfo(name = "show_unit", defaultValue = "0")
-    val showUnit: Boolean
+    val showUnit: Boolean,
+    @ColumnInfo(name = "forward_taps", defaultValue = "0")
+    val forwardTaps: Boolean
 )

common/src/main/res/values/strings.xml

@@ -795,6 +795,7 @@
     <string name="show_share_logs">Show and share logs</string>
     <string name="show_entity_title">Show entity name</string>
     <string name="show_unit_title">Show entity unit</string>
+    <string name="forward_taps_title">Forward taps to entity</string>
     <string name="sign_in_on_phone">Sign in on phone</string>
     <string name="slider_decreased">%1$s decreased</string>
     <string name="slider_increased">%1$s increased</string>

wear/src/main/java/io/homeassistant/companion/android/complications/ComplicationConfigViewModel.kt

@@ -60,7 +60,8 @@ class ComplicationConfigViewModel @Inject constructor(
         private set
     var entityShowUnit by mutableStateOf(true)
         private set
-
+    var entityForwardTaps by mutableStateOf(true)
+        private set
     init {
         loadEntities()
     }
@@ -74,6 +75,7 @@ class ComplicationConfigViewModel @Inject constructor(
                 selectedEntity = SimplifiedEntity(entityId = it.entityId)
                 entityShowTitle = it.showTitle
                 entityShowUnit = it.showUnit
+                entityForwardTaps = it.forwardTaps
                 if (loadingState == LoadingState.READY) {
                     updateSelectedEntity()
                 }
@@ -160,9 +162,13 @@ class ComplicationConfigViewModel @Inject constructor(
         entityShowUnit = show
     }
 
+    fun setForwardTaps(show: Boolean) {
+        entityForwardTaps = show
+    }
+
     fun addEntityStateComplication(id: Int, entity: SimplifiedEntity) {
         viewModelScope.launch {
-            entityStateComplicationsDao.add(EntityStateComplications(id, entity.entityId, entityShowTitle, entityShowUnit))
+            entityStateComplicationsDao.add(EntityStateComplications(id, entity.entityId, entityShowTitle, entityShowUnit, entityForwardTaps))
         }
     }
 

wear/src/main/java/io/homeassistant/companion/android/complications/ComplicationReceiver.kt

@@ -5,9 +5,11 @@ import android.content.BroadcastReceiver
 import android.content.ComponentName
 import android.content.Context
 import android.content.Intent
+import android.util.Log
 import androidx.wear.watchface.complications.datasource.ComplicationDataSourceService.Companion.EXTRA_CONFIG_COMPLICATION_ID
 import androidx.wear.watchface.complications.datasource.ComplicationDataSourceUpdateRequester
 import dagger.hilt.android.AndroidEntryPoint
+import io.homeassistant.companion.android.common.data.integration.onPressed
 import io.homeassistant.companion.android.common.data.servers.ServerManager
 import io.homeassistant.companion.android.conversation.ConversationActivity
 import kotlinx.coroutines.CoroutineScope
@@ -28,23 +30,44 @@ class ComplicationReceiver : BroadcastReceiver() {
 
         try {
             when (intent.action) {
-                UPDATE_COMPLICATION -> updateComplication(context, intent.getIntExtra(EXTRA_ID, -1))
+                TOGGLE_COMPLICATION -> toggleComplication(
+                    context,
+                    intent.getIntExtra(EXTRA_COMPLICATION_ID, -1),
+                    intent.getStringExtra(EXTRA_ENTITY_ID)
+                )
                 Intent.ACTION_SCREEN_ON -> onScreenOn(context)
             }
         } finally {
             result.finish()
         }
     }
 
-    private fun updateComplication(context: Context, id: Int) {
+    private fun toggleComplication(context: Context, complicationId: Int, entityId: String?) {
         scope.launch {
+            // Forward tap to entity if entityId is specified.
+            if (entityId != null) {
+                val entity = try {
+                    serverManager.integrationRepository().getEntity(entityId)
+                        ?: return@launch
+                } catch (t: Throwable) {
+                    Log.e(
+                        EntityStateDataSourceService.TAG,
+                        "Unable to get entity for $entityId: ${t.message}"
+                    )
+                    return@launch
+                }
+
+                // Press!
+                entity.onPressed(serverManager.integrationRepository())
+            }
+
             // Request an update for the complication that has just been toggled.
             ComplicationDataSourceUpdateRequester
                 .create(
                     context = context,
                     complicationDataSourceComponent = ComponentName(context, EntityStateDataSourceService::class.java)
                 )
-                .requestUpdate(id)
+                .requestUpdate(complicationId)
         }
     }
 
@@ -67,20 +90,23 @@ class ComplicationReceiver : BroadcastReceiver() {
     companion object {
         private const val TAG = "ComplicationReceiver"
 
-        const val UPDATE_COMPLICATION = "update_complication"
-        private const val EXTRA_ID = "complication_instance_id"
+        const val TOGGLE_COMPLICATION = "toggle_complication"
+        private const val EXTRA_COMPLICATION_ID = "complication_instance_id"
+        private const val EXTRA_ENTITY_ID = "entity_id"
 
         /**
          * Returns a pending intent, suitable for use as a tap intent, that causes a complication to be
          * toggled and updated.
          */
         fun getComplicationToggleIntent(
             context: Context,
-            complicationInstanceId: Int
+            complicationInstanceId: Int,
+            entityId: String?
         ): PendingIntent {
             val intent = Intent(context, ComplicationReceiver::class.java).apply {
-                action = UPDATE_COMPLICATION
-                putExtra(EXTRA_ID, complicationInstanceId)
+                action = TOGGLE_COMPLICATION
+                putExtra(EXTRA_COMPLICATION_ID, complicationInstanceId)
+                putExtra(EXTRA_ENTITY_ID, entityId)
             }
 
             // Pass complicationId as the requestCode to ensure that different complications get

wear/src/main/java/io/homeassistant/companion/android/complications/EntityStateDataSourceService.kt

@@ -89,7 +89,11 @@ class EntityStateDataSourceService : SuspendingComplicationDataSourceService() {
 
         val contentDescription = PlainComplicationText.Builder(getText(R.string.complication_entity_state_content_description)).build()
         val monochromaticImage = MonochromaticImage.Builder(Icon.createWithBitmap(iconBitmap)).build()
-        val tapAction = ComplicationReceiver.getComplicationToggleIntent(this, request.complicationInstanceId)
+        val tapAction = ComplicationReceiver.getComplicationToggleIntent(
+            this,
+            request.complicationInstanceId,
+            if (settings.forwardTaps) entity.entityId else null
+        )
 
         return when (request.complicationType) {
             ComplicationType.SHORT_TEXT -> {

wear/src/main/java/io/homeassistant/companion/android/complications/views/ComplicationConfigMainView.kt

@@ -57,12 +57,14 @@ fun LoadConfigView(
                     entity = complicationConfigViewModel.selectedEntity,
                     showTitle = complicationConfigViewModel.entityShowTitle,
                     showUnit = complicationConfigViewModel.entityShowUnit,
+                    forwardTaps = complicationConfigViewModel.entityForwardTaps,
                     loadingState = complicationConfigViewModel.loadingState,
                     onChooseEntityClicked = {
                         swipeDismissableNavController.navigate(SCREEN_CHOOSE_ENTITY)
                     },
                     onShowTitleClicked = complicationConfigViewModel::setShowTitle,
                     onShowUnitClicked = complicationConfigViewModel::setShowUnit,
+                    onForwardTapsClicked = complicationConfigViewModel::setForwardTaps,
                     onAcceptClicked = onAcceptClicked
                 )
             }
@@ -88,10 +90,12 @@ fun MainConfigView(
     entity: SimplifiedEntity?,
     showTitle: Boolean,
     showUnit: Boolean,
+    forwardTaps: Boolean,
     loadingState: ComplicationConfigViewModel.LoadingState,
     onChooseEntityClicked: () -> Unit,
     onShowTitleClicked: (Boolean) -> Unit,
     onShowUnitClicked: (Boolean) -> Unit,
+    onForwardTapsClicked: (Boolean) -> Unit,
     onAcceptClicked: () -> Unit
 ) {
     ThemeLazyColumn {
@@ -153,7 +157,18 @@ fun MainConfigView(
                     colors = getToggleButtonColors()
                 )
             }
-
+            item {
+                val isChecked = if (loaded) forwardTaps else false
+                ToggleButton(
+                    checked = isChecked,
+                    onCheckedChange = onForwardTapsClicked,
+                    label = { Text(stringResource(R.string.forward_taps_title)) },
+                    selectionControl = { ToggleSwitch(isChecked) },
+                    modifier = Modifier.fillMaxWidth(),
+                    enabled = loaded && entity != null,
+                    colors = getToggleButtonColors()
+                )
+            }
             item {
                 FilledIconButton(
                     modifier = Modifier.padding(top = 8.dp).touchTargetAwareSize(IconButtonDefaults.SmallButtonSize),
@@ -182,10 +197,12 @@ fun PreviewMainConfigView() {
         entity = simplifiedEntity,
         showTitle = true,
         showUnit = false,
+        forwardTaps = false,
         loadingState = ComplicationConfigViewModel.LoadingState.READY,
         onChooseEntityClicked = {},
         onShowTitleClicked = {},
         onShowUnitClicked = {},
+        onForwardTapsClicked = {},
         onAcceptClicked = {}
     )
 }