Skip to content

Use state-aware icons for Wear OS shortcut tiles #6618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
kdavh wants to merge 4 commits into
base: main
Choose a base branch
from
+145 −9
Draft

Use state-aware icons for Wear OS shortcut tiles #6618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6add42f
Use state-aware icons for Wear OS shortcut tiles
kdavh Mar 9, 2026
c64c2c1
Add changelog entry for state-aware shortcut tile icons
kdavh Mar 23, 2026
9189b98
Address PR review: fix CancellationException and add isRegistered guard
kdavh Mar 23, 2026
f4582c4
Add state-aware resource versioning and loading indicator for shortcu…
kdavh Apr 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions app/src/main/res/xml/changelog_master.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<change>Bug fixes and dependency updates</change>
</release>
<release version="2026.3.6 - Wear" versioncode="2">
<change>Shortcut tiles now show state-aware icons (e.g., locked vs unlocked padlock)</change>
<change>Bug fixes and dependency updates</change>
</release>
<release version="2026.3.6 - Automotive" versioncode="1">
Expand Down
153 changes: 144 additions & 9 deletions wear/src/main/kotlin/io/homeassistant/companion/android/tiles/ShortcutsTile.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
@file:OptIn(ExperimentalTime::class)

package io.homeassistant.companion.android.tiles

import android.content.Context
Expand Down Expand Up @@ -29,26 +31,37 @@ import androidx.wear.tiles.TileService
import com.google.common.util.concurrent.ListenableFuture
import com.mikepenz.iconics.IconicsColor
import com.mikepenz.iconics.IconicsDrawable
import com.mikepenz.iconics.typeface.library.community.material.CommunityMaterial.Icon3
import com.mikepenz.iconics.utils.backgroundColor
import com.mikepenz.iconics.utils.colorInt
import com.mikepenz.iconics.utils.sizeDp
import dagger.hilt.android.AndroidEntryPoint
import io.homeassistant.companion.android.R
import io.homeassistant.companion.android.common.R as commonR
import io.homeassistant.companion.android.common.data.integration.getIcon
import io.homeassistant.companion.android.common.data.prefs.WearPrefsRepository
import io.homeassistant.companion.android.common.data.servers.ServerManager
import io.homeassistant.companion.android.data.SimplifiedEntity
import io.homeassistant.companion.android.util.getIcon
import java.nio.ByteBuffer
import javax.inject.Inject
import kotlin.coroutines.cancellation.CancellationException
import kotlin.math.min
import kotlin.math.roundToInt
import kotlin.time.Clock
import kotlin.time.Duration.Companion.seconds
import kotlin.time.ExperimentalTime
import kotlin.time.Instant
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.Job
import kotlinx.coroutines.async
import kotlinx.coroutines.delay
import kotlinx.coroutines.guava.future
import kotlinx.coroutines.launch
import kotlinx.coroutines.runBlocking
import kotlinx.coroutines.withContext
import timber.log.Timber

// Dimensions (dp)
private const val CIRCLE_SIZE = 56f
Expand All @@ -57,6 +70,8 @@ private const val ICON_SIZE_SMALL = 40f * 0.7071f // square that fits in 48dp ci
private const val SPACING = 8f
private const val TEXT_SIZE = 8f
private const val TEXT_PADDING = 2f
private val LOADING_TIMEOUT = 5.seconds
private const val LOADING_RESOURCE_SUFFIX = "_loading"

@AndroidEntryPoint
class ShortcutsTile : TileService() {
Expand All @@ -69,6 +84,13 @@ class ShortcutsTile : TileService() {
@Inject
lateinit var wearPrefsRepository: WearPrefsRepository

@Inject
lateinit var clock: Clock

private var pendingEntityId: String? = null
private var pendingOriginalState: String? = null
private var pendingTimestamp: Instant = Instant.DISTANT_PAST

override fun onTileRequest(requestParams: TileRequest): ListenableFuture<Tile> = serviceScope.future {
val state = requestParams.currentState
if (state.lastClickableId.isNotEmpty()) {
Expand All @@ -78,13 +100,74 @@ class ShortcutsTile : TileService() {
intent.setPackage(packageName)
sendBroadcast(intent)
}

// Enter loading state: store original state so we detect when it changes
pendingEntityId = state.lastClickableId
pendingTimestamp = clock.now()
pendingOriginalState = if (serverManager.isRegistered()) {
try {
serverManager.integrationRepository().getEntity(state.lastClickableId)?.state
} catch (e: CancellationException) {
throw e
} catch (e: Exception) {
Timber.w(e, "Failed to fetch original state for ${state.lastClickableId}")
null
}
} else {
null
}

// Schedule polling re-renders to pick up state change
serviceScope.launch {
delay(1.seconds)
requestUpdate(this@ShortcutsTile)
delay(3.seconds)
requestUpdate(this@ShortcutsTile)
}
}

val tileId = requestParams.tileId
val entities = getEntities(tileId)

// Fetch entity states for resource version — ensures cache invalidation on state change
val entityStatesMap = if (serverManager.isRegistered()) {
entities.map { entity ->
async {
try {
val e = serverManager.integrationRepository().getEntity(entity.entityId)
entity.entityId to (e?.state ?: "unknown")
} catch (e: CancellationException) {
throw e
} catch (e: Exception) {
Timber.w(e, "Failed to fetch entity ${entity.entityId} state for tile version")
entity.entityId to "unknown"
}
}
}.map { it.await() }.toMap()
} else {
emptyMap()
}

// Clear loading state if entity state has changed or timeout exceeded
if (pendingEntityId != null) {
val elapsed = clock.now() - pendingTimestamp
val currentState = entityStatesMap[pendingEntityId]
if (elapsed > LOADING_TIMEOUT ||
(pendingOriginalState != null && currentState != null && currentState != pendingOriginalState)
) {
pendingEntityId = null
pendingOriginalState = null
}
}

val entityStatesVersion = entityStatesMap.entries
.sortedBy { it.key }
.joinToString(",") { "${it.key}=${it.value}" }
val loadingSuffix = pendingEntityId?.let { "|loading:$it" }.orEmpty()
val resourcesVersion = "$entities|$entityStatesVersion$loadingSuffix"

Tile.Builder()
.setResourcesVersion(entities.toString())
.setResourcesVersion(resourcesVersion)
.setTileTimeline(
if (serverManager.isRegistered()) {
timeline(tileId)
Expand All @@ -107,16 +190,39 @@ class ShortcutsTile : TileService() {
val iconSizePx = (iconSize * density).roundToInt()
val entities = getEntities(requestParams.tileId)

val entityMap = if (serverManager.isRegistered()) {
val fullEntities = entities.map { entity ->
async {
try {
serverManager.integrationRepository().getEntity(entity.entityId)
} catch (e: CancellationException) {
throw e
} catch (e: Exception) {
Timber.w(e, "Failed to fetch entity ${entity.entityId} for tile")
null
}
}
}.map { it.await() }
fullEntities.filterNotNull().associateBy { it.entityId }
} else {
emptyMap()
}

Resources.Builder()
.setVersion(entities.toString())
.setVersion(requestParams.version)
.apply {
entities.map { entity ->
// Find icon and create Bitmap
val iconIIcon = getIcon(
entity.icon,
entity.domain,
this@ShortcutsTile,
)
// Find icon: try state-aware icon from full entity, fall back to domain icon
val fullEntity = entityMap[entity.entityId]
val iconIIcon = if (fullEntity != null) {
fullEntity.getIcon(this@ShortcutsTile)
} else {
Comment on lines 211 to +219
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resources.Builder().setVersion(entities.toString()) is still based only on the shortcut list, but the actual icon bitmaps now depend on live entity state. This can cause cached resources to keep showing an outdated icon (e.g., locked icon after unlocking) because the resource version may not change. Consider including relevant state in the version (or otherwise forcing a refresh/update strategy) so state changes invalidate cached resources.

Copilot uses AI. Check for mistakes.
getIcon(
entity.icon,
entity.domain,
this@ShortcutsTile,
)
}
val iconBitmap = IconicsDrawable(this@ShortcutsTile, iconIIcon).apply {
colorInt = Color.WHITE
sizeDp = iconSize.roundToInt()
Expand All @@ -142,6 +248,30 @@ class ShortcutsTile : TileService() {
}.forEach { (id, imageResource) ->
addIdToImageMapping(id, imageResource)
}

// Generate loading icon for the pending entity
pendingEntityId?.let { loadingId ->
val loadingBitmap = IconicsDrawable(this@ShortcutsTile, Icon3.cmd_progress_clock).apply {
colorInt = Color.WHITE
sizeDp = iconSize.roundToInt()
backgroundColor = IconicsColor.colorRes(R.color.colorOverlay)
}.toBitmap(iconSizePx, iconSizePx, Bitmap.Config.RGB_565)
val loadingData = ByteBuffer.allocate(loadingBitmap.byteCount).apply {
loadingBitmap.copyPixelsToBuffer(this)
}.array()
addIdToImageMapping(
loadingId + LOADING_RESOURCE_SUFFIX,
ResourceBuilders.ImageResource.Builder()
.setInlineResource(
ResourceBuilders.InlineImageResource.Builder()
.setData(loadingData)
.setWidthPx(iconSizePx)
.setHeightPx(iconSizePx)
.setFormat(ResourceBuilders.IMAGE_FORMAT_RGB_565)
.build(),
).build(),
)
}
}
.build()
}
Expand Down Expand Up @@ -222,6 +352,11 @@ class ShortcutsTile : TileService() {

private fun iconLayout(entity: SimplifiedEntity, showLabels: Boolean): LayoutElement = Box.Builder().apply {
val iconSize = if (showLabels) ICON_SIZE_SMALL else ICON_SIZE_FULL
val resourceId = if (entity.entityId == pendingEntityId) {
entity.entityId + LOADING_RESOURCE_SUFFIX
} else {
entity.entityId
}
setWidth(dp(CIRCLE_SIZE))
setHeight(dp(CIRCLE_SIZE))
setHorizontalAlignment(HORIZONTAL_ALIGN_CENTER)
Expand Down Expand Up @@ -252,7 +387,7 @@ class ShortcutsTile : TileService() {
addContent(
// Add icon
LayoutElementBuilders.Image.Builder()
.setResourceId(entity.entityId)
.setResourceId(resourceId)
.setWidth(dp(iconSize))
.setHeight(dp(iconSize))
.build(),
Expand Down