Call, Contact, Image items: Don't create command descr from state des…

…cr (#4097) * Contact item: Fix command descriptions provided even though commands are not accepted If a state description is set on a contact item, currently a command description is automatically created as well. This is wrong as contact items do not accept commands (except refresh) and caused the UI to display a control for the default (list) widget for these contacts. * Also fix Call and Image items & Allow explicitly setting command description Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
openhab · Mar 3, 2024 · f4d6089 · f4d6089
1 parent bca1010
commit f4d6089
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 5 deletions.
diff --git a/bundles/org.openhab.core/src/main/java/org/openhab/core/items/GenericItem.java b/bundles/org.openhab.core/src/main/java/org/openhab/core/items/GenericItem.java
@@ -468,11 +468,9 @@ public void setCategory(@Nullable String category) {
 
     @Override
     public @Nullable CommandDescription getCommandDescription(@Nullable Locale locale) {
-        if (commandDescriptionService != null) {
-            CommandDescription commandDescription = commandDescriptionService.getCommandDescription(this.name, locale);
-            if (commandDescription != null) {
-                return commandDescription;
-            }
+        CommandDescription commandOptions = getCommandOptions(locale);
+        if (commandOptions != null) {
+            return commandOptions;
         }
 
         StateDescription stateDescription = getStateDescription(locale);
@@ -504,6 +502,17 @@ protected void logSetTypeError(TimeSeries timeSeries) {
                 getName(), getClass().getSimpleName());
     }
 
+    protected @Nullable CommandDescription getCommandOptions(@Nullable Locale locale) {
+        if (commandDescriptionService != null) {
+            CommandDescription commandDescription = commandDescriptionService.getCommandDescription(this.name, locale);
+            if (commandDescription != null) {
+                return commandDescription;
+            }
+        }
+
+        return null;
+    }
+
     private CommandDescription stateOptions2CommandOptions(StateDescription stateDescription) {
         CommandDescriptionBuilder builder = CommandDescriptionBuilder.create();
         stateDescription.getOptions()

diff --git a/bundles/org.openhab.core/src/main/java/org/openhab/core/library/items/CallItem.java b/bundles/org.openhab.core/src/main/java/org/openhab/core/library/items/CallItem.java
@@ -13,12 +13,15 @@
 package org.openhab.core.library.items;
 
 import java.util.List;
+import java.util.Locale;
 
 import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
 import org.openhab.core.items.GenericItem;
 import org.openhab.core.library.CoreItemFactory;
 import org.openhab.core.library.types.StringListType;
 import org.openhab.core.types.Command;
+import org.openhab.core.types.CommandDescription;
 import org.openhab.core.types.RefreshType;
 import org.openhab.core.types.State;
 import org.openhab.core.types.TimeSeries;
@@ -68,4 +71,9 @@ public void setTimeSeries(TimeSeries timeSeries) {
             logSetTypeError(timeSeries);
         }
     }
+
+    @Override
+    public @Nullable CommandDescription getCommandDescription(@Nullable Locale locale) {
+        return getCommandOptions(locale);
+    }
 }
diff --git a/bundles/org.openhab.core/src/main/java/org/openhab/core/library/items/ContactItem.java b/bundles/org.openhab.core/src/main/java/org/openhab/core/library/items/ContactItem.java
@@ -13,12 +13,15 @@
 package org.openhab.core.library.items;
 
 import java.util.List;
+import java.util.Locale;
 
 import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
 import org.openhab.core.items.GenericItem;
 import org.openhab.core.library.CoreItemFactory;
 import org.openhab.core.library.types.OpenClosedType;
 import org.openhab.core.types.Command;
+import org.openhab.core.types.CommandDescription;
 import org.openhab.core.types.RefreshType;
 import org.openhab.core.types.State;
 import org.openhab.core.types.TimeSeries;
@@ -68,4 +71,9 @@ public void setTimeSeries(TimeSeries timeSeries) {
             logSetTypeError(timeSeries);
         }
     }
+
+    @Override
+    public @Nullable CommandDescription getCommandDescription(@Nullable Locale locale) {
+        return getCommandOptions(locale);
+    }
 }
diff --git a/bundles/org.openhab.core/src/main/java/org/openhab/core/library/items/ImageItem.java b/bundles/org.openhab.core/src/main/java/org/openhab/core/library/items/ImageItem.java
@@ -13,12 +13,15 @@
 package org.openhab.core.library.items;
 
 import java.util.List;
+import java.util.Locale;
 
 import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
 import org.openhab.core.items.GenericItem;
 import org.openhab.core.library.CoreItemFactory;
 import org.openhab.core.library.types.RawType;
 import org.openhab.core.types.Command;
+import org.openhab.core.types.CommandDescription;
 import org.openhab.core.types.RefreshType;
 import org.openhab.core.types.State;
 import org.openhab.core.types.TimeSeries;
@@ -66,4 +69,9 @@ public void setTimeSeries(TimeSeries timeSeries) {
             logSetTypeError(timeSeries);
         }
     }
+
+    @Override
+    public @Nullable CommandDescription getCommandDescription(@Nullable Locale locale) {
+        return getCommandOptions(locale);
+    }
 }