Skip to content
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

Improve state generation logic when fetching icons #3456

Merged
merged 4 commits into from
Aug 31, 2023
Merged

Improve state generation logic when fetching icons #3456

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
a3979dd
Add support for 'staticIcon' widget parameter
maniac103 Aug 14, 2023
e973eb2
Use number format pattern for formatting state for icon URL
maniac103 Aug 14, 2023
9dfa34f
Simplify icon state selection logic
maniac103 Aug 14, 2023
84026b7
Send NULL state as 'null' when requesting icons
maniac103 Aug 31, 2023
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
49 changes: 25 additions & 24 deletions mobile/src/main/java/org/openhab/habdroid/model/IconResource.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,42 +128,43 @@ internal fun String?.toOH2WidgetIconResource(
state: ParsedState?,
item: Item?,
type: Widget.Type,
hasMappings: Boolean
hasMappings: Boolean,
useState: Boolean
): IconResource? {
if (isNullOrEmpty() || this == "none") {
return null
}

val itemState = item?.state
var iconState = state?.asString.orEmpty()
if (itemState != null) {
if (item.isOfTypeOrGroupType(Item.Type.Color)) {
// For items that control a color item fetch the correct icon
if (type == Widget.Type.Slider || type == Widget.Type.Switch && !hasMappings) {
try {
iconState = itemState.asBrightness.toString()
if (type == Widget.Type.Switch) {
iconState = if (iconState == "0") "OFF" else "ON"
}
} catch (e: Exception) {
iconState = "OFF"
}
} else if (itemState.asHsv != null) {
val color = itemState.asHsv.toColor()
iconState = String.format(
Locale.US, "#%02x%02x%02x",
Color.red(color), Color.green(color), Color.blue(color)
)
val stateToUse = state ?: item?.state
val iconState = when {
!useState || item == null -> null
// For NULL states, we send 'null' as state when fetching the icon (BasicUI set a predecent for doing so)
stateToUse == null -> "null"
// Number items need to use state formatted as per their state description
item.isOfTypeOrGroupType(Item.Type.Number) || item.isOfTypeOrGroupType(Item.Type.NumberWithDimension)-> {
stateToUse.asNumber.toString()
}
item.isOfTypeOrGroupType(Item.Type.Color) -> when {
// Color sliders just use the brightness part of the color
type == Widget.Type.Slider -> stateToUse.asBrightness.toString()
// Color toggles should behave similarly to the logic below (but using the brightness value)
type == Widget.Type.Switch && !hasMappings -> if (stateToUse.asBrightness == 0) "OFF" else "ON"
stateToUse.asHsv != null -> {
val color = stateToUse.asHsv.toColor()
String.format(Locale.US, "#%02x%02x%02x", Color.red(color), Color.green(color), Color.blue(color))
}
} else if (type == Widget.Type.Switch && !hasMappings && !item.isOfTypeOrGroupType(Item.Type.Rollershutter)) {
else -> stateToUse.asString
}
type == Widget.Type.Switch && !hasMappings && !item.isOfTypeOrGroupType(Item.Type.Rollershutter) -> {
// For switch items without mappings (just ON and OFF) that control a dimmer item
// and which are not ON or OFF already, set the state to "OFF" instead of 0
// or to "ON" to fetch the correct icon
iconState = if (itemState.asString == "0" || itemState.asString == "OFF") "OFF" else "ON"
if (stateToUse.asString == "0" || stateToUse.asString == "OFF") "OFF" else "ON"
}
else -> stateToUse.asString
}

return IconResource(this, true, iconState)
return IconResource(this, true, iconState.orEmpty())
}

enum class IconFormat {
Expand Down
7 changes: 5 additions & 2 deletions mobile/src/main/java/org/openhab/habdroid/model/Widget.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,9 @@ data class Widget(
val item = Item.updateFromEvent(source.item, eventPayload.optJSONObject("item"))
val state = determineWidgetState(eventPayload.optStringOrNull("state"), item)
val iconName = eventPayload.optStringOrFallback("icon", source.icon?.icon)
val icon = iconName.toOH2WidgetIconResource(state, item, source.type, source.mappings.isNotEmpty())
val staticIcon = source.icon?.customState?.isEmpty() == true
val hasMappings = source.mappings.isNotEmpty()
val icon = iconName.toOH2WidgetIconResource(state, item, source.type, hasMappings, !staticIcon)
return Widget(
id = source.id,
parentId = source.parentId,
Expand Down Expand Up @@ -338,12 +340,13 @@ fun JSONObject.collectWidgets(parent: Widget?): List<Widget> {
val type = getString("type").toWidgetType()
val icon = optStringOrNull("icon")
val state = Widget.determineWidgetState(optStringOrNull("state"), item)
val staticIcon = optBoolean("staticIcon", false)

val widget = Widget(
id = getString("widgetId"),
parentId = parent?.id,
rawLabel = optString("label", ""),
icon = icon.toOH2WidgetIconResource(state, item, type, mappings.isNotEmpty()),
icon = icon.toOH2WidgetIconResource(state, item, type, mappings.isNotEmpty(), !staticIcon),
state = state,
type = type,
url = optStringOrNull("url"),
Expand Down