Semantic Tags: Update system channel tags to match latest schema (openhab#4706)

* update tags to match xsd
* use tag name constants
* overload withTags()

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

Author: andrewfg

bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/DefaultSystemChannelTypeProvider.java

@@ -24,6 +24,8 @@
 import org.eclipse.jdt.annotation.Nullable;
 import org.openhab.core.i18n.LocalizedKey;
 import org.openhab.core.library.CoreItemFactory;
+import org.openhab.core.semantics.model.DefaultSemanticTags.Point;
+import org.openhab.core.semantics.model.DefaultSemanticTags.Property;
 import org.openhab.core.thing.i18n.ChannelTypeI18nLocalizationService;
 import org.openhab.core.thing.type.ChannelType;
 import org.openhab.core.thing.type.ChannelTypeBuilder;
@@ -50,6 +52,7 @@
  * @author Christoph Weitkamp - Added support for translation
  * @author Stefan Triller - Added more system channels
  * @author Christoph Weitkamp - factored out common i18n aspects into ThingTypeI18nLocalizationService
+ * @author Andrew Fiddian-Green - Added system Point and Property tags
  */
 @NonNullByDefault
 @Component
@@ -121,7 +124,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
                             new StateOption("2", "average"), new StateOption("3", "good"),
                             new StateOption("4", "excellent")))
                     .build())
-            .withTags(List.of("Measurement", "Level")).build();
+            .withTags(Point.MEASUREMENT, Property.SIGNAL_STRENGTH).build();
 
     /**
      * Low battery default system wide {@link ChannelType}. Represents a low battery warning with possible values
@@ -132,7 +135,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withDescription("Low battery warning with possible values on (low battery) and off (battery ok)")
             .withCategory("LowBattery")
             .withStateDescriptionFragment(StateDescriptionFragmentBuilder.create().withReadOnly(true).build())
-            .withTags(List.of("LowBattery", "Energy")).build();
+            .withTags(Point.ALARM, Property.LOW_BATTERY).build();
 
     /**
      * Battery level default system wide {@link ChannelType}. Represents the battery level as a percentage.
@@ -143,7 +146,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withStateDescriptionFragment(StateDescriptionFragmentBuilder.create().withMinimum(BigDecimal.ZERO)
                     .withMaximum(new BigDecimal(100)).withStep(BigDecimal.ONE).withReadOnly(true).withPattern("%.0f %%")
                     .build())
-            .withTags(List.of("Measurement", "Energy")).build();
+            .withTags(Point.MEASUREMENT, Property.ENERGY).build();
 
     /**
      * System wide trigger {@link ChannelType} without event options.
@@ -188,7 +191,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
     public static final ChannelType SYSTEM_POWER = ChannelTypeBuilder
             .state(SYSTEM_CHANNEL_TYPE_UID_POWER, "Power", CoreItemFactory.SWITCH)
             .withDescription("Device is operable when channel has state ON").withCategory("Switch")
-            .withTags(List.of("Switch", "Power")).build();
+            .withTags(Point.SWITCH, Property.POWER).build();
 
     /**
      * Location: default system wide {@link ChannelType} which displays a location
@@ -198,7 +201,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withDescription("Location in lat./lon./height coordinates")
             .withStateDescriptionFragment(StateDescriptionFragmentBuilder.create().withReadOnly(true)
                     .withPattern("%2$s°N %3$s°E %1$sm").build())
-            .withTag("Measurement").build();
+            .withTags(Point.MEASUREMENT, Property.GEO_LOCATION).build();
 
     /**
      * Motion: default system wide {@link ChannelType} which indications whether motion was detected (state ON)
@@ -207,7 +210,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .state(SYSTEM_CHANNEL_TYPE_UID_MOTION, "Motion", CoreItemFactory.SWITCH)
             .withDescription("Motion detected by the device").withCategory("Motion")
             .withStateDescriptionFragment(StateDescriptionFragmentBuilder.create().withReadOnly(true).build())
-            .withTags(List.of("Status", "Presence")).build();
+            .withTags(Point.STATUS, Property.PRESENCE).build();
 
     /**
      * Brightness: default system wide {@link ChannelType} which allows changing the brightness from 0-100%
@@ -217,15 +220,15 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withDescription("Controls the brightness and switches the light on and off").withCategory("Light")
             .withStateDescriptionFragment(StateDescriptionFragmentBuilder.create().withMinimum(BigDecimal.ZERO)
                     .withMaximum(new BigDecimal(100)).withPattern("%d %%").build())
-            .withTags(List.of("Control", "Light")).build();
+            .withTags(Point.CONTROL, Property.BRIGHTNESS).build();
 
     /**
      * Color: default system wide {@link ChannelType} which allows changing the color
      */
     public static final ChannelType SYSTEM_COLOR = ChannelTypeBuilder
             .state(SYSTEM_CHANNEL_TYPE_UID_COLOR, "Color", CoreItemFactory.COLOR)
             .withDescription("Controls the color of the light").withCategory("ColorLight")
-            .withTags(List.of("Control", "Light")).build();
+            .withTags(Point.CONTROL, Property.COLOR).build();
 
     /**
      * Color-temperature: default system wide {@link ChannelType} which allows changing the color temperature in percent
@@ -236,7 +239,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withCategory("ColorLight")
             .withStateDescriptionFragment(StateDescriptionFragmentBuilder.create().withMinimum(BigDecimal.ZERO)
                     .withMaximum(new BigDecimal(100)).withPattern("%.0f").build())
-            .withTags(List.of("Control", "ColorTemperature")).build();
+            .withTags(Point.CONTROL, Property.COLOR_TEMPERATURE).build();
 
     /**
      * Color-temperature: default system wide {@link ChannelType} which allows changing the color temperature in Kelvin
@@ -247,7 +250,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withCategory("ColorLight").isAdvanced(true)
             .withStateDescriptionFragment(StateDescriptionFragmentBuilder.create().withMinimum(new BigDecimal(1000))
                     .withMaximum(new BigDecimal(10000)).withPattern("%.0f K").build())
-            .withTags(List.of("Control", "ColorTemperature")).build();
+            .withTags(Point.CONTROL, Property.COLOR_TEMPERATURE).build();
 
     // media channels
 
@@ -259,22 +262,22 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withDescription("Change the sound volume of a device")
             .withStateDescriptionFragment(StateDescriptionFragmentBuilder.create().withMinimum(BigDecimal.ZERO)
                     .withMaximum(new BigDecimal(100)).withPattern("%d %%").build())
-            .withCategory("SoundVolume").withTags(List.of("Control", "SoundVolume")).build();
+            .withCategory("SoundVolume").withTags(Point.CONTROL, Property.SOUND_VOLUME).build();
 
     /**
      * Mute: default system wide {@link ChannelType} which allows muting and un-muting audio
      */
     public static final ChannelType SYSTEM_MUTE = ChannelTypeBuilder
             .state(SYSTEM_CHANNEL_TYPE_UID_MUTE, "Mute", CoreItemFactory.SWITCH)
             .withDescription("Mute audio of the device").withCategory("SoundVolume_Mute")
-            .withTags(List.of("Switch", "SoundVolume")).build();
+            .withTags(Point.SWITCH, Property.SOUND_VOLUME).build();
 
     /**
      * Media-control: system wide {@link ChannelType} which controls a media player
      */
     public static final ChannelType SYSTEM_MEDIA_CONTROL = ChannelTypeBuilder
             .state(SYSTEM_CHANNEL_TYPE_UID_MEDIA_CONTROL, "Media Control", CoreItemFactory.PLAYER)
-            .withCategory("MediaControl").withTag("Control").build();
+            .withCategory("MediaControl").withTags(Point.CONTROL, Property.MEDIA_CONTROL).build();
 
     /**
      * Media-title: default system wide {@link ChannelType} which displays the title of a (played) song
@@ -283,7 +286,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .state(SYSTEM_CHANNEL_TYPE_UID_MEDIA_TITLE, "Media Title", CoreItemFactory.STRING)
             .withDescription("Title of a (played) media file")
             .withStateDescriptionFragment(StateDescriptionFragmentBuilder.create().withReadOnly(true).build())
-            .withTag("Status").build();
+            .withTags(Point.STATUS).build();
 
     /**
      * Media-artist: default system wide {@link ChannelType} which displays the artist of a (played) song
@@ -292,7 +295,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .state(SYSTEM_CHANNEL_TYPE_UID_MEDIA_ARTIST, "Media Artist", CoreItemFactory.STRING)
             .withDescription("Artist of a (played) media file")
             .withStateDescriptionFragment(StateDescriptionFragmentBuilder.create().withReadOnly(true).build())
-            .withTag("Status").build();
+            .withTags(Point.STATUS).build();
 
     // weather channels
 
@@ -304,7 +307,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withDescription("Current wind direction expressed as an angle").withCategory("Wind")
             .withStateDescriptionFragment(StateDescriptionFragmentBuilder.create().withMinimum(BigDecimal.ZERO)
                     .withMaximum(new BigDecimal(360)).withReadOnly(true).withPattern("%.0f %unit%").build())
-            .withTags(List.of("Measurement", "Wind")).build();
+            .withTags(Point.MEASUREMENT, Property.WIND).build();
 
     /**
      * Wind-speed: system wide {@link ChannelType} which shows the wind speed
@@ -314,7 +317,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withDescription("Current wind speed").withCategory("Wind")
             .withStateDescriptionFragment(
                     StateDescriptionFragmentBuilder.create().withReadOnly(true).withPattern("%.1f %unit%").build())
-            .withTags(List.of("Measurement", "Wind")).build();
+            .withTags(Point.MEASUREMENT, Property.WIND).build();
 
     /**
      * Outdoor-temperature: system wide {@link ChannelType} which shows the outdoor temperature
@@ -324,7 +327,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withDescription("Current outdoor temperature").withCategory("Temperature")
             .withStateDescriptionFragment(
                     StateDescriptionFragmentBuilder.create().withReadOnly(true).withPattern("%.1f %unit%").build())
-            .withTags(List.of("Measurement", "Temperature")).build();
+            .withTags(Point.MEASUREMENT, Property.TEMPERATURE).build();
 
     /**
      * Indoor-temperature: system wide {@link ChannelType} which shows the indoor temperature
@@ -334,7 +337,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withDescription("Current indoor temperature").withCategory("Temperature")
             .withStateDescriptionFragment(
                     StateDescriptionFragmentBuilder.create().withReadOnly(true).withPattern("%.1f %unit%").build())
-            .withTags(List.of("Measurement", "Temperature")).build();
+            .withTags(Point.MEASUREMENT, Property.TEMPERATURE).build();
 
     /**
      * Atmospheric-humidity: system wide {@link ChannelType} which shows the atmospheric humidity
@@ -344,7 +347,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withUnitHint("%").withDescription("Current atmospheric relative humidity").withCategory("Humidity")
             .withStateDescriptionFragment(
                     StateDescriptionFragmentBuilder.create().withReadOnly(true).withPattern("%.0f %%").build())
-            .withTags(List.of("Measurement", "Humidity")).build();
+            .withTags(Point.MEASUREMENT, Property.HUMIDITY).build();
 
     /**
      * Barometric-pressure: system wide {@link ChannelType} which shows the barometric pressure
@@ -354,7 +357,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withDescription("Current barometric pressure").withCategory("Pressure")
             .withStateDescriptionFragment(
                     StateDescriptionFragmentBuilder.create().withReadOnly(true).withPattern("%.3f %unit%").build())
-            .withTags(List.of("Measurement", "Pressure")).build();
+            .withTags(Point.MEASUREMENT, Property.PRESSURE).build();
 
     // Energy
 
@@ -366,7 +369,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withDescription("Current electric power").withCategory("Energy")
             .withStateDescriptionFragment(
                     StateDescriptionFragmentBuilder.create().withReadOnly(true).withPattern("%.1f %unit%").build())
-            .withTags(List.of("Measurement", "Power")).build();
+            .withTags(Point.MEASUREMENT, Property.POWER).build();
 
     /**
      * Electric-current: system wide {@link ChannelType} which shows the electric current
@@ -376,7 +379,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withDescription("Current electric current").withCategory("Energy")
             .withStateDescriptionFragment(
                     StateDescriptionFragmentBuilder.create().withReadOnly(true).withPattern("%.1f %unit%").build())
-            .withTags(List.of("Measurement", "Current")).build();
+            .withTags(Point.MEASUREMENT, Property.CURRENT).build();
 
     /**
      * Electric-voltage: system wide {@link ChannelType} which shows the electric voltage
@@ -386,7 +389,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withDescription("Current electric voltage").withCategory("Energy")
             .withStateDescriptionFragment(
                     StateDescriptionFragmentBuilder.create().withReadOnly(true).withPattern("%.1f %unit%").build())
-            .withTags(List.of("Measurement", "Voltage")).build();
+            .withTags(Point.MEASUREMENT, Property.VOLTAGE).build();
 
     /**
      * Electrical-energy: system wide {@link ChannelType} which shows the electrical energy
@@ -396,7 +399,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .withDescription("Current electric energy").withCategory("Energy")
             .withStateDescriptionFragment(
                     StateDescriptionFragmentBuilder.create().withReadOnly(true).withPattern("%.1f %unit%").build())
-            .withTags(List.of("Measurement", "Energy")).build();
+            .withTags(Point.MEASUREMENT, Property.ENERGY).build();
 
     /**
      * UV Index: system wide {@link ChannelType} which shows the UV Index
@@ -405,7 +408,7 @@ public class DefaultSystemChannelTypeProvider implements ChannelTypeProvider {
             .state(SYSTEM_CHANNEL_TYPE_UID_UV_INDEX, "UV Index", CoreItemFactory.NUMBER)
             .withDescription("Current UV index").withStateDescriptionFragment(StateDescriptionFragmentBuilder.create()
                     .withReadOnly(true).withPattern("%d").withMinimum(BigDecimal.ONE).build())
-            .withTags(List.of("Measurement", "Ultraviolet")).build();
+            .withTags(Point.MEASUREMENT, Property.ULTRAVIOLET).build();
 
     private static final Collection<ChannelType> CHANNEL_TYPES = List.of(SYSTEM_CHANNEL_SIGNAL_STRENGTH,
             SYSTEM_CHANNEL_LOW_BATTERY, SYSTEM_CHANNEL_BATTERY_LEVEL, SYSTEM_TRIGGER, SYSTEM_RAWBUTTON, SYSTEM_BUTTON,

bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/type/AbstractChannelTypeBuilder.java

@@ -16,10 +16,12 @@
 import java.util.Collection;
 import java.util.HashSet;
 import java.util.Set;
+import java.util.stream.Stream;
 
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jdt.annotation.Nullable;
+import org.openhab.core.semantics.SemanticTag;
 import org.openhab.core.thing.type.ChannelType;
 import org.openhab.core.thing.type.ChannelTypeBuilder;
 import org.openhab.core.thing.type.ChannelTypeUID;
@@ -80,6 +82,12 @@ public T withTags(Collection<String> tags) {
         return (T) this;
     }
 
+    @Override
+    public T withTags(SemanticTag... tags) {
+        this.tags.addAll(Stream.of(tags).map(t -> t.getName()).toList());
+        return (T) this;
+    }
+
     @Override
     public T withConfigDescriptionURI(URI configDescriptionURI) {
         this.configDescriptionURI = configDescriptionURI;

bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/type/ChannelTypeBuilder.java

@@ -17,6 +17,7 @@
 
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.openhab.core.semantics.SemanticTag;
 import org.openhab.core.thing.internal.type.StateChannelTypeBuilderImpl;
 import org.openhab.core.thing.internal.type.TriggerChannelTypeBuilderImpl;
 
@@ -60,13 +61,21 @@ public interface ChannelTypeBuilder<@NonNull T extends ChannelTypeBuilder<T>> {
     T withTag(String tag);
 
     /**
-     * Sets the StateDescription for the ChannelType
+     * Sets the Tags for the ChannelType
      *
      * @param tags Collection of tags to be added to the ChannelType
      * @return this Builder
      */
     T withTags(Collection<String> tags);
 
+    /**
+     * Sets the Tags for the ChannelType
+     *
+     * @param tags Collection of tags to be added to the ChannelType
+     * @return this Builder
+     */
+    T withTags(SemanticTag... tags);
+
     /**
      * Sets the ConfigDescriptionURI for the ChannelType
      *