[BasicUI] Handle the new parameter "staticIcon"

When set on a sitemap element, Basic UI ignores the item state when initially requesting the OH icon and do not request it again when the item state is updated. Depends on openhab/openhab-core#3735 Related to openhab/openhab-android#3404 Signed-off-by: Laurent Garnier <lg.hc@free.fr>
openhab · Jul 31, 2023 · 784ac70 · 784ac70
1 parent edc124e
commit 784ac70
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 7 deletions.
diff --git a/...b.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/AbstractWidgetRenderer.java b/...b.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/AbstractWidgetRenderer.java
@@ -110,7 +110,7 @@ public ItemUIRegistry getItemUIRegistry() {
      * @return HTML code
      */
     protected String preprocessSnippet(String originalSnippet, Widget w) {
-        return preprocessSnippet(originalSnippet, w, false);
+        return preprocessSnippet(originalSnippet, w, w.isStaticIcon());
     }
 
     /**

diff --git a/...rg.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/ChartRenderer.java b/...rg.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/ChartRenderer.java
@@ -123,7 +123,7 @@ public EList<Widget> renderWidget(Widget w, StringBuilder sb, String sitemap) th
             }
 
             String snippet = getSnippet("chart");
-            snippet = preprocessSnippet(snippet, w);
+            snippet = preprocessSnippet(snippet, w, true);
 
             if (chart.getRefresh() > 0) {
                 snippet = snippet.replace("%update_interval%", Integer.toString(chart.getRefresh()));

diff --git a/...rg.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/ImageRenderer.java b/...rg.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/ImageRenderer.java
@@ -69,7 +69,7 @@ public EList<Widget> renderWidget(Widget w, StringBuilder sb, String sitemap) th
 
         String widgetId = itemUIRegistry.getWidgetId(w);
         snippet = snippet.replace("%id%", widgetId);
-        snippet = preprocessSnippet(snippet, w);
+        snippet = preprocessSnippet(snippet, w, true);
 
         boolean validUrl = isValidURL(image.getUrl());
         String proxiedUrl = "../proxy?sitemap=" + sitemap + "&amp;widgetId=" + widgetId;

diff --git a/...rg.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/VideoRenderer.java b/...rg.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/VideoRenderer.java
@@ -66,7 +66,7 @@ public EList<Widget> renderWidget(Widget w, StringBuilder sb, String sitemap) th
                 && videoWidget.getEncoding().toLowerCase().contains("mjpeg")) ? "image" : "video";
 
         snippet = getSnippet(snippetName);
-        snippet = preprocessSnippet(snippet, w);
+        snippet = preprocessSnippet(snippet, w, true);
 
         State state = itemUIRegistry.getState(w);
         String url;

diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/icon_oh.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/icon_oh.html
@@ -1 +1 @@
-<img data-icon="%icon_set%:%icon_name%" src="../icon/%icon_name_in_url%?state=%state_in_url%&iconset=%icon_set_in_url%&format=%icon_type%&anyFormat=true" />
+<img data-icon="%icon_set%:%icon_name%" data-static="false" src="../icon/%icon_name_in_url%?state=%state_in_url%&iconset=%icon_set_in_url%&format=%icon_type%&anyFormat=true" />
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/icon_oh_no_state.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/icon_oh_no_state.html
@@ -1 +1 @@
-<img data-icon="%icon_set%:%icon_name%" src="../icon/%icon_name_in_url%?iconset=%icon_set_in_url%&format=%icon_type%&anyFormat=true" />
+<img data-icon="%icon_set%:%icon_name%" data-static="true" src="../icon/%icon_name_in_url%?iconset=%icon_set_in_url%&format=%icon_type%&anyFormat=true" />
diff --git a/bundles/org.openhab.ui.basic/web-src/smarthome.js b/bundles/org.openhab.ui.basic/web-src/smarthome.js
@@ -375,6 +375,7 @@
 		}
 
 		if (_t.icon !== null) {
+			_t.staticIcon = _t.icon.getAttribute(o.staticAttribute) === "true";
 			splittedIconAttr = _t.icon.getAttribute(o.iconAttribute).split(":");
 			_t.iconSet = splittedIconAttr[0];
 			_t.iconName = splittedIconAttr[1];
@@ -432,7 +433,7 @@
 				src;
 
 			// Some widgets don't have icons
-			if (_t.icon !== null) {
+			if (_t.icon !== null && !_t.staticIcon) {
 				if (state.length < 200) {
 					src = "/icon/" + encodeURIComponent(_t.iconName) +
 						"?state=" + encodeURIComponent(state) +
@@ -2735,6 +2736,7 @@
 	idAttribute: "data-widget-id",
 	iconAttribute: "data-icon",
 	iconTypeAttribute: "data-icon-type",
+	staticAttribute: "data-static",
 	inlineSvgAttribute: "data-inline-svg",
 	primaryColorAttribute: "data-primary-color",
 	secondaryColorAttribute: "data-secondary-color",